docs/gst/tmpl/gsttypes.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 gsttypes
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9
  10 </para>
  11
  12 <!-- ##### SECTION See_Also ##### -->
  13 <para>
  14
  15 </para>
  16
  17 <!-- ##### STRUCT GstObject ##### -->
  18 <para>
  19
  20 </para>
  21
  22
  23 <!-- ##### SIGNAL GstObject::deep-notify ##### -->
  24 <para>
  25 The deep notify signal is used to be notified of property changes.
  26 it is typically attached to the toplevel bin to receive notifications
  27 from all the elements contained in that bin.
  28 </para>
  29
  30 @gstobject: the object which received the signal.
  31 @arg1: the object that originated the signal
  32 @arg2: the property that changed
  33
  34 <!-- ##### SIGNAL GstObject::object-saved ##### -->
  35 <para>
  36 Is trigered whenever a new object is saved to XML. You can connect to
  37 this signal to insert custom XML tags into the core XML.
  38 </para>
  39
  40 @gstobject: the object which received the signal.
  41 @arg1: the xmlNodePtr of the parent node
  42
  43 <!-- ##### SIGNAL GstObject::parent-set ##### -->
  44 <para>
  45 Is emitted when the parent of an object is set.
  46 </para>
  47
  48 @gstobject: the object which received the signal.
  49 @arg1: the new parent
  50
  51 <!-- ##### SIGNAL GstObject::parent-unset ##### -->
  52 <para>
  53 Is emitted when the parent of an object is unset.
  54 </para>
  55
  56 @gstobject: the object which received the signal.
  57 @arg1: the old parent
  58
  59 <!-- ##### ARG GstObject:name ##### -->
  60 <para>
  61 The name of the object
  62 </para>
  63
  64 <!-- ##### STRUCT GstObjectClass ##### -->
  65 <para>
  66
  67 </para>
  68
  69 @parent_class:
  70 @path_string_separator:
  71 @signal_object:
  72 @parent_set:
  73 @parent_unset:
  74 @object_saved:
  75 @deep_notify:
  76 @destroy:
  77 @save_thyself:
  78 @restore_thyself:
  79 @_gst_reserved:
  80
  81 <!-- ##### STRUCT GstPad ##### -->
  82 <para>
  83
  84 </para>
  85
  86
  87 <!-- ##### STRUCT GstPadClass ##### -->
  88 <para>
  89
  90 </para>
  91
  92 @parent_class:
  93 @_gst_reserved:
  94
  95 <!-- ##### STRUCT GstPadTemplate ##### -->
  96 <para>
  97 The padtemplate object.
  98 </para>
  99
 100
 101 <!-- ##### SIGNAL GstPadTemplate::pad-created ##### -->
 102 <para>
 103 This signal is fired when an element creates a pad from this
 104 template.
 105 </para>
 106
 107 @gstpadtemplate: the object which received the signal.
 108 @arg1: The pad that was created.
 109
 110 <!-- ##### STRUCT GstPadTemplateClass ##### -->
 111 <para>
 112
 113 </para>
 114
 115 @parent_class:
 116 @pad_created:
 117 @_gst_reserved:
 118
 119 <!-- ##### STRUCT GstElement ##### -->
 120 <para>
 121
 122 </para>
 123
 124
 125 <!-- ##### SIGNAL GstElement::eos ##### -->
 126 <para>
 127
 128 </para>
 129
 130 @:
 131
 132 <!-- ##### SIGNAL GstElement::error ##### -->
 133 <para>
 134
 135 </para>
 136
 137 @:
 138 @:
 139 @:
 140 @:
 141
 142 <!-- ##### SIGNAL GstElement::found-tag ##### -->
 143 <para>
 144
 145 </para>
 146
 147 @:
 148 @:
 149 @:
 150
 151 <!-- ##### SIGNAL GstElement::new-pad ##### -->
 152 <para>
 153
 154 </para>
 155
 156 @:
 157 @:
 158
 159 <!-- ##### SIGNAL GstElement::no-more-pads ##### -->
 160 <para>
 161
 162 </para>
 163
 164 @:
 165
 166 <!-- ##### SIGNAL GstElement::pad-removed ##### -->
 167 <para>
 168
 169 </para>
 170
 171 @:
 172 @:
 173
 174 <!-- ##### SIGNAL GstElement::state-change ##### -->
 175 <para>
 176
 177 </para>
 178
 179 @:
 180 @:
 181 @:
 182
 183 <!-- ##### STRUCT GstElementClass ##### -->
 184 <para>
 185
 186 </para>
 187
 188 @parent_class:
 189 @details:
 190 @elementfactory:
 191 @padtemplates:
 192 @numpadtemplates:
 193 @state_change:
 194 @new_pad:
 195 @pad_removed:
 196 @error:
 197 @eos:
 198 @found_tag:
 199 @set_property:
 200 @get_property:
 201 @release_locks:
 202 @get_event_masks:
 203 @send_event:
 204 @get_formats:
 205 @convert:
 206 @get_query_types:
 207 @query:
 208 @change_state:
 209 @request_new_pad:
 210 @release_pad:
 211 @get_clock:
 212 @set_clock:
 213 @get_index:
 214 @set_index:
 215 @set_state:
 216 @no_more_pads:
 217 @_gst_reserved:
 218
 219 <!-- ##### STRUCT GstBin ##### -->
 220 <para>
 221
 222 </para>
 223
 224
 225 <!-- ##### SIGNAL GstBin::element-added ##### -->
 226 <para>
 227
 228 </para>
 229
 230 @gstbin: the object which received the signal.
 231 @arg1: the element that was added to the bin
 232
 233 <!-- ##### SIGNAL GstBin::element-removed ##### -->
 234 <para>
 235
 236 </para>
 237
 238 @gstbin: the object which received the signal.
 239 @arg1: the element that was removed from the bin
 240
 241 <!-- ##### SIGNAL GstBin::iterate ##### -->
 242 <para>
 243 This signal is emitted when a bin iterates, either automatically or
 244 due to a #gst_bin_iterate() call.  The return value is used to
 245 determine if the object method handler processed any data.
 246 In most normal cases, a user-provided signal handler should return
 247 FALSE.
 248 </para>
 249
 250 @gstbin: the object which received the signal.
 251 @Returns: TRUE if the state of the bin was advanced.
 252
 253 <!-- ##### STRUCT GstBinClass ##### -->
 254 <para>
 255
 256 </para>
 257
 258 @parent_class:
 259 @add_element:
 260 @remove_element:
 261 @child_state_change:
 262 @iterate:
 263 @element_added:
 264 @element_removed:
 265 @_gst_reserved:
 266
 267 <!-- ##### STRUCT GstScheduler ##### -->
 268 <para>
 269
 270 </para>
 271
 272
 273 <!-- ##### STRUCT GstSchedulerClass ##### -->
 274 <para>
 275
 276 </para>
 277
 278 @parent_class:
 279 @setup:
 280 @reset:
 281 @add_element:
 282 @remove_element:
 283 @add_scheduler:
 284 @remove_scheduler:
 285 @state_transition:
 286 @scheduling_change:
 287 @lock_element:
 288 @unlock_element:
 289 @yield:
 290 @interrupt:
 291 @error:
 292 @pad_link:
 293 @pad_unlink:
 294 @pad_select:
 295 @clock_wait:
 296 @iterate:
 297 @show:
 298 @object_sync:
 299 @_gst_reserved:
 300
 301 <!-- ##### STRUCT GstEvent ##### -->
 302 <para>
 303
 304 </para>
 305
 306 @data:
 307 @type:
 308 @timestamp:
 309 @src:
 310
 311 <!-- ##### ENUM GstElementState ##### -->
 312 <para>
 313
 314 </para>
 315
 316 @GST_STATE_VOID_PENDING:
 317 @GST_STATE_NULL:
 318 @GST_STATE_READY:
 319 @GST_STATE_PAUSED:
 320 @GST_STATE_PLAYING:
 321
 322 <!-- ##### ENUM GstElementStateReturn ##### -->
 323 <para>
 324
 325 </para>
 326
 327 @GST_STATE_FAILURE:
 328 @GST_STATE_SUCCESS:
 329 @GST_STATE_ASYNC:
 330
 331 <!-- ##### ENUM GstResult ##### -->
 332 <para>
 333
 334 </para>
 335
 336 @GST_RESULT_OK:
 337 @GST_RESULT_NOK:
 338 @GST_RESULT_NOT_IMPL:
 339
 340 <!-- ##### MACRO GST_RANK_PRIMARY ##### -->
 341 <para>
 342
 343 </para>
 344
 345
 346
 347 <!-- ##### MACRO GST_RANK_SECONDARY ##### -->
 348 <para>
 349
 350 </para>
 351
 352
 353
 354 <!-- ##### MACRO GST_RANK_MARGINAL ##### -->
 355 <para>
 356
 357 </para>
 358
 359
 360
 361 <!-- ##### MACRO GST_RANK_NONE ##### -->
 362 <para>
 363
 364 </para>
 365
 366
 367
 368 <!-- ##### MACRO GST_PADDING ##### -->
 369 <para>
 370
 371 </para>
 372
 373
 374
 375 <!-- ##### MACRO GST_PADDING_INIT ##### -->
 376 <para>
 377
 378 </para>
 379
 380
 381