<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [

<!--ArborText, Inc., 1988-1999, v.4002-->

<!ENTITY cmd "gst-xmllaunch">

<!ENTITY % commonents SYSTEM "smancommon.ent">

%commonents;

<!ENTITY % booktitles SYSTEM "booktitles.ent">

%booktitles;

<!ENTITY suncopy "Copyright (c) 2004,2006 Sun Microsystems, Inc. All Rights Reserved.">

]>

<?Pub UDT _bookmark _target>

<?Pub Inc>

<refentry id="gst-xmllaunch-1">

<refmeta><refentrytitle>gst-xmllaunch</refentrytitle><manvolnum>1</manvolnum>

<refmiscinfo class="date">14 Oct 2004</refmiscinfo>

<refmiscinfo class="sectdesc">&man1;</refmiscinfo>

<refmiscinfo class="software">&release;</refmiscinfo>

<refmiscinfo class="arch">generic</refmiscinfo>

<refmiscinfo class="copyright">&suncopy;</refmiscinfo>

</refmeta>

<indexterm><primary>gst-xmllaunch</primary></indexterm><indexterm><primary>

build and run a GStreamer pipeline from an XML serialization</primary></indexterm>

<refnamediv id="gst-xmllaunch-1-name"><refname>gst-xmllaunch</refname>

<refpurpose>build and run a GStreamer pipeline

from an XML serialization</refpurpose></refnamediv>

<refsynopsisdiv id="gst-xmllaunch-1-synp"><title>&synp-tt;</title>

<cmdsynopsis><command>&cmd;</command>

<arg choice="opt"><option>-exclude=<replaceable>type1,type2,...</replaceable></option></arg>

<arg choice="opt"><option>-messages</option></arg>

<arg choice="opt"><option>-no-fault</option></arg>

<arg choice="opt"><option>-output-=<replaceable>file</replaceable></option></arg>

<arg choice="opt"><option>-tags</option></arg>

<arg choice="opt"><option>-trace</option></arg>

<arg choice="opt"><option>-verbose</option></arg>

<arg choice="opt"><option>-version</option></arg>

<arg choice="opt"><option role="nodash"><replaceable>gst-std-options</replaceable></option></arg>

<arg choice="plain"><option role="nodash"><replaceable>XML-file</replaceable></option></arg>

<arg choice="opt" rep="repeat"><option role="nodash"><replaceable>element.property=value</replaceable></option></arg>

</cmdsynopsis></refsynopsisdiv>

<refsect1 id="gst-xmllaunch-1-desc"><title>&desc-tt;</title>

<para><command>&cmd;</command> builds and runs a basic GStreamer pipeline,

loading it from an XML description. You can produce the XML description using

<citerefentry><refentrytitle>gst-inspect</refentrytitle><manvolnum>1</manvolnum></citerefentry>

with the <option>o</option> option or by calling <literal>

gst_xml_write_file()</literal> in your own application.</para>

<para>You can set <replaceable>XML-file</replaceable> to &ldquo;-&rdquo;,

to read from <literal>stdin</literal>.</para>

<para><replaceable>XML-file</replaceable> can also be a URI, thanks to <literal>

libxml</literal>.</para>

<para>See <citerefentry><refentrytitle>gst-launch</refentrytitle><manvolnum>

1</manvolnum></citerefentry> for the syntax to set element names, and run

<citerefentry><refentrytitle>gst-inspect</refentrytitle><manvolnum>1</manvolnum></citerefentry>

to see what properties various elements have.</para>

</refsect1>

<refsect1 id="gst-xmllaunch-1-opts"><title>&opts-tt;</title>

<para>The following options are supported by <command>&cmd;</command>:</para>

<variablelist termlength="wide">

<varlistentry>

<term><option>X</option>, <option>-exclude=<replaceable>type1,type2,...</replaceable></option></term>

<listitem><para>

Do not output status information of specified <replaceable>type</replaceable>.</para>

</listitem></varlistentry>

<varlistentry>

<term><option>m</option>, <option>-messages</option></term>

<listitem><para>

Output messages.</para>

</listitem></varlistentry>

<varlistentry>

<term><option>f</option>, <option>-no-fault</option></term>

<listitem><para>

Do not install a fault handler.</para>

</listitem></varlistentry>

<varlistentry>

<term><option>o</option>, <option>output-=<replaceable>file</replaceable></option></term>

<listitem><para>

Save XML representation of pipeline to <replaceable>file</replaceable>,

then exit.</para>

</listitem></varlistentry>

<varlistentry>

<term><option>t</option>, <option>-tags</option></term>

<listitem><para>

Output tags, also known as metadata.</para>

</listitem></varlistentry>

<varlistentry>

<term><option>T</option>, <option>-trace</option></term>

<listitem><para>

Print memory allocation trace, if enabled at compile time.</para>

</listitem></varlistentry>

<varlistentry>

<term><option>v</option>, <option>-verbose</option></term>

<listitem><para>

Output status information and property notifications.</para>

</listitem></varlistentry>

<varlistentry>

<term><option>-version</option></term>

<listitem><para>

Print GStreamer version number.</para>

</listitem></varlistentry>

<varlistentry>

<term><option role="nodash"><replaceable>gst-std-options</replaceable></option></term>

<listitem><para>Standard options available for use with most GStreamer applications.

See <citerefentry><refentrytitle>gst-std-options</refentrytitle><manvolnum>

5</manvolnum></citerefentry> for more information.</para>

</listitem></varlistentry>

</variablelist></refsect1>

<refsect1 id="gst-xmllaunch-1-exam"><title>&exam-tt;</title>

<example role="example">

<title>Setting the Location Property of the Element filesrc0 to "music.mp3". See

for syntax on setting element names, and

<citerefentry><refentrytitle>gst-inspect</refentrytitle><manvolnum>1</manvolnum></citerefentry>

to see what properties various elements have.

</title>

<para><screen>example% <userinput>&cmd; my-pipeline.xml filesrc0.location=music.mp3

</userinput></screen></para>

</example>

</refsect1>

<refsect1 id="gst-xmllaunch-1-file"><title>&file-tt;</title>

<para>The following files are used by this application:</para>

<variablelist termlength="medium">

<varlistentry><term><filename>/usr/bin/&cmd;</filename></term><listitem><para>

Executable to build and run a GStreamer pipeline from an XML serialization

</para>

</listitem></varlistentry>

</variablelist></refsect1>

<refsect1 id="gst-xmllaunch-1-attr"><title>&attr-tt;</title>

<para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>

<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>

for descriptions of the following attributes:</para>

<informaltable frame="all">

<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">

<colspec colname="COLSPEC1" colwidth="1*">

<thead>

<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"

valign="middle">ATTRIBUTE VALUE</entry></row>

</thead>

<tbody>

<row><entry><para>Availability</para></entry><entry><para>library/audio/gstreamer

</para></entry></row>

<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry

colname="COLSPEC1"><para>Volatile</para></entry></row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 id="gst-xmllaunch-1-also"><title>&also-tt;</title>

<para>

<citerefentry><refentrytitle>gst-feedback</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

<citerefentry><refentrytitle>gst-inspect</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

<citerefentry><refentrytitle>gst-launch</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

<citerefentry><refentrytitle>gst-typefind</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

<citerefentry><refentrytitle>gst-xmlinspect</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

<citerefentry><refentrytitle>gstreamer-properties</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

<citerefentry><refentrytitle>libgstreamer-0.10</refentrytitle><manvolnum>3</manvolnum></citerefentry>,

<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>,

<citerefentry><refentrytitle>gst-std-options</refentrytitle><manvolnum>5</manvolnum></citerefentry>

</para>

</refsect1>

<refsect1 id="gst-xmllaunch-1-note"><title>&note-tt;</title>

<para>Original man page written by the GStreamer team at <literal>http://gstreamer.net/</literal>.

</para>

<para>Updated by Brian Cameron, Sun Microsystems Inc., 2004, 2006.</para>

</refsect1>

</refentry>