summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorThibault Saunier <tsaunier@igalia.com>2020-05-30 15:54:31 -0400
committerThibault Saunier <tsaunier@igalia.com>2020-05-31 17:17:22 -0400
commit124153fe065e3af3697b69435a66e93eb702d3d6 (patch)
treefa4aa37dfd92d2dee4412e596d0dbd8735d9a75f /docs
parent6a305b1e236409315021ef7a0aa4c80784fcc5b1 (diff)
validateflow: Allow specifying checksum type
And add an extra mode 'checksum-as-id' which basically numerate buffers checksums as they are being received so that it is simpler to compare expectations when you are tracking buffers from both sinkpads and srcpads. Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-devtools/-/merge_requests/202>
Diffstat (limited to 'docs')
-rw-r--r--docs/plugins/validateflow.md13
1 files changed, 11 insertions, 2 deletions
diff --git a/docs/plugins/validateflow.md b/docs/plugins/validateflow.md
index daf8a23..4d51af2 100644
--- a/docs/plugins/validateflow.md
+++ b/docs/plugins/validateflow.md
@@ -126,8 +126,17 @@ several overrides and listening to different pads with different settings.
* `pad`: Required. Name of the pad that will be monitored.
* `record-buffers`: Default: false. Whether buffers will be logged. By default
only events are logged.
- * `buffers-checksum`: Default: false. Whether a checkum of the buffer data is
- logged. Implies `record-buffers`.
+ * `buffers-checksum`: Default: 'none'. Define the type of checksums to be used
+ valid values are:
+ - none: No checksum recorded
+ - as-id: Record checksum as 'ids' IDs are incremented on each new checksum
+ passed in
+ - md5: md5 checksum
+ - sha1: sha1 checksum
+ - sha256: sha256 checksum
+ - sha512: sha512 checksum
+ Note that for backward compatibility reasons, this can be passed as a boolean
+ and it will default to 'sha1' if true, 'none' if false.
* `ignored-fields`: Default: `"stream-start={ stream-id }"` (as they are often
non reproducible). Key with a serialized GstValueList(str) of fields to not
record.