docs/gst/tmpl/gstscheduler.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GstScheduler
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Abstract class for objects that manage the scheduling of groups of elements
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 This is a base class for custom schedulers.
  10 </para>
  11
  12 <!-- ##### SECTION See_Also ##### -->
  13 <para>
  14
  15 </para>
  16
  17 <!-- ##### STRUCT GstScheduler ##### -->
  18 <para>
  19
  20 </para>
  21
  22
  23 <!-- ##### STRUCT GstSchedulerClass ##### -->
  24 <para>
  25
  26 </para>
  27
  28 @parent_class:
  29 @setup:
  30 @reset:
  31 @add_element:
  32 @remove_element:
  33 @add_scheduler:
  34 @remove_scheduler:
  35 @state_transition:
  36 @scheduling_change:
  37 @lock_element:
  38 @unlock_element:
  39 @yield:
  40 @interrupt:
  41 @error:
  42 @pad_link:
  43 @pad_unlink:
  44 @pad_select:
  45 @clock_wait:
  46 @iterate:
  47 @show:
  48 @object_sync:
  49 @_gst_reserved:
  50
  51 <!-- ##### ENUM GstSchedulerFlags ##### -->
  52 <para>
  53 Flags for the scheduler
  54 </para>
  55
  56 @GST_SCHEDULER_FLAG_FIXED_CLOCK: The scheduler has a fixed clock
  57 @GST_SCHEDULER_FLAG_NEW_API:
  58 @GST_SCHEDULER_FLAG_LAST: subclasses can start numbering their flags starting
  59                           from here.
  60
  61 <!-- ##### MACRO GST_SCHEDULER_PARENT ##### -->
  62 <para>
  63 Get the parent object of this scheduler.
  64 </para>
  65
  66 @sched: the scheduler to get the parent of.
  67
  68
  69 <!-- ##### MACRO GST_SCHEDULER_STATE ##### -->
  70 <para>
  71 Get the state of the scheduler.
  72 </para>
  73
  74 @sched: the scheduler to get the state of.
  75
  76
  77 <!-- ##### ENUM GstSchedulerState ##### -->
  78 <para>
  79 The state of the scheduler
  80 </para>
  81
  82 @GST_SCHEDULER_STATE_NONE: no state
  83 @GST_SCHEDULER_STATE_RUNNING: the scheduler is running
  84 @GST_SCHEDULER_STATE_STOPPED: the scheduler is stopped
  85 @GST_SCHEDULER_STATE_ERROR: the scheduler is in error
  86
  87 <!-- ##### FUNCTION gst_scheduler_setup ##### -->
  88 <para>
  89
  90 </para>
  91
  92 @sched:
  93
  94
  95 <!-- ##### FUNCTION gst_scheduler_reset ##### -->
  96 <para>
  97
  98 </para>
  99
 100 @sched:
 101
 102
 103 <!-- ##### FUNCTION gst_scheduler_add_element ##### -->
 104 <para>
 105
 106 </para>
 107
 108 @sched:
 109 @element:
 110
 111
 112 <!-- ##### FUNCTION gst_scheduler_remove_element ##### -->
 113 <para>
 114
 115 </para>
 116
 117 @sched:
 118 @element:
 119
 120
 121 <!-- ##### FUNCTION gst_scheduler_add_scheduler ##### -->
 122 <para>
 123
 124 </para>
 125
 126 @sched:
 127 @sched2:
 128
 129
 130 <!-- ##### FUNCTION gst_scheduler_remove_scheduler ##### -->
 131 <para>
 132
 133 </para>
 134
 135 @sched:
 136 @sched2:
 137
 138
 139 <!-- ##### FUNCTION gst_scheduler_state_transition ##### -->
 140 <para>
 141
 142 </para>
 143
 144 @sched:
 145 @element:
 146 @transition:
 147 @Returns:
 148
 149
 150 <!-- ##### FUNCTION gst_scheduler_scheduling_change ##### -->
 151 <para>
 152
 153 </para>
 154
 155 @sched:
 156 @element:
 157
 158
 159 <!-- ##### FUNCTION gst_scheduler_lock_element ##### -->
 160 <para>
 161
 162 </para>
 163
 164 @sched:
 165 @element:
 166
 167
 168 <!-- ##### FUNCTION gst_scheduler_unlock_element ##### -->
 169 <para>
 170
 171 </para>
 172
 173 @sched:
 174 @element:
 175
 176
 177 <!-- ##### FUNCTION gst_scheduler_yield ##### -->
 178 <para>
 179
 180 </para>
 181
 182 @sched:
 183 @element:
 184 @Returns:
 185
 186
 187 <!-- ##### FUNCTION gst_scheduler_interrupt ##### -->
 188 <para>
 189
 190 </para>
 191
 192 @sched:
 193 @element:
 194 @Returns:
 195
 196
 197 <!-- ##### FUNCTION gst_scheduler_error ##### -->
 198 <para>
 199
 200 </para>
 201
 202 @sched:
 203 @element:
 204
 205
 206 <!-- ##### FUNCTION gst_scheduler_pad_link ##### -->
 207 <para>
 208
 209 </para>
 210
 211 @sched:
 212 @srcpad:
 213 @sinkpad:
 214
 215
 216 <!-- ##### FUNCTION gst_scheduler_pad_unlink ##### -->
 217 <para>
 218
 219 </para>
 220
 221 @sched:
 222 @srcpad:
 223 @sinkpad:
 224
 225
 226 <!-- ##### FUNCTION gst_scheduler_pad_select ##### -->
 227 <para>
 228
 229 </para>
 230
 231 @sched:
 232 @padlist:
 233 @Returns:
 234
 235
 236 <!-- ##### FUNCTION gst_scheduler_clock_wait ##### -->
 237 <para>
 238
 239 </para>
 240
 241 @sched:
 242 @element:
 243 @id:
 244 @jitter:
 245 @Returns:
 246 <!-- # Unused Parameters # -->
 247 @clock:
 248 @time:
 249
 250
 251 <!-- ##### FUNCTION gst_scheduler_iterate ##### -->
 252 <para>
 253
 254 </para>
 255
 256 @sched:
 257 @Returns:
 258
 259
 260 <!-- ##### FUNCTION gst_scheduler_use_clock ##### -->
 261 <para>
 262
 263 </para>
 264
 265 @sched:
 266 @clock:
 267
 268
 269 <!-- ##### FUNCTION gst_scheduler_set_clock ##### -->
 270 <para>
 271
 272 </para>
 273
 274 @sched:
 275 @clock:
 276
 277
 278 <!-- ##### FUNCTION gst_scheduler_get_clock ##### -->
 279 <para>
 280
 281 </para>
 282
 283 @sched:
 284 @Returns:
 285
 286
 287 <!-- ##### FUNCTION gst_scheduler_auto_clock ##### -->
 288 <para>
 289
 290 </para>
 291
 292 @sched:
 293
 294
 295 <!-- ##### FUNCTION gst_scheduler_show ##### -->
 296 <para>
 297
 298 </para>
 299
 300 @sched:
 301
 302
 303 <!-- ##### MACRO GST_TYPE_SCHEDULER_FACTORY ##### -->
 304 <para>
 305
 306 </para>
 307
 308
 309
 310 <!-- ##### MACRO GST_SCHEDULER_FACTORY ##### -->
 311 <para>
 312
 313 </para>
 314
 315 @obj:
 316
 317
 318 <!-- ##### MACRO GST_IS_SCHEDULER_FACTORY ##### -->
 319 <para>
 320
 321 </para>
 322
 323 @obj:
 324
 325
 326 <!-- ##### MACRO GST_SCHEDULER_FACTORY_CLASS ##### -->
 327 <para>
 328
 329 </para>
 330
 331 @klass:
 332
 333
 334 <!-- ##### MACRO GST_IS_SCHEDULER_FACTORY_CLASS ##### -->
 335 <para>
 336
 337 </para>
 338
 339 @klass:
 340 <!-- # Unused Parameters # -->
 341 @obj:
 342
 343
 344 <!-- ##### MACRO GST_SCHEDULER_FACTORY_GET_CLASS ##### -->
 345 <para>
 346
 347 </para>
 348
 349 @obj:
 350
 351
 352 <!-- ##### MACRO GST_SCHEDULER_DEFAULT_NAME ##### -->
 353 <para>
 354
 355 </para>
 356
 357
 358
 359 <!-- ##### STRUCT GstSchedulerFactory ##### -->
 360 <para>
 361
 362 </para>
 363
 364
 365 <!-- ##### STRUCT GstSchedulerFactoryClass ##### -->
 366 <para>
 367
 368 </para>
 369
 370 @parent:
 371 @_gst_reserved:
 372
 373 <!-- ##### FUNCTION gst_scheduler_factory_get_type ##### -->
 374 <para>
 375
 376 </para>
 377
 378 @Returns:
 379
 380
 381 <!-- ##### FUNCTION gst_scheduler_factory_new ##### -->
 382 <para>
 383
 384 </para>
 385
 386 @name:
 387 @longdesc:
 388 @type:
 389 @Returns:
 390
 391
 392 <!-- ##### FUNCTION gst_scheduler_factory_destroy ##### -->
 393 <para>
 394
 395 </para>
 396
 397 @factory:
 398
 399
 400 <!-- ##### FUNCTION gst_scheduler_factory_find ##### -->
 401 <para>
 402
 403 </para>
 404
 405 @name:
 406 @Returns:
 407
 408
 409 <!-- ##### FUNCTION gst_scheduler_factory_create ##### -->
 410 <para>
 411
 412 </para>
 413
 414 @factory:
 415 @parent:
 416 @Returns:
 417
 418
 419 <!-- ##### FUNCTION gst_scheduler_factory_make ##### -->
 420 <para>
 421
 422 </para>
 423
 424 @name:
 425 @parent:
 426 @Returns:
 427
 428
 429 <!-- ##### FUNCTION gst_scheduler_factory_set_default_name ##### -->
 430 <para>
 431
 432 </para>
 433
 434 @name:
 435
 436
 437 <!-- ##### FUNCTION gst_scheduler_factory_get_default_name ##### -->
 438 <para>
 439
 440 </para>
 441
 442 @Returns:
 443
 444