gstreamer/docs/gst/tmpl/gstparse.sgml

92 lines
2 KiB
Text
Raw Normal View History

<!-- ##### SECTION Title ##### -->
GstParse
<!-- ##### SECTION Short_Description ##### -->
Parses commandline syntax into a pipeline.
<!-- ##### SECTION Long_Description ##### -->
<para>
This method allows you to create a pipeline from a command
line syntax description. The following example creates a simple
mp3 player.
<programlisting>
GstElement *pipeline;
/* create a pipeline to hold our elements */
pipeline = gst_pipeline_new ("launch");
/* build a pipeline in the pipeline */
gst_parse_launch ("filesrc location=some.mp3 ! mad ! osssink", GST_BIN (pipeline));
/* play the thing */
gst_element_set_state (pipeline, GST_STATE_PLAYING);
while (gst_bin_iterate (GST_BIN (pipeline)));
gst_element_set_state (pipeline, GST_STATE_NULL);
</programlisting>
</para>
<para>
Elements are separated with a <option>!</option>, properties are set with
<replaceable>property</replaceable>=<replaceable>value</replaceable>, specific pads
of an element are selected by replacing the <option>!</option> with
<replaceable>padname</replaceable><option>!</option>.
</para>
<para>
Elements can be added to a bin by embracing them with <option>()</option>. Threads
can be made with <option>{}</option>.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### ENUM GstParseError ##### -->
<para>
The parsing errors.
</para>
@GST_PARSE_ERROR_SYNTAX: A syntax error was detected
@GST_PARSE_ERROR_NO_SUCH_ELEMENT: The pipeline description contains a non existing element
@GST_PARSE_ERROR_NO_SUCH_PROPERTY: The pipeline description contains a non existing element property
@GST_PARSE_ERROR_LINK: A pad link could not be made
<!-- ##### MACRO GST_PARSE_ERROR ##### -->
<para>
The error quark
</para>
<!-- ##### FUNCTION gst_parse_error_quark ##### -->
<para>
Get the error quark passed in the GError messages.
</para>
@Returns: The parse error quark
<!-- ##### FUNCTION gst_parse_launch ##### -->
<para>
</para>
@pipeline_description:
@error:
@Returns:
<!-- ##### FUNCTION gst_parse_launchv ##### -->
<para>
</para>
@argv:
@error:
@Returns: