docs/gst/tmpl/gstthread.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GstThread
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 A bin that will become a thread
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 A bin that will become a thread if possible when the pipeline is started
  10 up.  Can contain any set of GstObjects except another GstThread.  All
  11 starting points and/or clocked events must be registered with this object,
  12 to be dealt with in the separate thread.
  13
  14 </para>
  15
  16 <!-- ##### SECTION See_Also ##### -->
  17 <para>
  18
  19 </para>
  20
  21 <!-- ##### ENUM GstThreadState ##### -->
  22 <para>
  23 Thread flags:
  24 </para>
  25
  26 @GST_THREAD_CREATE: The thread is being created.
  27 @GST_THREAD_STATE_STARTED:
  28 @GST_THREAD_STATE_SPINNING: The thread is runnning
  29 @GST_THREAD_STATE_REAPING: The thread is ending.
  30 @GST_THREAD_STATE_ELEMENT_CHANGED:
  31 @GST_THREAD_FLAG_LAST: subclass use this to start their enumeration
  32
  33 <!-- ##### STRUCT GstThread ##### -->
  34 <para>
  35
  36 </para>
  37
  38
  39 <!-- ##### FUNCTION gst_thread_new ##### -->
  40 <para>
  41
  42 </para>
  43
  44 @name:
  45 @Returns:
  46
  47
  48 <!-- ##### ARG GstThread:create-thread ##### -->
  49 <para>
  50 TRUE if the thread should be created.
  51
  52 </para>
  53