docs/gst/tmpl/gstevent.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GstEvent
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Event definitions.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 The event classes are used to construct and query events.
  10 </para>
  11
  12 <para>
  13 Events are usually created with gst_event_new() which takes the event type as an argument.
  14 properties specific to the event can be set afterwards with the provided macros.
  15 The event should be unreferenced with gst_event_unref().
  16 </para>
  17 <para>
  18 gst_event_new_seek() is a usually used to create a seek event and it takes the
  19 needed parameters for a seek event.
  20 </para>
  21 <para>
  22 gst_event_new_flush() creates a new flush event.
  23 </para>
  24
  25 <!-- ##### SECTION See_Also ##### -->
  26 <para>
  27 #GstPad
  28 </para>
  29
  30 <!-- ##### ENUM GstEventType ##### -->
  31 <para>
  32 The different major types of events.
  33 </para>
  34
  35 @GST_EVENT_UNKNOWN: unknown event.
  36 @GST_EVENT_EOS: an end-of-stream event.
  37 @GST_EVENT_FLUSH: a flush event.
  38 @GST_EVENT_EMPTY: an empty event.
  39 @GST_EVENT_DISCONTINUOUS: a discontinuous event to indicate the stream has a discontinuity.
  40 @GST_EVENT_NEW_MEDIA: a new media stream is started
  41 @GST_EVENT_QOS: a quality of service event
  42 @GST_EVENT_SEEK: a seek event.
  43 @GST_EVENT_SEEK_SEGMENT: a segment seek with start and stop position
  44 @GST_EVENT_SEGMENT_DONE: the event that will be emited when the segment seek has ended
  45 @GST_EVENT_SIZE: a size suggestion for a peer element
  46 @GST_EVENT_RATE: adjust the output rate of an element
  47 @GST_EVENT_FILLER: a dummy element that should be ignored by plugins
  48 @GST_EVENT_TS_OFFSET:
  49
  50 <!-- ##### MACRO GST_EVENT_TYPE ##### -->
  51 <para>
  52 Get the event type.
  53 </para>
  54
  55 @event: The event to query.
  56
  57
  58 <!-- ##### MACRO GST_EVENT_SRC ##### -->
  59 <para>
  60 The source object that generated this event
  61 </para>
  62
  63 @event: The event to query
  64
  65
  66 <!-- ##### MACRO GST_EVENT_TIMESTAMP ##### -->
  67 <para>
  68 Get the timestamp of the event.
  69 </para>
  70
  71 @event: The event to query.
  72
  73
  74 <!-- ##### ENUM GstSeekType ##### -->
  75 <para>
  76 The different types of seek events.
  77 </para>
  78
  79 @GST_SEEK_METHOD_CUR: Seek to an relative position
  80 @GST_SEEK_METHOD_SET: Seek to an absolute position
  81 @GST_SEEK_METHOD_END: Seek relative to the end of the stream
  82 @GST_SEEK_FLAG_FLUSH: Flush any pending data while seeking
  83 @GST_SEEK_FLAG_ACCURATE: Seek as accuratly as possible
  84 @GST_SEEK_FLAG_KEY_UNIT: Seek to a nearby key unit
  85 @GST_SEEK_FLAG_SEGMENT_LOOP: Loop between start and stop in a segmented seek
  86
  87 <!-- ##### ENUM GstSeekAccuracy ##### -->
  88 <para>
  89 The seekaccuracy gives more information of how the seek was performed,
  90 if the seek was accurate or fuzzy.
  91 </para>
  92
  93 @GST_SEEK_CERTAIN: The seek was exact
  94 @GST_SEEK_FUZZY: The seek was fuzzy, exact position can not be guaranteed
  95
  96 <!-- ##### MACRO GST_EVENT_SEEK_TYPE ##### -->
  97 <para>
  98 Get the seektype of the GST_EVENT_SEEK.
  99 </para>
 100
 101 @event: The event to query.
 102
 103
 104 <!-- ##### MACRO GST_EVENT_SEEK_FORMAT ##### -->
 105 <para>
 106 The format of the seek value
 107 </para>
 108
 109 @event: The event operate on
 110
 111
 112 <!-- ##### MACRO GST_EVENT_SEEK_METHOD ##### -->
 113 <para>
 114 The seek method to use as one of #GstSeekType
 115 </para>
 116
 117 @event: The event operate on
 118
 119
 120 <!-- ##### MACRO GST_EVENT_SEEK_FLAGS ##### -->
 121 <para>
 122 The optional seek flags
 123 </para>
 124
 125 @event: The event operate on
 126
 127
 128 <!-- ##### MACRO GST_EVENT_SEEK_OFFSET ##### -->
 129 <para>
 130 Get the offset of the seek event.
 131 </para>
 132
 133 @event: The event to query.
 134
 135
 136 <!-- ##### MACRO GST_EVENT_SEEK_ACCURACY ##### -->
 137 <para>
 138 Indicates how accurate the event was performed.
 139 </para>
 140
 141 @event: The event to query
 142
 143
 144 <!-- ##### MACRO GST_SEEK_FLAGS_MASK ##### -->
 145 <para>
 146 Mask for the flags in the GstSeekType
 147 </para>
 148
 149
 150
 151 <!-- ##### MACRO GST_SEEK_FLAGS_SHIFT ##### -->
 152 <para>
 153 Shift for the flags in the GstSeekType
 154 </para>
 155
 156
 157
 158 <!-- ##### MACRO GST_SEEK_FORMAT_MASK ##### -->
 159 <para>
 160 Mask for the format in the GstSeekType
 161 </para>
 162
 163
 164
 165 <!-- ##### MACRO GST_SEEK_FORMAT_SHIFT ##### -->
 166 <para>
 167 Shift for the format in the GstSeekType
 168 </para>
 169
 170
 171
 172 <!-- ##### MACRO GST_SEEK_METHOD_MASK ##### -->
 173 <para>
 174 Mask for the method in the GstSeekType
 175 </para>
 176
 177
 178
 179 <!-- ##### MACRO GST_SEEK_METHOD_SHIFT ##### -->
 180 <para>
 181 Shift for the method in the GstSeekType
 182 </para>
 183
 184
 185
 186 <!-- ##### MACRO GST_EVENT_DISCONT_NEW_MEDIA ##### -->
 187 <para>
 188 Flag that indicates the discont event was because of a new media
 189 type.
 190 </para>
 191
 192 @event: The event to operate on
 193
 194
 195 <!-- ##### MACRO GST_EVENT_DISCONT_OFFSET ##### -->
 196 <para>
 197 The offset of the discont event. A discont evetn can hold up to 8 different
 198 format/value pairs.
 199 </para>
 200
 201 @event: The event to query
 202 @i: The offset/value pair.
 203
 204
 205 <!-- ##### MACRO GST_EVENT_DISCONT_OFFSET_LEN ##### -->
 206 <para>
 207 Get the number of offset/value pairs this event has.
 208 </para>
 209
 210 @event: The event to query.
 211
 212
 213 <!-- ##### MACRO GST_EVENT_RATE_VALUE ##### -->
 214 <para>
 215 Get access to the rate vale field
 216 </para>
 217
 218 @event: The event to query
 219
 220
 221 <!-- ##### MACRO GST_EVENT_SEEK_ENDOFFSET ##### -->
 222 <para>
 223 The event stop position for a segment seek
 224 </para>
 225
 226 @event: The event to query
 227
 228
 229 <!-- ##### MACRO GST_EVENT_SIZE_FORMAT ##### -->
 230 <para>
 231 The format of the size event.
 232 </para>
 233
 234 @event: The event to query
 235
 236
 237 <!-- ##### MACRO GST_EVENT_SIZE_VALUE ##### -->
 238 <para>
 239 The value of the size event
 240 </para>
 241
 242 @event: The event to query
 243
 244
 245 <!-- ##### STRUCT GstEvent ##### -->
 246 <para>
 247
 248 </para>
 249
 250 @data:
 251 @type:
 252 @timestamp:
 253 @src:
 254
 255 <!-- ##### FUNCTION gst_event_new ##### -->
 256 <para>
 257
 258 </para>
 259
 260 @type:
 261 @Returns:
 262
 263
 264 <!-- ##### MACRO gst_event_copy ##### -->
 265 <para>
 266 Copy the event using the event specific copy function
 267 </para>
 268
 269 @ev: The event to copy
 270 @Returns: A new event that is a copy of the given input event
 271
 272
 273 <!-- ##### MACRO gst_event_ref ##### -->
 274 <para>
 275 Increase the refcount of this event
 276 </para>
 277
 278 @ev: The event to refcount
 279
 280
 281 <!-- ##### MACRO gst_event_ref_by_count ##### -->
 282 <para>
 283 Increase the refcount of the event with the given value
 284 </para>
 285
 286 @ev: The event to refcount
 287 @c: The value to add to the refcount
 288
 289
 290 <!-- ##### MACRO gst_event_unref ##### -->
 291 <para>
 292 Decrease the refcount of an event, freeing it if the refcount reaches 0
 293 </para>
 294
 295 @ev: The event to unref
 296
 297
 298 <!-- ##### FUNCTION gst_event_new_seek ##### -->
 299 <para>
 300
 301 </para>
 302
 303 @type:
 304 @offset:
 305 @Returns:
 306
 307
 308 <!-- ##### FUNCTION gst_event_new_segment_seek ##### -->
 309 <para>
 310
 311 </para>
 312
 313 @type:
 314 @start:
 315 @stop:
 316 @Returns:
 317
 318
 319 <!-- ##### FUNCTION gst_event_new_size ##### -->
 320 <para>
 321
 322 </para>
 323
 324 @format:
 325 @value:
 326 @Returns:
 327
 328
 329 <!-- ##### FUNCTION gst_event_new_discontinuous ##### -->
 330 <para>
 331
 332 </para>
 333
 334 @new_media:
 335 @format1:
 336 @Varargs:
 337 @Returns:
 338
 339
 340 <!-- ##### FUNCTION gst_event_discont_get_value ##### -->
 341 <para>
 342
 343 </para>
 344
 345 @event:
 346 @format:
 347 @value:
 348 @Returns:
 349
 350
 351 <!-- ##### MACRO gst_event_new_filler ##### -->
 352 <para>
 353 Create a new dummy event that should be ignored
 354 </para>
 355
 356
 357
 358 <!-- ##### MACRO gst_event_new_flush ##### -->
 359 <para>
 360 Create a new flush event.
 361 </para>
 362
 363
 364
 365 <!-- ##### FUNCTION gst_event_print_stats ##### -->
 366 <para>
 367
 368 </para>
 369
 370
 371