docs/gst/tmpl/gstscheduler.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GstScheduler
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 An abstract class for plugable schedulers.
   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 <!-- ##### MACRO GST_SCHEDULER_PARENT ##### -->
  18 <para>
  19 Get the parent object of this scheduler.
  20 </para>
  21
  22 @sched: the scheduler to get the parent of.
  23
  24
  25 <!-- ##### MACRO GST_SCHEDULER_STATE ##### -->
  26 <para>
  27 Get the state of the scheduler.
  28 </para>
  29
  30 @sched: the scheduler to get the state of.
  31
  32
  33 <!-- ##### ENUM GstSchedulerState ##### -->
  34 <para>
  35
  36 </para>
  37
  38 @GST_SCHEDULER_STATE_NONE:
  39 @GST_SCHEDULER_STATE_RUNNING:
  40 @GST_SCHEDULER_STATE_STOPPED:
  41 @GST_SCHEDULER_STATE_ERROR:
  42
  43 <!-- ##### ENUM GstSchedulerFlags ##### -->
  44 <para>
  45
  46 </para>
  47
  48 @GST_SCHEDULER_FLAG_FIXED_CLOCK:
  49 @GST_SCHEDULER_FLAG_LAST:
  50
  51 <!-- ##### MACRO gst_scheduler_destroy ##### -->
  52 <para>
  53 Destroy the scheduler
  54 </para>
  55
  56 @sched: The scheduler to destroy.
  57
  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_state_transition ##### -->
  94 <para>
  95
  96 </para>
  97
  98 @sched:
  99 @element:
 100 @transition:
 101 @Returns:
 102
 103
 104 <!-- ##### FUNCTION gst_scheduler_lock_element ##### -->
 105 <para>
 106
 107 </para>
 108
 109 @sched:
 110 @element:
 111
 112
 113 <!-- ##### FUNCTION gst_scheduler_unlock_element ##### -->
 114 <para>
 115
 116 </para>
 117
 118 @sched:
 119 @element:
 120
 121
 122 <!-- ##### FUNCTION gst_scheduler_yield ##### -->
 123 <para>
 124
 125 </para>
 126
 127 @sched:
 128 @element:
 129
 130
 131 <!-- ##### FUNCTION gst_scheduler_interrupt ##### -->
 132 <para>
 133
 134 </para>
 135
 136 @sched:
 137 @element:
 138 @Returns:
 139
 140
 141 <!-- ##### FUNCTION gst_scheduler_error ##### -->
 142 <para>
 143
 144 </para>
 145
 146 @sched:
 147 @element:
 148
 149
 150 <!-- ##### FUNCTION gst_scheduler_pad_connect ##### -->
 151 <para>
 152
 153 </para>
 154
 155 @sched:
 156 @srcpad:
 157 @sinkpad:
 158
 159
 160 <!-- ##### FUNCTION gst_scheduler_pad_disconnect ##### -->
 161 <para>
 162
 163 </para>
 164
 165 @sched:
 166 @srcpad:
 167 @sinkpad:
 168
 169
 170 <!-- ##### FUNCTION gst_scheduler_pad_select ##### -->
 171 <para>
 172
 173 </para>
 174
 175 @sched:
 176 @padlist:
 177 @Returns:
 178
 179
 180 <!-- ##### FUNCTION gst_scheduler_add_scheduler ##### -->
 181 <para>
 182
 183 </para>
 184
 185 @sched:
 186 @sched2:
 187
 188
 189 <!-- ##### FUNCTION gst_scheduler_remove_scheduler ##### -->
 190 <para>
 191
 192 </para>
 193
 194 @sched:
 195 @sched2:
 196
 197
 198 <!-- ##### FUNCTION gst_scheduler_auto_clock ##### -->
 199 <para>
 200
 201 </para>
 202
 203 @sched:
 204
 205
 206 <!-- ##### FUNCTION gst_scheduler_get_clock ##### -->
 207 <para>
 208
 209 </para>
 210
 211 @sched:
 212 @Returns:
 213
 214
 215 <!-- ##### FUNCTION gst_scheduler_set_clock ##### -->
 216 <para>
 217
 218 </para>
 219
 220 @sched:
 221 @clock:
 222
 223
 224 <!-- ##### FUNCTION gst_scheduler_use_clock ##### -->
 225 <para>
 226
 227 </para>
 228
 229 @sched:
 230 @clock:
 231
 232
 233 <!-- ##### FUNCTION gst_scheduler_clock_wait ##### -->
 234 <para>
 235
 236 </para>
 237
 238 @sched:
 239 @element:
 240 @clock:
 241 @time:
 242 @Returns:
 243
 244
 245 <!-- ##### FUNCTION gst_scheduler_iterate ##### -->
 246 <para>
 247
 248 </para>
 249
 250 @sched:
 251 @Returns:
 252
 253
 254 <!-- ##### FUNCTION gst_scheduler_show ##### -->
 255 <para>
 256
 257 </para>
 258
 259 @sched:
 260
 261