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 <!-- ##### ENUM GstSchedulerFlags ##### -->
  24 <para>
  25 Flags for the scheduler
  26 </para>
  27
  28 @GST_SCHEDULER_FLAG_FIXED_CLOCK: the scheduler works with a fixed clock
  29 @GST_SCHEDULER_FLAG_NEW_API: the scheduler supports select and lock calls
  30 @GST_SCHEDULER_FLAG_LAST: subclasses can start numbering their flags starting
  31                           from here.
  32
  33 <!-- ##### MACRO GST_SCHEDULER_PARENT ##### -->
  34 <para>
  35 Get the parent object of this scheduler.
  36 </para>
  37
  38 @sched: the scheduler to get the parent of.
  39
  40
  41 <!-- ##### MACRO GST_SCHEDULER_STATE ##### -->
  42 <para>
  43 Get the state of the scheduler.
  44 </para>
  45
  46 @sched: the scheduler to get the state of.
  47
  48
  49 <!-- ##### ENUM GstSchedulerState ##### -->
  50 <para>
  51 The state of the scheduler
  52 </para>
  53
  54 @GST_SCHEDULER_STATE_NONE: no state
  55 @GST_SCHEDULER_STATE_RUNNING: the scheduler is running
  56 @GST_SCHEDULER_STATE_STOPPED: the scheduler is stopped
  57 @GST_SCHEDULER_STATE_ERROR: the scheduler is in error
  58
  59 <!-- ##### FUNCTION gst_scheduler_setup ##### -->
  60 <para>
  61
  62 </para>
  63
  64 @sched:
  65
  66
  67 <!-- ##### FUNCTION gst_scheduler_reset ##### -->
  68 <para>
  69
  70 </para>
  71
  72 @sched:
  73
  74
  75 <!-- ##### FUNCTION gst_scheduler_add_element ##### -->
  76 <para>
  77
  78 </para>
  79
  80 @sched:
  81 @element:
  82
  83
  84 <!-- ##### FUNCTION gst_scheduler_remove_element ##### -->
  85 <para>
  86
  87 </para>
  88
  89 @sched:
  90 @element:
  91
  92
  93 <!-- ##### FUNCTION gst_scheduler_add_scheduler ##### -->
  94 <para>
  95
  96 </para>
  97
  98 @sched:
  99 @sched2:
 100
 101
 102 <!-- ##### FUNCTION gst_scheduler_remove_scheduler ##### -->
 103 <para>
 104
 105 </para>
 106
 107 @sched:
 108 @sched2:
 109
 110
 111 <!-- ##### FUNCTION gst_scheduler_state_transition ##### -->
 112 <para>
 113
 114 </para>
 115
 116 @sched:
 117 @element:
 118 @transition:
 119 @Returns:
 120
 121
 122 <!-- ##### FUNCTION gst_scheduler_scheduling_change ##### -->
 123 <para>
 124
 125 </para>
 126
 127 @sched:
 128 @element:
 129
 130
 131 <!-- ##### FUNCTION gst_scheduler_lock_element ##### -->
 132 <para>
 133
 134 </para>
 135
 136 @sched:
 137 @element:
 138
 139
 140 <!-- ##### FUNCTION gst_scheduler_unlock_element ##### -->
 141 <para>
 142
 143 </para>
 144
 145 @sched:
 146 @element:
 147
 148
 149 <!-- ##### FUNCTION gst_scheduler_yield ##### -->
 150 <para>
 151
 152 </para>
 153
 154 @sched:
 155 @element:
 156 @Returns:
 157
 158
 159 <!-- ##### FUNCTION gst_scheduler_interrupt ##### -->
 160 <para>
 161
 162 </para>
 163
 164 @sched:
 165 @element:
 166 @Returns:
 167
 168
 169 <!-- ##### FUNCTION gst_scheduler_error ##### -->
 170 <para>
 171
 172 </para>
 173
 174 @sched:
 175 @element:
 176
 177
 178 <!-- ##### FUNCTION gst_scheduler_pad_link ##### -->
 179 <para>
 180
 181 </para>
 182
 183 @sched:
 184 @srcpad:
 185 @sinkpad:
 186
 187
 188 <!-- ##### FUNCTION gst_scheduler_pad_unlink ##### -->
 189 <para>
 190
 191 </para>
 192
 193 @sched:
 194 @srcpad:
 195 @sinkpad:
 196
 197
 198 <!-- ##### FUNCTION gst_scheduler_pad_select ##### -->
 199 <para>
 200
 201 </para>
 202
 203 @sched:
 204 @padlist:
 205 @Returns:
 206
 207
 208 <!-- ##### FUNCTION gst_scheduler_clock_wait ##### -->
 209 <para>
 210
 211 </para>
 212
 213 @sched:
 214 @element:
 215 @id:
 216 @jitter:
 217 @Returns:
 218 <!-- # Unused Parameters # -->
 219 @clock:
 220 @time:
 221
 222
 223 <!-- ##### FUNCTION gst_scheduler_iterate ##### -->
 224 <para>
 225
 226 </para>
 227
 228 @sched:
 229 @Returns:
 230
 231
 232 <!-- ##### FUNCTION gst_scheduler_use_clock ##### -->
 233 <para>
 234
 235 </para>
 236
 237 @sched:
 238 @clock:
 239
 240
 241 <!-- ##### FUNCTION gst_scheduler_set_clock ##### -->
 242 <para>
 243
 244 </para>
 245
 246 @sched:
 247 @clock:
 248
 249
 250 <!-- ##### FUNCTION gst_scheduler_get_clock ##### -->
 251 <para>
 252
 253 </para>
 254
 255 @sched:
 256 @Returns:
 257
 258
 259 <!-- ##### FUNCTION gst_scheduler_auto_clock ##### -->
 260 <para>
 261
 262 </para>
 263
 264 @sched:
 265
 266
 267 <!-- ##### FUNCTION gst_scheduler_show ##### -->
 268 <para>
 269
 270 </para>
 271
 272 @sched:
 273
 274
 275 <!-- ##### MACRO GST_SCHEDULER_DEFAULT_NAME ##### -->
 276 <para>
 277
 278 </para>
 279
 280
 281