summaryrefslogtreecommitdiff
path: root/docs/gst/tmpl/gstpipeline.sgml
diff options
context:
space:
mode:
Diffstat (limited to 'docs/gst/tmpl/gstpipeline.sgml')
-rw-r--r--docs/gst/tmpl/gstpipeline.sgml46
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/gst/tmpl/gstpipeline.sgml b/docs/gst/tmpl/gstpipeline.sgml
new file mode 100644
index 0000000000..d47ff73fcd
--- /dev/null
+++ b/docs/gst/tmpl/gstpipeline.sgml
@@ -0,0 +1,46 @@
+<!-- ##### SECTION Title ##### -->
+GstPipeline
+
+<!-- ##### SECTION Short_Description ##### -->
+Top-level bin with scheduling and pipeline management functionality.
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+In almost all cases, you'll want to use a GstPipeline when creating a
+filter graph. The GstPipeline will manage all the scheduling issues,
+including threading, as well as provide simple interfaces to common
+functions, like 'Play'.
+</para>
+<para>
+gst_pipeline_new() is used to create a pipeline. when you are done with
+the pipeline, use gst_element_unref() to free its resources.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+#GstBin
+</para>
+
+<!-- ##### STRUCT GstPipeline ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### FUNCTION gst_pipeline_new ##### -->
+<para>
+
+</para>
+
+@name:
+@Returns:
+
+
+<!-- ##### MACRO gst_pipeline_destroy ##### -->
+<para>
+Destroys the pipeline.
+</para>
+
+@pipeline: #GstPipeline to destroy
+
+