<para>
-This environment variable can be set to a colon-separated list of paths.
+This environment variable can be set to a colon-separated list of paths (or
+semicolon-separated list on Windows).
If this variable is not set, GStreamer will fill in this list for you
with
<itemizedlist>
directory according to the xdg base dir specification. Usually this will be
a directory called
<filename>plugins</filename> inside the
-<filename>.local/share/.gstreamer-&GST_API_VERSION;</filename> directory in
+<filename>.local/share/gstreamer-&GST_API_VERSION;</filename> directory in
the user's home directory by default, though this search path may change if
the XDG_DATA_HOME environment variable is set.
</para>
<title><envar>GST_PLUGIN_PATH</envar>, <envar>GST_PLUGIN_PATH_1_0</envar></title>
<para>
-This environment variable can be set to a colon-separated list of paths.
+This environment variable can be set to a colon-separated list of paths (or a
+semicolon-separated list on Windows).
GStreamer will scan these paths for GStreamer plug-ins. These plug-ins will
be loaded in addition to, and before, the plug-ins in the system paths.
</para>
<para>
Set this environment variable to any value ("1" typically) to switch off
colouring in GST_DEBUG output. This has the same effect as specifying the
-<option>--gst-debug-no-color</option> command line option to well-behaved
-GStreamer applications (ie. those that pass command-line options correctly to
-GStreamer).
+<option>--gst-debug-no-color</option> or
+<option>--gst-debug-color-mode</option>=off command line option to
+well-behaved GStreamer applications (ie. those that pass command-line
+options correctly to GStreamer).
This is particularly useful to reduce the size of debug output and also allows
for the output to be compressed much better than with colours turned on.
</para>
+ <para>
+Has the same effect as setting GST_DEBUG_COLOR_MODE environment variable to
+"off".
+ </para>
+
+</formalpara>
+
+<formalpara id="GST_DEBUG_COLOR_MODE">
+ <title><envar>GST_DEBUG_COLOR_MODE</envar></title>
+
+ <para>
+Set this environment variable to change log colouring in GST_DEBUG output.
+Possible values:
+ <variablelist>
+
+ <varlistentry>
+ <term><option>on</option></term>
+ <listitem>
+ <para>
+Enables debug log output coloring. Uses default coloring method for current
+platform. This is the default.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>off</option></term>
+ <listitem>
+ <para>
+Disables debug log output coloring. This has the same effect as specifying the
+<option>--gst-debug-color-mode</option>=off command line option to
+well-behaved GStreamer applications (ie. those that pass command-line
+options correctly to GStreamer).
+This is particularly useful to reduce the size of debug output and also allows
+for the output to be compressed much better than with colours turned on.
+ </para>
+ <para>
+Has the same effect as setting GST_DEBUG_NO_COLOR environment variable to
+any value.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>auto</option></term>
+ <listitem>
+ <para>
+Same as <option>on</option>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>disable</option></term>
+ <listitem>
+ <para>
+Same as <option>off</option>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>unix</option></term>
+ <listitem>
+ <para>
+Enables debug log output coloring and forces the use of UNIX termial codes
+for coloring, even if this method is not normally used on current platform.
+This has the same effect as specifying the
+<option>--gst-debug-color-mode</option>=unix command line option to
+well-behaved GStreamer applications (ie. those that pass command-line options
+correctly to GStreamer).
+This is particularly useful to dump debug output into a file on non-UNIX
+platforms to be sent to developers who have viewers that support UNIX terminal
+codes.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+ </para>
</formalpara>
gst-launch-&GST_API_VERSION; is one such application.
</para>
<para>
+When gst-launch-&GST_API_VERSION; changes state through NULL to PLAYING
+and back to NULL, a dot file is generated on each state change. To have
+gst-launch-&GST_API_VERSION; write a snapshot of the pipeline state, send
+a SIGHUP to the gst-launch-&GST_API_VERSION; process.
+ </para>
+ <para>
These .dot files can then be turned into images using the 'dot' utility
from the graphviz set of tools, like this:
<command>dot foo.dot -Tsvg -o foo.svg</command> or
<command>dot foo.dot -Tpng -o foo.png</command> or
<command>dot foo.dot -Tjpg -o foo.jpg</command>.
</para>
+ <para>
+There is also a utility called <command>xdot</command> which allows you to
+view the dot file directly without converting it first.
+ </para>
+
</formalpara>
</formalpara>
+<formalpara id="GST_TAG_ENCODING">
+ <title><envar>GST_TAG_ENCODING</envar></title>
+ <para>
+Try this character encoding first for tag-related strings where the encoding
+is not defined and which are not UTF-8 already. By default the current locale
+will be tried (if not UTF-8).
+ </para>
+</formalpara>
+
+<formalpara id="GST_TAG_ID3_ENCODING">
+ <title><envar>GST_TAG_ID3_ENCODING</envar></title>
+ <para>
+Try this character encoding first for ID3 tag-related strings where the
+encoding is not defined and which are not UTF-8 already. By default the current
+locale will be tried (if not UTF-8).
+ </para>
+</formalpara>
+
+<formalpara id="GST_TAG_ID3V1_ENCODING">
+ <title><envar>GST_TAG_ID3V1_ENCODING</envar></title>
+ <para>
+Try this character encoding first for ID3v1 tag-related strings where the
+encoding does not look like UTF-8.
+ </para>
+</formalpara>
+
+<formalpara id="GST_GL_WINDOW">
+ <title><envar>GST_GL_WINDOW</envar></title>
+ <para>
+Influences the window system to use by the GStreamer OpenGL library.
+Common values are 'x11', 'wayland', 'win32' or 'cocoa'.
+ </para>
+</formalpara>
+
+<formalpara id="GST_GL_PLATFORM">
+ <title><envar>GST_GL_PLATFORM</envar></title>
+ <para>
+Influences the OpenGL platform to use by the GStreamer OpenGL library.
+Common values are 'egl', 'glx', 'wgl' or 'cgl'.
+ </para>
+</formalpara>
+
+<formalpara id="GST_GL_API">
+ <title><envar>GST_GL_API</envar></title>
+ <para>
+Influences the OpenGL API requested by the OpenGL platform.
+Common values are 'opengl' or 'gles2'.
+ </para>
+</formalpara>
+
</refsect2>
</refsect1>
projects / platform / upstream / gstreamer.git / blobdiff