~ubuntu-branches/ubuntu/karmic/gst-plugins-base0.10/karmic-updates

<a name="gst-plugins-base-plugins-playbin.object-hierarchy"></a><h2>Object Hierarchy</h2>

<pre class="synopsis">

  <a

>GObject</a>

   +----<a

>GstObject</a>

         +----<a

>GstElement</a>

               +----<a

>GstBin</a>

                     +----<a

>GstPipeline</a>

                           +----<a class="link" href="GstPlayBaseBin.html" title="GstPlayBaseBin">GstPlayBaseBin</a>

                                 +----GstPlayBin

<p>

GstPlayBin implements

 <a

>GstChildProxy</a>.</p>

</div>

<div class="refsect1" lang="en">

<a name="gst-plugins-base-plugins-playbin.properties"></a><h2>Properties</h2>

<pre class="synopsis">

  "<a class="link" href="gst-plugins-base-plugins-playbin.html#GstPlayBin--audio-sink" title='The "audio-sink" property'>audio-sink</a>"               <a

>GstElement</a>*           : Read / Write

  "<a class="link" href="gst-plugins-base-plugins-playbin.html#GstPlayBin--frame" title='The "frame" property'>frame</a>"                    <a

>GstBuffer</a>*            : Read

  "<a class="link" href="gst-plugins-base-plugins-playbin.html#GstPlayBin--subtitle-font-desc" title='The "subtitle-font-desc" property'>subtitle-font-desc</a>"       <a

>gchar</a>*                : Write

  "<a class="link" href="gst-plugins-base-plugins-playbin.html#GstPlayBin--video-sink" title='The "video-sink" property'>video-sink</a>"               <a

>GstElement</a>*           : Read / Write

  "<a class="link" href="gst-plugins-base-plugins-playbin.html#GstPlayBin--vis-plugin" title='The "vis-plugin" property'>vis-plugin</a>"               <a

>GstElement</a>*           : Read / Write

  "<a class="link" href="gst-plugins-base-plugins-playbin.html#GstPlayBin--volume" title='The "volume" property'>volume</a>"                   <a

>gdouble</a>               : Read / Write

  "<a class="link" href="gst-plugins-base-plugins-playbin.html#GstPlayBin--connection-speed" title='The "connection-speed" property'>connection-speed</a>"         <a

>guint</a>                 : Read / Write

</pre>

</div>

<p>

</p>

<div class="refsect2" lang="en">

<p>

A playbin element can be created just like any other element using

<a

><code class="function">gst_element_factory_make()</code></a>. The file/URI to play should be set via the <span class="type">"uri"</span>

property. This must be an absolute URI, relative file paths are not allowed.

Example URIs are file:///home/joe/movie.avi or http://www.joedoe.com/foo.ogg

</p>

<p>

Playbin is a <a

><span class="type">GstPipeline</span></a>. It will notify the application of everything

that's happening (errors, end of stream, tags found, state changes, etc.)

by posting messages on its <a

><span class="type">GstBus</span></a>. The application needs to watch the

bus.

</p>

<p>

Playback can be initiated by setting the element to PLAYING state using

<a

><code class="function">gst_element_set_state()</code></a>. Note that the state change will take place in

the background in a separate thread, when the function returns playback

is probably not happening yet and any errors might not have occured yet.

</p>

<p>

Seeking can be done using <a

><code class="function">gst_element_seek_simple()</code></a> or <a

><code class="function">gst_element_seek()</code></a>

on the playbin element. Again, the seek will not be executed

instantaneously, but will be done in a background thread. When the seek

call returns the seek will most likely still be in process. An application

may wait for the seek to finish (or fail) using <a

><code class="function">gst_element_get_state()</code></a> with

-1 as the timeout, but this will block the user interface and is not

recommended at all.

<p>

Applications may query the current position and duration of the stream

via <a

><code class="function">gst_element_query_position()</code></a> and <a

><code class="function">gst_element_query_duration()</code></a> and

setting the format passed to GST_FORMAT_TIME. If the query was successful,

the duration or position will have been returned in units of nanoseconds.

</p>

<hr>

<div class="refsect2" lang="en">

<p>

By default, if no audio sink or video sink has been specified via the

<a class="link" href="gst-plugins-base-plugins-playbin.html#GstPlayBin--audio-sink" title='The "audio-sink" property'><span class="type">"audio-sink"</span></a> or <a class="link" href="gst-plugins-base-plugins-playbin.html#GstPlayBin--video-sink" title='The "video-sink" property'><span class="type">"video-sink"</span></a> property, playbin will use

If the application wants more control over how audio or video should be

output, it may create the audio/video sink elements itself (for example

using <a

><code class="function">gst_element_factory_make()</code></a>) and provide them to playbin using the

<a class="link" href="gst-plugins-base-plugins-playbin.html#GstPlayBin--audio-sink" title='The "audio-sink" property'><span class="type">"audio-sink"</span></a> or <a class="link" href="gst-plugins-base-plugins-playbin.html#GstPlayBin--video-sink" title='The "video-sink" property'><span class="type">"video-sink"</span></a> property.

</p>

possible to create container elements that look like a sink to playbin,

but in reality contain a number of custom elements linked together. This

can be achieved by creating a <a

><span class="type">GstBin</span></a> and putting elements in there and

linking them, and then creating a sink <a

><span class="type">GstGhostPad</span></a> for the bin and pointing

it to the sink pad of the first element within the bin. This can be used

for a number of purposes, for example to force output to a particular

</p>

<hr>

<div class="refsect2" lang="en">

<p>

Most of the common meta data (artist, title, etc.) can be retrieved by

watching for TAG messages on the pipeline's bus (see above).

using the  <a class="link" href="GstPlayBaseBin.html#GstPlayBaseBin--stream-info" title='The "stream-info" property'><span class="type">"stream-info"</span></a> property, which will return a GList of

stream info objects, one for each stream. These are opaque objects that can

only be accessed via the standard GObject property interface, ie. <a

><code class="function">g_object_get()</code></a>.

Each stream info object has the following properties:

</p>

Stream information from the <a class="link" href="GstPlayBaseBin.html#GstPlayBaseBin--stream-info" title='The "stream-info" property'><span class="type">"stream-info"</span></a> property is best queried once

playbin has changed into PAUSED or PLAYING state (which can be detected

via a state-changed message on the <a

><span class="type">GstBus</span></a> where old_state=READY and

new_state=PAUSED), since before that the list might not be complete yet or

not contain all available information (like language-codes).

</p>

<hr>

<div class="refsect2" lang="en">

Playbin handles buffering automatically for the most part, but applications

need to handle parts of the buffering process as well. Whenever playbin is

buffering, it will post BUFFERING messages on the bus with a percentage

</p>

<hr>

<div class="refsect2" lang="en">

By default, playbin (or rather the video sinks used) will create their own

window. Applications will usually want to force output to a window of their

own, however. This can be done using the <a

><span class="type">GstXOverlay</span></a> interface, which most

video sinks implement. See the documentation there for more details.

</div>

</p>

<hr>

<div class="refsect2" lang="en">

The device to use for CDs/DVDs needs to be set on the source element

playbin creates before it is opened. The only way to do this at the moment

is to connect to playbin's "notify::source" signal, which will be emitted

</p>

<hr>

<div class="refsect2" lang="en">

<div class="informalexample"><pre class="programlisting">

gst-launch -v playbin uri=file:///path/to/somefile.avi

</pre></div> This will play back the given AVI video file, given that the video and

<div class="refsynopsisdiv">

<h2>Synopsis</h2>

<div class="refsect2" lang="en">

<div class="variablelist"><table border="0">

<col align="left" valign="top">

<tbody>

</div>

<hr>

<div class="refsect2" lang="en">

</div>

</div>

<div class="refsynopsisdiv">

<h2>Synopsis</h2>

<div class="refsect2" lang="en">

<div class="variablelist"><table border="0">

<col align="left" valign="top">

<tbody>

</div>

<hr>

<div class="refsect2" lang="en">

</div>

</div>

<p>

<div class="refsect2" lang="en">

<a name="GstPlayBin--audio-sink"></a><h3>The <code class="literal">"audio-sink"</code> property</h3>

<pre class="programlisting">  "audio-sink"               <a

>GstElement</a>*           : Read / Write</pre>

<p>the audio output element to use (NULL = default sink).</p>

</div>

<div class="refsect2" lang="en">

<a name="GstPlayBin--frame"></a><h3>The <code class="literal">"frame"</code> property</h3>

<pre class="programlisting">  "frame"                    <a

>GstBuffer</a>*            : Read</pre>

<p>The last frame (NULL = no video available).</p>

</div>

<div class="refsect2" lang="en">

<a name="GstPlayBin--subtitle-font-desc"></a><h3>The <code class="literal">"subtitle-font-desc"</code> property</h3>

<pre class="programlisting">  "subtitle-font-desc"       <a

>gchar</a>*                : Write</pre>

<p>Pango font description of font to be used for subtitle rendering.</p>

<p>Default value: NULL</p>

<div class="refsect2" lang="en">

<a name="GstPlayBin--video-sink"></a><h3>The <code class="literal">"video-sink"</code> property</h3>

<pre class="programlisting">  "video-sink"               <a

>GstElement</a>*           : Read / Write</pre>

<p>the video output element to use (NULL = default sink).</p>

</div>

<div class="refsect2" lang="en">

<a name="GstPlayBin--vis-plugin"></a><h3>The <code class="literal">"vis-plugin"</code> property</h3>

<pre class="programlisting">  "vis-plugin"               <a

>GstElement</a>*           : Read / Write</pre>

<p>the visualization element to use (NULL = none).</p>

</div>

<div class="refsect2" lang="en">

<a name="GstPlayBin--volume"></a><h3>The <code class="literal">"volume"</code> property</h3>

<pre class="programlisting">  "volume"                   <a

>gdouble</a>               : Read / Write</pre>

<p>

Get or set the current audio stream volume. 1.0 means 100%,

<div class="refsect2" lang="en">

<a name="GstPlayBin--connection-speed"></a><h3>The <code class="literal">"connection-speed"</code> property</h3>

<pre class="programlisting">  "connection-speed"         <a

>guint</a>                 : Read / Write</pre>

<p>Network connection speed in kbps (0 = unknown).</p>

<p>Default value: 0</p>