625 lines
25 KiB
HTML
625 lines
25 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of GStreamer</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>GStreamer</H1>
|
|
Section: User Commands (1)<BR>Updated: May 2007<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
gst-launch-1.0 - build and run a GStreamer pipeline
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<B>gst-launch-1.0</B> <I>[OPTION...]</I> PIPELINE-DESCRIPTION
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
<P>
|
|
|
|
<I>gst-launch-1.0</I> is a tool that builds and runs basic
|
|
<I>GStreamer</I> pipelines.
|
|
<P>
|
|
In simple form, a PIPELINE-DESCRIPTION is a list of
|
|
elements separated by exclamation marks (!). Properties may be appended to
|
|
elements, in the form <I>property=value</I>.
|
|
<P>
|
|
For a complete description of possible PIPELINE-DESCRIPTIONS see the section
|
|
<I>pipeline description</I> below or consult the GStreamer documentation.
|
|
<P>
|
|
Please note that <I>gst-launch-1.0</I> is primarily a debugging tool for
|
|
developers and users. You should not build applications on top of it. For
|
|
applications, use the gst_parse_launch() function of the GStreamer API as an
|
|
easy way to construct pipelines from pipeline descriptions.
|
|
<A NAME="lbAE"> </A>
|
|
<H2>OPTIONS</H2>
|
|
|
|
|
|
<I>gst-launch-1.0</I> accepts the following options:
|
|
<DL COMPACT>
|
|
<DT id="1"><B>--help</B>
|
|
|
|
<DD>
|
|
Print help synopsis and available FLAGS
|
|
<DT id="2"><B>-v, --verbose</B>
|
|
|
|
<DD>
|
|
Output status information and property notifications
|
|
<DT id="3"><B>-q, --quiet</B>
|
|
|
|
<DD>
|
|
Do not print any progress information
|
|
<DT id="4"><B>-m, --messages</B>
|
|
|
|
<DD>
|
|
Output messages posted on the pipeline's bus
|
|
<DT id="5"><B>-t, --tags</B>
|
|
|
|
<DD>
|
|
Output tags (also known as metadata)
|
|
<DT id="6"><B>-e, --eos-on-shutdown</B>
|
|
|
|
<DD>
|
|
Force an EOS event on sources before shutting the pipeline down. This is
|
|
useful to make sure muxers create readable files when a muxing pipeline is
|
|
shut down forcefully via Control-C.
|
|
<DT id="7"><B>-i, --index</B>
|
|
|
|
<DD>
|
|
Gather and print index statistics. This is mostly useful for playback or
|
|
recording pipelines.
|
|
<DT id="8"><B>-f, --no-fault</B>
|
|
|
|
<DD>
|
|
Do not install a fault handler
|
|
<DT id="9"><B>-T, --trace</B>
|
|
|
|
<DD>
|
|
Print memory allocation traces. The feature must be enabled at compile time to
|
|
work.
|
|
<DT id="10"><DD>
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>GSTREAMER OPTIONS</H2>
|
|
|
|
|
|
<I>gst-launch-1.0</I> also accepts the following options that are common
|
|
to all GStreamer applications:
|
|
<DL COMPACT>
|
|
<DT id="11"><B>--gst-version</B>
|
|
|
|
<DD>
|
|
Prints the version string of the <I>GStreamer</I> core library.
|
|
<DT id="12"><B>--gst-fatal-warnings</B>
|
|
|
|
<DD>
|
|
Causes <I>GStreamer</I> to abort if a warning message occurs. This is equivalent
|
|
to setting the environment variable G_DEBUG to 'fatal_warnings' (see the
|
|
section <I>environment variables</I> below for further information).
|
|
<DT id="13"><B>--gst-debug=STRING</B>
|
|
|
|
<DD>
|
|
A comma separated list of category_name:level pairs to specify debugging levels
|
|
for each category. Level is in the range 0-9 where 0 will show no messages, and
|
|
9 will show all messages. The wildcard * can be used to match category names.
|
|
Note that the order of categories and levels is important, wildcards at the
|
|
end may override levels set earlier. The log levels are: 1=ERROR, 2=WARNING,
|
|
3=FIXME, 4=INFO, 5=DEBUG, 6=LOG, 7=TRACE, 9=MEMDUMP. Since GStreamer 1.2 one
|
|
can also use the debug level names, e.g. --gst-debug=*sink:LOG. A full
|
|
description of the various debug levels can be found in the GStreamer core
|
|
library API documentation, in the "Running GStreamer Applications" section.
|
|
<P>
|
|
Use --gst-debug-help to show category names
|
|
<P>
|
|
Example:
|
|
GST_CAT:5,GST_ELEMENT_*:3,oggdemux:5
|
|
<P>
|
|
<DT id="14"><B>--gst-debug-level=LEVEL</B>
|
|
|
|
<DD>
|
|
Sets the threshold for printing debugging messages. A higher level
|
|
will print more messages. The useful range is 0-9, with the default
|
|
being 0. Level 6 (LOG level) will show all information that is usually
|
|
required for debugging purposes. Higher levels are only useful in very
|
|
specific cases. See above for the full list of levels.
|
|
<DT id="15"><B>--gst-debug-no-color</B>
|
|
|
|
<DD>
|
|
<I>GStreamer</I> normally prints debugging messages so that the
|
|
messages are color-coded when printed to a terminal that handles
|
|
ANSI escape sequences. Using this option causes <I>GStreamer</I>
|
|
to print messages without color. Setting the <B>GST_DEBUG_NO_COLOR</B>
|
|
environment variable will achieve the same thing.
|
|
<DT id="16"><B>--gst-debug-color-mode</B>
|
|
|
|
<DD>
|
|
<I>GStreamer</I> normally prints debugging messages so that the
|
|
messages are color-coded when printed to a terminal that handles
|
|
ANSI escape sequences (on *nix), or uses W32 console API to color the
|
|
messages printed into a console (on W32). Using this option causes
|
|
<I>GStreamer</I> to print messages without color ('off' or 'disable'),
|
|
print messages with default colors ('on' or 'auto'), or print messages
|
|
using ANSI escape sequences for coloring ('unix'). Setting the
|
|
<B>GST_DEBUG_COLOR_MODE</B> environment variable will achieve the same thing.
|
|
<DT id="17"><B>--gst-debug-disable</B>
|
|
|
|
<DD>
|
|
Disables debugging.
|
|
<DT id="18"><B>--gst-debug-help</B>
|
|
|
|
<DD>
|
|
Prints a list of available debug categories and their default debugging level.
|
|
<DT id="19"><B>--gst-plugin-spew</B>
|
|
|
|
<DD>
|
|
<I>GStreamer</I> info flags to set
|
|
Enable printout of errors while loading <I>GStreamer</I> plugins
|
|
<DT id="20"><B>--gst-plugin-path=PATH</B>
|
|
|
|
<DD>
|
|
Add directories separated with ':' to the plugin search path
|
|
<DT id="21"><B>--gst-plugin-load=PLUGINS</B>
|
|
|
|
<DD>
|
|
Preload plugins specified in a comma-separated list. Another way to specify
|
|
plugins to preload is to use the environment variable GST_PLUGIN_PATH
|
|
<P>
|
|
</DL>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>PIPELINE DESCRIPTION</H2>
|
|
|
|
<P>
|
|
A pipeline consists <I>elements</I> and <I>links</I>. <I>Elements</I> can be put
|
|
into <I>bins</I> of different sorts. <I>Elements</I>, <I>links</I> and <I>bins</I>
|
|
can be specified in a pipeline description in any order.
|
|
<P>
|
|
<B>Elements</B>
|
|
|
|
<P>
|
|
ELEMENTTYPE <I>[PROPERTY1 ...]</I>
|
|
<P>
|
|
Creates an element of type ELEMENTTYPE and sets the PROPERTIES.
|
|
<P>
|
|
<B>Properties</B>
|
|
|
|
<P>
|
|
PROPERTY=VALUE ...
|
|
<P>
|
|
Sets the property to the specified value. You can use <B><A HREF="/cgi-bin/man/man2html?1+gst-inspect-1.0">gst-inspect-1.0</A></B>(1) to
|
|
find out about properties and allowed values of different elements.
|
|
<BR>
|
|
|
|
Enumeration properties can be set by name, nick or value.
|
|
<P>
|
|
<B>Bins</B>
|
|
|
|
<P>
|
|
<I>[BINTYPE.]</I> ( <I>[PROPERTY1 ...]</I> PIPELINE-DESCRIPTION )
|
|
<BR>
|
|
|
|
<P>
|
|
Specifies that a bin of type BINTYPE is created and the given properties are
|
|
set. Every element between the braces is put into the bin. Please note the dot
|
|
that has to be used after the BINTYPE. You will almost never need this
|
|
functionality, it is only really useful for applications using the
|
|
gst_launch_parse() API with 'bin' as bintype. That way it is possible to build
|
|
partial pipelines instead of a full-fledged top-level pipeline.
|
|
<P>
|
|
<B>Links</B>
|
|
|
|
<P>
|
|
<I>[[SRCELEMENT].[PAD1,...]]</I> ! <I>[[SINKELEMENT].[PAD1,...]]</I>
|
|
<I>[[SRCELEMENT].[PAD1,...]]</I> ! CAPS ! <I>[[SINKELEMENT].[PAD1,...]]</I>
|
|
<I>[[SRCELEMENT].[PAD1,...]]</I> : <I>[[SINKELEMENT].[PAD1,...]]</I>
|
|
<I>[[SRCELEMENT].[PAD1,...]]</I> : CAPS : <I>[[SINKELEMENT].[PAD1,...]]</I>
|
|
<P>
|
|
Links the element with name SRCELEMENT to the element with name SINKELEMENT,
|
|
using the caps specified in CAPS as a filter.
|
|
Names can be set on elements with the name property. If the name is omitted, the
|
|
element that was specified directly in front of or after the link is used. This
|
|
works across bins. If a padname is given, the link is done with these pads. If
|
|
no pad names are given all possibilities are tried and a matching pad is used.
|
|
If multiple padnames are given, both sides must have the same number of pads
|
|
specified and multiple links are done in the given order.
|
|
<BR>
|
|
|
|
So the simplest link is a simple exclamation mark, that links the element to
|
|
the left of it to the element right of it.
|
|
<BR>
|
|
|
|
Linking using the : operator attempts to link all possible pads between
|
|
the elements
|
|
<BR>
|
|
|
|
<P>
|
|
<B>Caps</B>
|
|
|
|
<P>
|
|
MEDIATYPE <I>[, PROPERTY[, PROPERTY ...]]]</I> <I>[; CAPS[; CAPS ...]]</I>
|
|
<P>
|
|
Creates a capability with the given media type and optionally with given
|
|
properties. The media type can be escaped using " or '.
|
|
If you want to chain caps, you can add more caps in the same format afterwards.
|
|
<P>
|
|
<B>Properties</B>
|
|
|
|
<P>
|
|
NAME=<I>[(TYPE)]</I>VALUE
|
|
<BR>
|
|
|
|
in lists and ranges: <I>[(TYPE)]</I>VALUE
|
|
<P>
|
|
Sets the requested property in capabilities. The name is an alphanumeric value
|
|
and the type can have the following case-insensitive values:
|
|
<BR>
|
|
|
|
- <B>i</B> or <B>int</B> for integer values or ranges
|
|
<BR>
|
|
|
|
- <B>f</B> or <B>float</B> for float values or ranges
|
|
<BR>
|
|
|
|
- <B>b</B>, <B>bool</B> or <B>boolean</B> for boolean values
|
|
<BR>
|
|
|
|
- <B>s</B>, <B>str</B> or <B>string</B> for strings
|
|
<BR>
|
|
|
|
- <B>fraction</B> for fractions (framerate, pixel-aspect-ratio)
|
|
<BR>
|
|
|
|
- <B>l</B> or <B>list</B> for lists
|
|
<BR>
|
|
|
|
If no type was given, the following order is tried: integer, float, boolean,
|
|
string.
|
|
<BR>
|
|
|
|
Integer values must be parsable by <B>strtol()</B>, floats by <B>strtod()</B>. FOURCC values may
|
|
either be integers or strings. Boolean values are (case insensitive) <I>yes</I>,
|
|
<I>no</I>, <I>true</I> or <I>false</I> and may like strings be escaped with " or '.
|
|
<BR>
|
|
|
|
Ranges are in this format: [ VALUE, VALUE ]
|
|
<BR>
|
|
|
|
Lists use this format: { VALUE <I>[, VALUE ...]</I> }
|
|
<P>
|
|
<A NAME="lbAH"> </A>
|
|
<H2>PIPELINE EXAMPLES</H2>
|
|
|
|
<P>
|
|
The examples below assume that you have the correct plug-ins available.
|
|
In general, "pulsesink" can be substituted with another audio output
|
|
plug-in such as "alsasink" or "osxaudiosink"
|
|
Likewise, "xvimagesink" can be substituted with "ximagesink", "glimagesink",
|
|
or "osxvideosink". Keep in mind though that different sinks might
|
|
accept different formats and even the same sink might accept different formats
|
|
on different machines, so you might need to add converter elements like
|
|
audioconvert and audioresample (for audio) or videoconvert (for video)
|
|
in front of the sink to make things work.
|
|
<P>
|
|
<B>Audio playback</B>
|
|
|
|
<P>
|
|
Play the mp3 music file "music.mp3" using a libmpg123-based plug-in and
|
|
output to an Pulseaudio device
|
|
<BR>
|
|
|
|
<B><BR> gst-launch-1.0 filesrc location=music.mp3 ! mpegaudioparse ! mpg123audiodec ! audioconvert ! audioresample ! pulsesink</B>
|
|
|
|
<P>
|
|
Play an Ogg Vorbis format file
|
|
<BR>
|
|
|
|
<B><BR> gst-launch-1.0 filesrc location=music.ogg ! oggdemux ! vorbisdec ! audioconvert ! audioresample ! pulsesink</B>
|
|
|
|
<P>
|
|
Play an mp3 file or an http stream using GIO
|
|
<BR>
|
|
|
|
<B><BR> gst-launch-1.0 giosrc location=music.mp3 ! mpegaudioparse ! mpg123audiodec ! audioconvert ! pulsesink</B>
|
|
|
|
<BR>
|
|
|
|
<B><BR> gst-launch-1.0 giosrc location=<A HREF="http://domain.com/music.mp3">http://domain.com/music.mp3</A> ! mpegaudioparse ! mpg123audiodec ! audioconvert ! audioresample ! pulsesink</B>
|
|
|
|
<P>
|
|
Use GIO to play an mp3 file located on an SMB server
|
|
<BR>
|
|
|
|
<B><BR> gst-launch-1.0 giosrc location=<A HREF="smb://computer/music.mp3">smb://computer/music.mp3</A> ! mpegaudioparse ! mpg123audiodec ! audioconvert ! audioresample ! pulsesink</B>
|
|
|
|
<P>
|
|
<B>Format conversion</B>
|
|
|
|
<P>
|
|
Convert an mp3 music file to an Ogg Vorbis file
|
|
<BR>
|
|
|
|
<B><BR> gst-launch-1.0 filesrc location=music.mp3 ! mpegaudioparse ! mpg123audiodec ! audioconvert ! vorbisenc ! oggmux ! filesink location=music.ogg</B>
|
|
|
|
<P>
|
|
Convert to the FLAC format
|
|
<BR>
|
|
|
|
<B><BR> gst-launch-1.0 filesrc location=music.mp3 ! mpegaudioparse ! mpg123audiodec ! audioconvert ! flacenc ! filesink location=test.flac</B>
|
|
|
|
<P>
|
|
<B>Other</B>
|
|
|
|
<P>
|
|
Plays a .WAV file that contains raw audio data (PCM).
|
|
<BR>
|
|
|
|
<B><BR> gst-launch-1.0 filesrc location=music.wav ! wavparse ! audioconvert ! audioresample ! pulsesink</B>
|
|
|
|
<P>
|
|
Convert a .WAV file containing raw audio data into an Ogg Vorbis or mp3 file
|
|
<BR>
|
|
|
|
<B><BR> gst-launch-1.0 filesrc location=music.wav ! wavparse ! audioconvert ! vorbisenc ! oggmux ! filesink location=music.ogg</B>
|
|
|
|
<BR>
|
|
|
|
<B><BR> gst-launch-1.0 filesrc location=music.wav ! wavparse ! audioconvert ! lamemp3enc ! filesink location=music.mp3</B>
|
|
|
|
<P>
|
|
Rips all tracks from compact disc and convert them into a single mp3 file
|
|
<BR>
|
|
|
|
<B><BR> gst-launch-1.0 cdparanoiasrc mode=continuous ! audioconvert ! lamemp3enc ! mpegaudioparse ! id3v2mux ! filesink location=cd.mp3</B>
|
|
|
|
<P>
|
|
Rips track 5 from the CD and converts it into a single mp3 file
|
|
<BR>
|
|
|
|
<B><BR> gst-launch-1.0 cdparanoiasrc track=5 ! audioconvert ! lamemp3enc ! mpegaudioparse ! id3v2mux ! filesink location=track5.mp3</B>
|
|
|
|
<P>
|
|
Using <B><A HREF="/cgi-bin/man/man2html?1+gst-inspect-1.0">gst-inspect-1.0</A></B>(1), it is possible to discover settings like the above
|
|
for cdparanoiasrc that will tell it to rip the entire cd or only tracks of it.
|
|
Alternatively, you can use an URI and gst-launch-1.0 will find an element (such as
|
|
cdparanoia) that supports that protocol for you, e.g.:
|
|
<B><BR> gst-launch-1.0 <A HREF="cdda://5">cdda://5</A> ! lamemp3enc vbr=new vbr-quality=6 ! filesink location=track5.mp3</B>
|
|
|
|
<P>
|
|
Records sound from your audio input and encodes it into an ogg file
|
|
<BR>
|
|
|
|
<B><BR> gst-launch-1.0 pulsesrc ! audioconvert ! vorbisenc ! oggmux ! filesink location=input.ogg</B>
|
|
|
|
<P>
|
|
<B>Video</B>
|
|
|
|
<P>
|
|
Display only the video portion of an MPEG-1 video file, outputting to
|
|
an X display window
|
|
<BR>
|
|
|
|
<B><BR> gst-launch-1.0 filesrc location=JB_FF9_TheGravityOfLove.mpg ! dvddemux ! mpegvideoparse ! mpeg2dec ! xvimagesink</B>
|
|
|
|
<P>
|
|
Display the video portion of a .vob file (used on DVDs), outputting to
|
|
an SDL window
|
|
<BR>
|
|
|
|
<B><BR> gst-launch-1.0 filesrc location=/flflfj.vob ! dvddemux ! mpegvideoparse ! mpeg2dec ! sdlvideosink</B>
|
|
|
|
<P>
|
|
Play both video and audio portions of an MPEG movie
|
|
<BR>
|
|
|
|
<B><BR> gst-launch-1.0 filesrc location=movie.mpg ! dvddemux name=demuxer demuxer. ! queue ! mpegvideoparse ! mpeg2dec ! sdlvideosink demuxer. ! queue ! mpegaudioparse ! mpg123audiodec ! audioconvert ! audioresample ! pulsesink</B>
|
|
|
|
<P>
|
|
Play an AVI movie with an external text subtitle stream
|
|
<BR>
|
|
|
|
<B><BR> gst-launch-1.0 filesrc location=movie.mpg ! mpegdemux name=demuxer demuxer. ! queue ! mpegvideoparse ! mpeg2dec ! videoconvert ! sdlvideosink demuxer. ! queue ! mpegaudioparse ! mpg123audiodec ! audioconvert ! audioresample ! pulsesink</B>
|
|
|
|
<P>
|
|
This example also shows how to refer to specific pads by name if an element
|
|
(here: textoverlay) has multiple sink or source pads.
|
|
<BR>
|
|
|
|
<B><BR> gst-launch-1.0 textoverlay name=overlay ! videoconvert ! videoscale ! autovideosink filesrc location=movie.avi ! decodebin ! videoconvert ! overlay.video_sink filesrc location=movie.srt ! subparse ! overlay.text_sink</B>
|
|
|
|
<P>
|
|
Play an AVI movie with an external text subtitle stream using playbin
|
|
<BR>
|
|
|
|
<B><BR> gst-launch-1.0 playbin uri=<A HREF="file:///path/to/movie.avi">file:///path/to/movie.avi</A> suburi=<A HREF="file:///path/to/movie.srt">file:///path/to/movie.srt</A></B>
|
|
|
|
<P>
|
|
<B>Network streaming</B>
|
|
|
|
<P>
|
|
Stream video using RTP and network elements.
|
|
<P>
|
|
This command would be run on the transmitter
|
|
<BR>
|
|
|
|
<B><BR> gst-launch-1.0 v4l2src ! video/x-raw,width=128,height=96,format=UYVY ! videoconvert ! ffenc_h263 ! video/x-h263 ! rtph263ppay pt=96 ! udpsink host=192.168.1.1 port=5000</B>
|
|
|
|
<P>
|
|
Use this command on the receiver
|
|
<BR>
|
|
|
|
<B><BR> gst-launch-1.0 udpsrc port=5000 ! application/x-rtp, clock-rate=90000,payload=96 ! rtph263pdepay queue-delay=0 ! ffdec_h263 ! xvimagesink</B>
|
|
|
|
<P>
|
|
<B>Diagnostic</B>
|
|
|
|
<P>
|
|
Generate a null stream and ignore it (and print out details).
|
|
<BR>
|
|
|
|
<B><BR> gst-launch-1.0 -v fakesrc num-buffers=16 ! fakesink</B>
|
|
|
|
<P>
|
|
Generate a pure sine tone to test the audio output
|
|
<BR>
|
|
|
|
<B><BR> gst-launch-1.0 audiotestsrc ! audioconvert ! audioresample ! pulsesink</B>
|
|
|
|
<P>
|
|
Generate a familiar test pattern to test the video output
|
|
<BR>
|
|
|
|
<B><BR> gst-launch-1.0 videotestsrc ! xvimagesink</B>
|
|
|
|
<BR>
|
|
|
|
<B><BR> gst-launch-1.0 videotestsrc ! ximagesink</B>
|
|
|
|
<P>
|
|
<B>Automatic linking</B>
|
|
|
|
<P>
|
|
You can use the decodebin element to automatically select the right elements
|
|
to get a working pipeline.
|
|
<P>
|
|
Play any supported audio format
|
|
<BR>
|
|
|
|
<B><BR> gst-launch-1.0 filesrc location=musicfile ! decodebin ! audioconvert ! audioresample ! pulsesink</B>
|
|
|
|
<P>
|
|
Play any supported video format with video and audio output. Threads are used
|
|
automatically. To make this even easier, you can use the playbin element:
|
|
<BR>
|
|
|
|
<B><BR> gst-launch-1.0 filesrc location=videofile ! decodebin name=decoder decoder. ! queue ! audioconvert ! audioresample ! pulsesink decoder. ! videoconvert ! xvimagesink</B>
|
|
|
|
<BR>
|
|
|
|
<B><BR> gst-launch-1.0 playbin uri=<A HREF="file:///home/joe/foo.avi">file:///home/joe/foo.avi</A></B>
|
|
|
|
<P>
|
|
<P>
|
|
<B>Filtered connections</B>
|
|
|
|
<P>
|
|
These examples show you how to use filtered caps.
|
|
<P>
|
|
Show a test image and use the YUY2 or YV12 video format for this.
|
|
<BR>
|
|
|
|
<B><BR> gst-launch-1.0 videotestsrc ! 'video/x-raw,format=YUY2;video/x-raw,format=YV12' ! xvimagesink</B>
|
|
|
|
<P>
|
|
Record audio and write it to a .wav file. Force usage of signed 16 to 32 bit
|
|
samples and a sample rate between 32kHz and 64KHz.
|
|
<BR>
|
|
|
|
<B><BR> gst-launch-1.0 pulsesrc ! 'audio/x-raw,rate=[32000,64000],format={S16LE,S24LE,S32LE}' ! wavenc ! filesink location=recording.wav</B>
|
|
|
|
<P>
|
|
<P>
|
|
<A NAME="lbAI"> </A>
|
|
<H2>ENVIRONMENT VARIABLES</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="22"><B>GST_DEBUG</B><DD>
|
|
Comma-separated list of debug categories and levels (e.g.
|
|
GST_DEBUG=totem:4,typefind:5). '*' is allowed as a wildcard as part of
|
|
debug category names (e.g. GST_DEBUG=*sink:6,*audio*:6). Since 1.2.0 it is
|
|
also possible to specify the log level by name (1=ERROR, 2=WARN, 3=FIXME,
|
|
4=INFO, 5=DEBUG, 6=LOG, 7=TRACE, 9=MEMDUMP) (e.g. GST_DEBUG=*audio*:LOG)
|
|
<DT id="23"><B>GST_DEBUG_NO_COLOR</B><DD>
|
|
When this environment variable is set, coloured debug output is disabled.
|
|
<DT id="24"><B>GST_DEBUG_DUMP_DOT_DIR</B><DD>
|
|
When set to a filesystem path, store 'dot' files of pipeline graphs there.
|
|
These can then later be converted into an image using the 'dot' utility from
|
|
the graphviz set of tools, like this: dot foo.dot -Tsvg -o foo.svg (png or jpg
|
|
are also possible as output format). There is also a utility called 'xdot'
|
|
which allows you to view the .dot file directly without converting it first.
|
|
<BR>
|
|
|
|
When the pipeline changes state through NULL to PLAYING and back to NULL, a
|
|
dot file is generated on each state change. To write a snapshot of the
|
|
pipeline state, send a SIGHUP to the process.
|
|
<DT id="25"><B>GST_REGISTRY</B><DD>
|
|
Path of the plugin registry file. Default is
|
|
~/.cache/gstreamer-1.0/registry-CPU.bin where CPU is the
|
|
machine/cpu type GStreamer was compiled for, e.g. 'i486', 'i686', 'x86-64', 'ppc',
|
|
etc. (check the output of "uname -i" and "uname -m" for details).
|
|
<DT id="26"><B>GST_REGISTRY_UPDATE</B><DD>
|
|
Set to "no" to force GStreamer to assume that no plugins have changed,
|
|
been added or been removed. This will make GStreamer skip the initial check
|
|
whether a rebuild of the registry cache is required or not. This may be useful
|
|
in embedded environments where the installed plugins never change. Do not
|
|
use this option in any other setup.
|
|
<DT id="27"><B>GST_PLUGIN_PATH</B><DD>
|
|
Specifies a list of directories to scan for additional plugins.
|
|
These take precedence over the system plugins.
|
|
<DT id="28"><B>GST_PLUGIN_SYSTEM_PATH</B><DD>
|
|
Specifies a list of plugins that are always loaded by default. If not set,
|
|
this defaults to the system-installed path, and the plugins installed in the
|
|
user's home directory
|
|
<DT id="29"><B>GST_DEBUG_FILE</B><DD>
|
|
Set this variable to a file path to redirect all GStreamer debug
|
|
messages to this file. If left unset, debug messages with be output
|
|
unto the standard error.
|
|
<DT id="30"><B>ORC_CODE</B><DD>
|
|
Useful Orc environment variable. Set ORC_CODE=debug to enable debuggers
|
|
such as gdb to create useful backtraces from Orc-generated code. Set
|
|
ORC_CODE=backup or ORC_CODE=emulate if you suspect Orc's SIMD code
|
|
generator is producing incorrect code. (Quite a few important
|
|
GStreamer plugins like videotestsrc, audioconvert or audioresample use Orc).
|
|
<DT id="31"><B>G_DEBUG</B><DD>
|
|
Useful GLib environment variable. Set G_DEBUG=fatal_warnings to make
|
|
GStreamer programs abort when a critical warning such as an assertion failure
|
|
occurs. This is useful if you want to find out which part of the code caused
|
|
that warning to be triggered and under what circumstances. Simply set G_DEBUG
|
|
as mentioned above and run the program in gdb (or let it core dump). Then get
|
|
a stack trace in the usual way.
|
|
</DL>
|
|
<A NAME="lbAJ"> </A>
|
|
<H2>FILES</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="32">~/.cache/gstreamer-1.0/registry-*.bin<DD>
|
|
The plugin cache; can be deleted at any time, will be re-created
|
|
automatically when it does not exist yet or plugins change. Based on
|
|
XDG_CACHE_DIR, so may be in a different location than the one suggested.
|
|
</DL>
|
|
<A NAME="lbAK"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?1+gst-inspect-1.0">gst-inspect-1.0</A></B>(1),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?1+gst-launch-1.0">gst-launch-1.0</A></B>(1),
|
|
|
|
<A NAME="lbAL"> </A>
|
|
<H2>AUTHOR</H2>
|
|
|
|
The GStreamer team at <A HREF="http://gstreamer.freedesktop.org/">http://gstreamer.freedesktop.org/</A>
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="33"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="34"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="35"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="36"><A HREF="#lbAE">OPTIONS</A><DD>
|
|
<DT id="37"><A HREF="#lbAF">GSTREAMER OPTIONS</A><DD>
|
|
<DT id="38"><A HREF="#lbAG">PIPELINE DESCRIPTION</A><DD>
|
|
<DT id="39"><A HREF="#lbAH">PIPELINE EXAMPLES</A><DD>
|
|
<DT id="40"><A HREF="#lbAI">ENVIRONMENT VARIABLES</A><DD>
|
|
<DT id="41"><A HREF="#lbAJ">FILES</A><DD>
|
|
<DT id="42"><A HREF="#lbAK">SEE ALSO</A><DD>
|
|
<DT id="43"><A HREF="#lbAL">AUTHOR</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:16 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|