gstreamer/tools/gst-xmllaunch.1.in
Tim-Philipp Müller fd64c4b255 tools: deprecate gst-xmllaunch and print fat warning if someone tries to use it
Pipeline serialisation to and from XML is horribly broken for all
but the most simple use cases, and will likely never be fixed.
Make sure everyone playing around with these tools is aware of
this, to avoid frustration. See countless bug reports in bugzilla.
2010-06-24 17:53:36 +01:00

69 lines
2.2 KiB
Groff

.TH "GStreamer" "1" "March 2001"
.SH "NAME"
gst\-xmllaunch \- build and run a GStreamer pipeline from an XML serialization
.SH "SYNOPSIS"
\fBgst\-xmllaunch\fR \fI[OPTION...]\fR XML\-FILE [ ELEMENT.PROPERTY=VALUE ... ]
.SH "DESCRIPTION"
.LP
\fIgst\-xmllaunch\fP is a tool that is used to build and run a basic
\fIGStreamer\fP pipeline, loading it from an XML description. You can
produce the XML description using gst-launch(1) with the -o option or by
calling gst_xml_write_file() in your own app.
A simple commandline looks like:
gst\-xmllaunch my\-pipeline.xml filesrc0.location=music.mp3
This sets the location property of the element named filesrc0 to the value
"music.mp3". See gst\-launch(1) for syntax on setting element names, and
gst\-inspect to see what properties various elements have.
You can pass "-" as the XML\-FILE to read from stdin.
XML\-FILE can be a URI as well, thanks to the wizardry of libxml. I'm not really
sure what all is supported, it seems http works just fine though.
.
.SH "WARNING"
\fIgst\-xmllaunch\fP is deprecated and broken for all but the most simple
pipelines. It will most likely be removed in future. Don't use it.
.
.SH "OPTIONS"
.l
\fIgst\-xmllaunch\fP accepts the following options:
.TP 8
.B \-\-help
Print help synopsis and available FLAGS
.TP 8
.B \-\-silent
Do not output status information
.TP 8
.B \-\-exclude=TYPE, \-XTYPE
Do not output status information of TYPE
.TP 8
.B \-\-output=FILE, \-oFILE
Save XML representation of pipeline to FILE and exit
.TP 8
.B \-\-gst\-info\-mask=FLAGS
\fIGStreamer\fP info flags to set (list with \-\-help)
.TP 8
.B \-\-gst\-debug\-mask=FLAGS
\fIGStreamer\fP debugging flags to set (list with \-\-help)
.TP 8
.B \-\-gst\-mask=FLAGS
\fIGStreamer\fP info and debugging flags to set (list with \-\-help)
.TP 8
.B \-\-gst\-plugin\-spew
\fIGStreamer\fP info flags to set
Enable printout of errors while loading \fIGStreamer\fP plugins
.TP 8
.B \-\-gst\-plugin\-path=PATH
Add directories separated with ':' to the plugin search path
.
.SH "SEE ALSO"
.BR gst\-feedback (1),
.BR gst\-inspect (1),
.BR gst\-launch (1),
.BR gst\-typefind (1)
.SH "AUTHOR"
The GStreamer team at http://gstreamer.freedesktop.org/