parts of the patch submitted in bug #113913
[platform/upstream/gstreamer.git] / 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. It can contain any set of GstObjects. 
11 </para>
12 <para>
13 A Thread can act as a toplevel bin as it has its own scheduler.
14 </para>
15
16 <!-- ##### SECTION See_Also ##### -->
17 <para>
18 #GstBin, #GstPipeline
19 </para>
20
21 <!-- ##### ENUM GstThreadState ##### -->
22 <para>
23 Thread flags:
24 </para>
25
26 @GST_THREAD_STATE_SPINNING: The thread is runnning
27 @GST_THREAD_STATE_REAPING: The thread is ending.
28 @GST_THREAD_MUTEX_LOCKED: 
29 @GST_THREAD_FLAG_LAST: subclass use this to start their enumeration
30
31 <!-- ##### STRUCT GstThread ##### -->
32 <para>
33 The GstThread object
34 </para>
35
36
37 <!-- ##### SIGNAL GstThread::shutdown ##### -->
38 <para>
39
40 </para>
41
42 @gstthread: the object which received the signal.
43
44 <!-- ##### ARG GstThread:priority ##### -->
45 <para>
46 The thread priority
47 </para>
48
49 <!-- ##### FUNCTION gst_thread_new ##### -->
50 <para>
51
52 </para>
53
54 @name: 
55 @Returns: 
56
57