mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-20 23:36:38 +00:00
Code Issues 1 Projects Releases Wiki Activity

validate: Document the GST_VALIDATE_CONFIG environment variable

Browse source
This commit is contained in:
Thibault Saunier 2015-07-13 13:10:15 +02:00
parent 5e2451da62
commit b02e422519
1 changed files with 32 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
validate/docs/validate/envvariables.xml
View file

@ -57,7 +57,7 @@
<title><envar>GST_VALIDATE_FILE</envar></title>
<para>
Set this variable to a to a colon-separated list of paths to redirect all
Set this variable to a colon-separated list of paths to redirect all
GstValidate messages to this file. If left unset, debug messages will be
outputed into the standard error.
</para>
@ -71,7 +71,7 @@
<title><envar>GST_VALIDATE_SCENARIOS_PATH</envar></title>
<para>
Set this variable to a to a colon-separated list of paths. GstValidate will
Set this variable to a colon-separated list of paths. GstValidate will
scan these paths for GstValidate scenario files.
By default GstValidate will look for scenarios in the user data directory as
@ -81,6 +81,36 @@
</para>
</formalpara>
<formalpara id="GST-VALIDATE-CONFIG">
<title><envar>GST_VALIDATE_CONFIG</envar></title>
<para>
Set this variable to a colon-separated list of paths to GstValidate config files.
The config file has a format similar to the scenario file. The name of the configuration
corresponds to the name of the plugin the configuration applies to.
</para>
<para>
The special name "core" is used to configure GstValidate core functionnalities
(monitors, scenarios, etc...).
</para>
<informalexample>
For example if you want to make sure to set a property on a element of a type
(for example to disable QoS on all sinks) you can do:
<programlisting>
core, action=set-property, target-element-klass=Sink
</programlisting>
</informalexample>
<para>
For more examples you can look at the ssim GstValidate plugin documentation to
see how to configure that plugin.
</para>
</formalpara>
<formalpara id="GST-VALIDATE-OVERRIDE">
<title><envar>GST_VALIDATE_OVERRIDE</envar></title>