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