docs/gst/tmpl/gstparse.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GstParse
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Parses commandline syntax into a pipeline.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 This method allows you to create a pipeline from a command
  10 line syntax description. The following example creates a simple
  11 mp3 player.
  12 <programlisting>
  13   GstElement *pipeline;
  14
  15   /* create a pipeline to hold our elements */
  16   pipeline = gst_pipeline_new ("launch");
  17
  18   /* build a pipeline in the pipeline */
  19   gst_parse_launch ("disksrc location=some.mp3 ! mad ! osssink", GST_BIN (pipeline));
  20
  21   /* play the thing */
  22   gst_element_set_state (pipeline, GST_STATE_PLAYING);
  23
  24   while (gst_bin_iterate (GST_BIN (pipeline)));
  25
  26   gst_element_set_state (pipeline, GST_STATE_NULL);
  27
  28 </programlisting>
  29 </para>
  30
  31 <para>
  32 Elements are separated with a <option>!</option>, properties are set with
  33 <replaceable>property</replaceable>=<replaceable>value</replaceable>, specific pads
  34 of an element are selected by replacing the <option>!</option> with
  35 <replaceable>padname</replaceable><option>!</option>.
  36 </para>
  37 <para>
  38 Elements can be added to a bin by embracing them with <option>()</option>. Threads
  39 can be made with <option>{}</option>.
  40 </para>
  41
  42 <!-- ##### SECTION See_Also ##### -->
  43 <para>
  44
  45 </para>
  46
  47 <!-- ##### ENUM GstParseErrors ##### -->
  48 <para>
  49
  50 </para>
  51
  52 @GST_PARSE_ERROR_SYNTAX:
  53 @GST_PARSE_ERROR_CREATING_ELEMENT:
  54 @GST_PARSE_ERROR_NOSUCH_ELEMENT:
  55
  56 <!-- ##### FUNCTION gst_parse_launch ##### -->
  57 <para>
  58
  59 </para>
  60
  61 @cmdline:
  62 @parent:
  63 @Returns:
  64
  65