docs/gst/tmpl/gstclock.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GstClock
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Abstract class for global clocks
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9
  10 </para>
  11
  12 <!-- ##### SECTION See_Also ##### -->
  13 <para>
  14 #GstSystemClock
  15 </para>
  16
  17 <!-- ##### TYPEDEF GstClockTime ##### -->
  18 <para>
  19 A datatype to hold a time, measured in microseconds.
  20 </para>
  21
  22
  23 <!-- ##### TYPEDEF GstClockTimeDiff ##### -->
  24 <para>
  25 A datatype to hold a timedifference, measured in microseconds.
  26 </para>
  27
  28
  29 <!-- ##### USER_FUNCTION GstClockCallback ##### -->
  30 <para>
  31 The function prototype of the callback.
  32 </para>
  33
  34 @clock: The clock that triggered the callback
  35 @time: The time it was triggered
  36 @id: The id that expired
  37 @user_data: user data passed in the async_wait call
  38
  39
  40 <!-- ##### TYPEDEF GstClockID ##### -->
  41 <para>
  42 A detatype to hold the handle to an outstanding async clock callback
  43 </para>
  44
  45
  46 <!-- ##### ENUM GstClockReturn ##### -->
  47 <para>
  48 The return value of a clock operation.
  49 </para>
  50
  51 @GST_CLOCK_STOPPED: The clock is stopped.
  52 @GST_CLOCK_TIMEOUT: The operation timed out.
  53 @GST_CLOCK_EARLY: The operation was scheduled too late.
  54 @GST_CLOCK_ERROR: An error occured
  55
  56 <!-- ##### MACRO GST_CLOCK_DIFF ##### -->
  57 <para>
  58 Calculate a difference between to clock times.
  59 </para>
  60
  61 @s: the first time
  62 @e: the second time
  63
  64
  65 <!-- ##### MACRO GST_TIMEVAL_TO_TIME ##### -->
  66 <para>
  67 Convert a GTimeVal to a GstClockTime
  68 </para>
  69
  70 @tv: the timeval to convert
  71
  72
  73 <!-- ##### STRUCT GstClock ##### -->
  74 <para>
  75 The opaque data structure of the clock.
  76 </para>
  77
  78
  79 <!-- ##### FUNCTION gst_clock_activate ##### -->
  80 <para>
  81
  82 </para>
  83
  84 @clock:
  85 @active:
  86
  87
  88 <!-- ##### FUNCTION gst_clock_is_active ##### -->
  89 <para>
  90
  91 </para>
  92
  93 @clock:
  94 @Returns:
  95
  96
  97 <!-- ##### FUNCTION gst_clock_async_supported ##### -->
  98 <para>
  99
 100 </para>
 101
 102 @clock:
 103 @Returns:
 104
 105
 106 <!-- ##### FUNCTION gst_clock_wait_async ##### -->
 107 <para>
 108
 109 </para>
 110
 111 @clock:
 112 @time:
 113 @func:
 114 @user_data:
 115 @Returns:
 116
 117
 118 <!-- ##### FUNCTION gst_clock_cancel_wait_async ##### -->
 119 <para>
 120
 121 </para>
 122
 123 @clock:
 124 @id:
 125
 126
 127 <!-- ##### FUNCTION gst_clock_notify_async ##### -->
 128 <para>
 129
 130 </para>
 131
 132 @clock:
 133 @interval:
 134 @func:
 135 @user_data:
 136 @Returns:
 137
 138
 139 <!-- ##### FUNCTION gst_clock_remove_notify_async ##### -->
 140 <para>
 141
 142 </para>
 143
 144 @clock:
 145 @id:
 146
 147
 148 <!-- ##### FUNCTION gst_clock_unlock_id ##### -->
 149 <para>
 150
 151 </para>
 152
 153 @clock:
 154 @id:
 155
 156
 157 <!-- ##### FUNCTION gst_clock_wait_id ##### -->
 158 <para>
 159
 160 </para>
 161
 162 @clock:
 163 @id:
 164 @Returns:
 165
 166
 167 <!-- ##### FUNCTION gst_clock_get_next_id ##### -->
 168 <para>
 169
 170 </para>
 171
 172 @clock:
 173 @Returns:
 174
 175
 176 <!-- ##### FUNCTION gst_clock_get_time ##### -->
 177 <para>
 178
 179 </para>
 180
 181 @clock:
 182 @Returns:
 183
 184
 185 <!-- ##### FUNCTION gst_clock_id_get_time ##### -->
 186 <para>
 187
 188 </para>
 189
 190 @id:
 191 @Returns:
 192
 193
 194 <!-- ##### FUNCTION gst_clock_get_resolution ##### -->
 195 <para>
 196
 197 </para>
 198
 199 @clock:
 200 @Returns:
 201
 202
 203 <!-- ##### FUNCTION gst_clock_set_resolution ##### -->
 204 <para>
 205
 206 </para>
 207
 208 @clock:
 209 @resolution:
 210
 211
 212 <!-- ##### FUNCTION gst_clock_set_speed ##### -->
 213 <para>
 214
 215 </para>
 216
 217 @clock:
 218 @speed:
 219
 220
 221 <!-- ##### FUNCTION gst_clock_get_speed ##### -->
 222 <para>
 223
 224 </para>
 225
 226 @clock:
 227 @Returns:
 228 <!-- # Unused Parameters # -->
 229 @speed:
 230
 231
 232 <!-- ##### FUNCTION gst_clock_reset ##### -->
 233 <para>
 234
 235 </para>
 236
 237 @clock:
 238
 239
 240 <!-- ##### FUNCTION gst_clock_wait ##### -->
 241 <para>
 242
 243 </para>
 244
 245 @clock:
 246 @time:
 247 @Returns:
 248
 249