gstreamer/docs/gst/tmpl/gstthread.sgml
Wim Taymans bf8c785fb0 Documentation updates. All standard library objects and standard elements are documented. Modified some of the elemen...
Original commit message from CVS:
Documentation updates. All standard library objects and standard
elements are documented. Modified some of the elements to more
accuratly report about their arguments so the documentation builds
more reasonable output.
Added aviencoder and jpegencoder elements (not working yet)
2000-03-27 19:53:43 +00:00

83 lines
1.4 KiB
Text

<!-- ##### SECTION Title ##### -->
GstThread
<!-- ##### SECTION Short_Description ##### -->
A bin that will become a thread
<!-- ##### SECTION Long_Description ##### -->
<para>
A bin that will become a thread if possible when the pipeline is started
up. Can contain any set of GstObjects except another GstThread. All
starting points and/or clocked events must be registered with this object,
to be dealt with in the separate thread.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### ENUM GstThreadState ##### -->
<para>
<informaltable pgwide=1 frame="none" role="enum">
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
<tbody>
<row>
<entry>GST_THREAD_CREATE</entry>
<entry>The thread is being created. </entry>
</row>
<row>
<entry>GST_THREAD_STATE_SPINNING</entry>
<entry>The thread is runnning</entry>
</row>
<row>
<entry>GST_THREAD_STATE_REAPING</entry>
<entry>The thread is ending.</entry>
</row>
</tbody></tgroup></informaltable>
</para>
<!-- ##### STRUCT GstThread ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_thread_new ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_thread_main_loop ##### -->
<para>
</para>
@arg:
<!-- ##### FUNCTION gst_thread_iterate ##### -->
<para>
</para>
@thread:
<!-- ##### ARG GstThread:create_thread ##### -->
<para>
TRUE if the thread should be created.
</para>