summaryrefslogtreecommitdiff
path: root/docs/gst/tmpl/gstobject.sgml
blob: 0e6e97867b2b11acc599e6ddae2cda5109e9f2e1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
<!-- ##### SECTION Title ##### -->
GstObject

<!-- ##### SECTION Short_Description ##### -->
Basis for the GST object hierarchy.

<!-- ##### SECTION Long_Description ##### -->
<para>
GstObject provides a root for the object hierarchy tree filed in by the
GST library.  It is currently a thin wrapper on top of
<classname>GObject</classname> but it can be compiled against GTK+ with
a shim provided by the GStreamer library. It is an abstract class that is not
very usable on its own.
</para>

<para>
GstObject gives us basic refcounting, parenting functionality and locking. 
</para>
<para>
gst_object_set_name() and gst_object_get_name() are used to set/get the name of the 
object.
</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### ENUM GstObjectFlags ##### -->
<para>

</para>

@GST_DESTROYED: 
@GST_FLOATING: 
@GST_OBJECT_FLAG_LAST: 

<!-- ##### STRUCT GstObject ##### -->
<para>

</para>


<!-- ##### MACRO GST_FLAGS ##### -->
<para>
This macro returns the entire set of flags for the object.
</para>

@obj: Object to return flags for.


<!-- ##### MACRO GST_FLAG_IS_SET ##### -->
<para>
This macro checks to see if the given flag is set.
</para>

@obj: GstSrc to check for flag in.
@flag: Flag to check for, must be a single bit in guint32.


<!-- ##### MACRO GST_FLAG_SET ##### -->
<para>
This macro sets the given bits.
</para>

@obj: Object to set flag in.
@flag: Flag to set, can by any number of bits in guint32.


<!-- ##### MACRO GST_FLAG_UNSET ##### -->
<para>
This macro usets the given bits.
</para>

@obj: Object to unset flag in.
@flag: Flag to set, must be a single bit in guint32.


<!-- ##### MACRO GST_LOCK ##### -->
<para>
This macro will obtain a lock on the object, making serialization
possible.
</para>

@obj: Object to lock.


<!-- ##### MACRO GST_TRYLOCK ##### -->
<para>
This macro will try to obtain a lock on the object, but will return with
FALSE if it can't get it immediately.
</para>

@obj: Object to try to get a lock on.


<!-- ##### MACRO GST_UNLOCK ##### -->
<para>
This macro releases a lock on the object.
</para>

@obj: Object to unlock.


<!-- ##### MACRO GST_GET_LOCK ##### -->
<para>
Acquire a reference to the mutex of this object.
</para>

@obj: Object to get the mutex of.


<!-- ##### MACRO GST_OBJECT_PARENT ##### -->
<para>
Get the parent of this object
</para>

@obj: Object to get the parent of.


<!-- ##### MACRO GST_OBJECT_NAME ##### -->
<para>
Get the name of this object
</para>

@obj: Object to get the name of.


<!-- ##### MACRO GST_OBJECT_FLOATING ##### -->
<para>
Check if the object is floating.
</para>

@obj: The Object to check


<!-- ##### MACRO GST_OBJECT_DESTROYED ##### -->
<para>
Check if the object has been destroyed.
</para>

@obj: The Object to check


<!-- ##### FUNCTION gst_object_check_uniqueness ##### -->
<para>

</para>

@list: 
@name: 
@Returns: 


<!-- ##### FUNCTION gst_object_set_parent ##### -->
<para>

</para>

@object: 
@parent: 


<!-- ##### FUNCTION gst_object_get_parent ##### -->
<para>

</para>

@object: 
@Returns: 


<!-- ##### FUNCTION gst_object_set_name ##### -->
<para>

</para>

@object: 
@name: 


<!-- ##### FUNCTION gst_object_get_name ##### -->
<para>

</para>

@object: 
@Returns: 


<!-- ##### FUNCTION gst_object_unparent ##### -->
<para>

</para>

@object: 


<!-- ##### FUNCTION gst_object_ref ##### -->
<para>

</para>

@object: the object
@Returns: 


<!-- ##### FUNCTION gst_object_unref ##### -->
<para>

</para>

@object: the object


<!-- ##### FUNCTION gst_object_sink ##### -->
<para>

</para>

@object: the object


<!-- ##### FUNCTION gst_object_destroy ##### -->
<para>

</para>

@object: the object


<!-- ##### FUNCTION gst_object_save_thyself ##### -->
<para>

</para>

@object: 
@parent: 
@Returns: 


<!-- ##### FUNCTION gst_object_restore_thyself ##### -->
<para>

</para>

@object: 
@parent: 


<!-- ##### FUNCTION gst_object_get_path_string ##### -->
<para>

</para>

@object: 
@Returns: 


<!-- ##### FUNCTION gst_class_signal_emit_by_name ##### -->
<para>

</para>

@object: 
@name: 
@self: 


<!-- ##### FUNCTION gst_class_signal_connect ##### -->
<para>

</para>

@klass: 
@name: 
@func: 
@func_data: 
@Returns: 


<!-- ##### SIGNAL GstObject::object-saved ##### -->
<para>
Is trigered whenever a new object is saved to XML. You can connect to
this signal to insert custom XML tags into the core XML.
</para>

@gstobject: the object which received the signal.
@arg1: the xmlNodePtr of the parent node

<!-- ##### SIGNAL GstObject::parent-set ##### -->
<para>

</para>

@gstobject: the object which received the signal.
@arg1: the new parent

<!-- ##### ARG GstObject:name ##### -->
<para>

</para>