diff options
| author | Nicolas Dechesne <n-dechesne@ti.com> | 2011-09-30 00:54:14 +0200 |
|---|---|---|
| committer | Nicolas Dechesne <n-dechesne@ti.com> | 2011-09-30 00:54:14 +0200 |
| commit | beb43201c942afa12dfc4225218b61fcd6e90923 (patch) | |
| tree | a1d85bac4a9ad32ed087d08ecd99ac3c03b9aa0a /docs/plugins/html/gstreamer-plugins-tee.html | |
Imported Upstream version 0.11.1upstream/0.11.1
Diffstat (limited to 'docs/plugins/html/gstreamer-plugins-tee.html')
| -rw-r--r-- | docs/plugins/html/gstreamer-plugins-tee.html | 266 |
1 files changed, 266 insertions, 0 deletions
diff --git a/docs/plugins/html/gstreamer-plugins-tee.html b/docs/plugins/html/gstreamer-plugins-tee.html new file mode 100644 index 0000000..f91160d --- /dev/null +++ b/docs/plugins/html/gstreamer-plugins-tee.html @@ -0,0 +1,266 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>tee</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="GStreamer Core Plugins 0.11 Plugins Reference Manual"> +<link rel="up" href="ch01.html" title="gstreamer Elements"> +<link rel="prev" href="gstreamer-plugins-queue2.html" title="queue2"> +<link rel="next" href="gstreamer-plugins-typefind.html" title="typefind"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="gstreamer-plugins-queue2.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GStreamer Core Plugins 0.11 Plugins Reference Manual</th> +<td><a accesskey="n" href="gstreamer-plugins-typefind.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#gstreamer-plugins-tee.synopsis" class="shortcut">Top</a> + | + <a href="#gstreamer-plugins-tee.description" class="shortcut">Description</a> + | + <a href="#gstreamer-plugins-tee.object-hierarchy" class="shortcut">Object Hierarchy</a> + | + <a href="#gstreamer-plugins-tee.properties" class="shortcut">Properties</a> +</td></tr> +</table> +<div class="refentry"> +<a name="gstreamer-plugins-tee"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="gstreamer-plugins-tee.top_of_page"></a>tee</span></h2> +<p>tee — 1-to-N pipe fitting</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="gstreamer-plugins-tee.synopsis"></a><h2>Synopsis</h2> +<a name="GstTee"></a><pre class="synopsis">struct <a class="link" href="gstreamer-plugins-tee.html#GstTee-struct" title="struct GstTee">GstTee</a>; +enum <a class="link" href="gstreamer-plugins-tee.html#GstTeePullMode" title="enum GstTeePullMode">GstTeePullMode</a>; +</pre> +</div> +<div class="refsect1"> +<a name="gstreamer-plugins-tee.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> + +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> + +----<a href="../gstreamer-0.11/GstObject.html">GstObject</a> + +----<a href="../gstreamer-0.11/GstElement.html">GstElement</a> + +----GstTee +</pre> +</div> +<div class="refsect1"> +<a name="gstreamer-plugins-tee.properties"></a><h2>Properties</h2> +<pre class="synopsis"> + "<a class="link" href="gstreamer-plugins-tee.html#GstTee--has-chain" title='The "has-chain" property'>has-chain</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct + "<a class="link" href="gstreamer-plugins-tee.html#GstTee--has-sink-loop" title='The "has-sink-loop" property'>has-sink-loop</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct + "<a class="link" href="gstreamer-plugins-tee.html#GstTee--last-message" title='The "last-message" property'>last-message</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read + "<a class="link" href="gstreamer-plugins-tee.html#GstTee--num-src-pads" title='The "num-src-pads" property'>num-src-pads</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read + "<a class="link" href="gstreamer-plugins-tee.html#GstTee--silent" title='The "silent" property'>silent</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct + "<a class="link" href="gstreamer-plugins-tee.html#GstTee--pull-mode" title='The "pull-mode" property'>pull-mode</a>" <a class="link" href="gstreamer-plugins-tee.html#GstTeePullMode" title="enum GstTeePullMode"><span class="type">GstTeePullMode</span></a> : Read / Write / Construct + "<a class="link" href="gstreamer-plugins-tee.html#GstTee--alloc-pad" title='The "alloc-pad" property'>alloc-pad</a>" <a href="../gstreamer-0.11/GstPad.html"><span class="type">GstPad</span></a>* : Read / Write +</pre> +</div> +<div class="refsect1"> +<a name="gstreamer-plugins-tee.description"></a><h2>Description</h2> +<p> +Split data to multiple pads. Branching the data flow is useful when e.g. +capturing a video where the video is shown on the screen and also encoded and +written to a file. Another example is playing music and hooking up a +visualisation module. +</p> +<p> +One needs to use separate queue elements (or a multiqueue) in each branch to +provide separate threads for each branch. Otherwise a blocked dataflow in one +branch would stall the other branches. +</p> +<p> +</p> +<div class="refsect2"> +<a name="id396228"></a><h3>Example launch line</h3> +<div class="informalexample"><pre class="programlisting"> +gst-launch filesrc location=song.ogg ! decodebin2 ! tee name=t ! queue ! autoaudiosink t. ! queue ! audioconvert ! goom ! ffmpegcolorspace ! autovideosink +</pre></div> Play a song.ogg from local dir and render visualisations using the goom +element. +</div> +<p> +</p> +<div class="refsynopsisdiv"> +<h2>Synopsis</h2> +<div class="refsect2"> +<a name="id408894"></a><h3>Element Information</h3> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">plugin</span></p></td> +<td> + <a class="link" href="gstreamer-plugins-plugin-coreelements.html#plugin-coreelements">coreelements</a> + </td> +</tr> +<tr> +<td><p><span class="term">author</span></p></td> +<td>Erik Walthinsen <omega@cse.ogi.edu>, Wim Taymans <wim@fluendo.com></td> +</tr> +<tr> +<td><p><span class="term">class</span></p></td> +<td>Generic</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="id408956"></a><h3>Element Pads</h3> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">name</span></p></td> +<td>sink</td> +</tr> +<tr> +<td><p><span class="term">direction</span></p></td> +<td>sink</td> +</tr> +<tr> +<td><p><span class="term">presence</span></p></td> +<td>always</td> +</tr> +<tr> +<td><p><span class="term">details</span></p></td> +<td>ANY</td> +</tr> +</tbody> +</table></div> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">name</span></p></td> +<td>src%d</td> +</tr> +<tr> +<td><p><span class="term">direction</span></p></td> +<td>source</td> +</tr> +<tr> +<td><p><span class="term">presence</span></p></td> +<td>request</td> +</tr> +<tr> +<td><p><span class="term">details</span></p></td> +<td>ANY</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<p> +</p> +</div> +<div class="refsect1"> +<a name="gstreamer-plugins-tee.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GstTee-struct"></a><h3>struct GstTee</h3> +<pre class="programlisting">struct GstTee;</pre> +<p> +Opaque <a class="link" href="gstreamer-plugins-tee.html#GstTee"><span class="type">GstTee</span></a> data structure. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GstTeePullMode"></a><h3>enum GstTeePullMode</h3> +<pre class="programlisting">typedef enum { + GST_TEE_PULL_MODE_NEVER, + GST_TEE_PULL_MODE_SINGLE, +} GstTeePullMode; +</pre> +<p> +The different ways that tee can behave in pull mode. <em class="parameter"><code>TEE_PULL_MODE_NEVER</code></em> +disables pull mode. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><a name="GST-TEE-PULL-MODE-NEVER:CAPS"></a><span class="term"><code class="literal">GST_TEE_PULL_MODE_NEVER</code></span></p></td> +<td>Never activate in pull mode. +</td> +</tr> +<tr> +<td><p><a name="GST-TEE-PULL-MODE-SINGLE:CAPS"></a><span class="term"><code class="literal">GST_TEE_PULL_MODE_SINGLE</code></span></p></td> +<td>Only one src pad can be active in pull mode. +</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="gstreamer-plugins-tee.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="GstTee--has-chain"></a><h3>The <code class="literal">"has-chain"</code> property</h3> +<pre class="programlisting"> "has-chain" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct</pre> +<p>If the element can operate in push mode.</p> +<p>Default value: TRUE</p> +</div> +<hr> +<div class="refsect2"> +<a name="GstTee--has-sink-loop"></a><h3>The <code class="literal">"has-sink-loop"</code> property</h3> +<pre class="programlisting"> "has-sink-loop" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct</pre> +<p>If the element should spawn a thread (unimplemented and deprecated).</p> +<p>Default value: FALSE</p> +</div> +<hr> +<div class="refsect2"> +<a name="GstTee--last-message"></a><h3>The <code class="literal">"last-message"</code> property</h3> +<pre class="programlisting"> "last-message" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read</pre> +<p>The message describing current status.</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="GstTee--num-src-pads"></a><h3>The <code class="literal">"num-src-pads"</code> property</h3> +<pre class="programlisting"> "num-src-pads" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read</pre> +<p>The number of source pads.</p> +<p>Allowed values: >= 0</p> +<p>Default value: 0</p> +</div> +<hr> +<div class="refsect2"> +<a name="GstTee--silent"></a><h3>The <code class="literal">"silent"</code> property</h3> +<pre class="programlisting"> "silent" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct</pre> +<p>Don't produce last_message events.</p> +<p>Default value: TRUE</p> +</div> +<hr> +<div class="refsect2"> +<a name="GstTee--pull-mode"></a><h3>The <code class="literal">"pull-mode"</code> property</h3> +<pre class="programlisting"> "pull-mode" <a class="link" href="gstreamer-plugins-tee.html#GstTeePullMode" title="enum GstTeePullMode"><span class="type">GstTeePullMode</span></a> : Read / Write / Construct</pre> +<p>Behavior of tee in pull mode.</p> +<p>Default value: Never activate in pull mode</p> +</div> +<hr> +<div class="refsect2"> +<a name="GstTee--alloc-pad"></a><h3>The <code class="literal">"alloc-pad"</code> property</h3> +<pre class="programlisting"> "alloc-pad" <a href="../gstreamer-0.11/GstPad.html"><span class="type">GstPad</span></a>* : Read / Write</pre> +<p>The pad used for gst_pad_alloc_buffer.</p> +</div> +</div> +<div class="refsect1"> +<a name="gstreamer-plugins-tee.see-also"></a><h2>See Also</h2> +<a class="link" href="gstreamer-plugins-identity.html#GstIdentity"><span class="type">GstIdentity</span></a> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file |