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_FILLER: a dummy element that should be ignored by plugins
  44
  45 <!-- ##### MACRO GST_EVENT_TYPE ##### -->
  46 <para>
  47 Get the event type.
  48 </para>
  49
  50 @event: The event to query.
  51
  52
  53 <!-- ##### MACRO GST_EVENT_SRC ##### -->
  54 <para>
  55 The source object that generated this event
  56 </para>
  57
  58 @event: The event to query
  59
  60
  61 <!-- ##### MACRO GST_EVENT_TIMESTAMP ##### -->
  62 <para>
  63 Get the timestamp of the event.
  64 </para>
  65
  66 @event: The event to query.
  67
  68
  69 <!-- ##### ENUM GstSeekType ##### -->
  70 <para>
  71 The different types of seek events.
  72 </para>
  73
  74 @GST_SEEK_METHOD_CUR: Seek to an relative position
  75 @GST_SEEK_METHOD_SET: Seek to an absolute position
  76 @GST_SEEK_METHOD_END: Seek relative to the end of the stream
  77 @GST_SEEK_FLAG_FLUSH: Flush any pending data while seeking
  78 @GST_SEEK_FLAG_ACCURATE: Seek as accuratly as possible
  79 @GST_SEEK_FLAG_KEY_UNIT: Seek to a nearby key unit
  80
  81 <!-- ##### ENUM GstSeekAccuracy ##### -->
  82 <para>
  83 The seekaccuracy gives more information of how the seek was performed,
  84 if the seek was accurate or fuzzy.
  85 </para>
  86
  87 @GST_SEEK_CERTAIN:
  88 @GST_SEEK_FUZZY:
  89
  90 <!-- ##### MACRO GST_EVENT_SEEK_TYPE ##### -->
  91 <para>
  92 Get the seektype of the GST_EVENT_SEEK.
  93 </para>
  94
  95 @event: The event to query.
  96
  97
  98 <!-- ##### MACRO GST_EVENT_SEEK_FORMAT ##### -->
  99 <para>
 100 The format of the seek value
 101 </para>
 102
 103 @event: The event operate on
 104
 105
 106 <!-- ##### MACRO GST_EVENT_SEEK_METHOD ##### -->
 107 <para>
 108 The seek method to use as one of #GstSeekType
 109 </para>
 110
 111 @event: The event operate on
 112
 113
 114 <!-- ##### MACRO GST_EVENT_SEEK_FLAGS ##### -->
 115 <para>
 116 The optional seek flags
 117 </para>
 118
 119 @event: The event operate on
 120
 121
 122 <!-- ##### MACRO GST_EVENT_SEEK_OFFSET ##### -->
 123 <para>
 124 Get the offset of the seek event.
 125 </para>
 126
 127 @event: The event to query.
 128
 129
 130 <!-- ##### MACRO GST_EVENT_SEEK_ACCURACY ##### -->
 131 <para>
 132 Indicates how accurate the event was performed.
 133 </para>
 134
 135 @event: The event to query
 136
 137
 138 <!-- ##### MACRO GST_SEEK_FLAGS_MASK ##### -->
 139 <para>
 140
 141 </para>
 142
 143
 144
 145 <!-- ##### MACRO GST_SEEK_FLAGS_SHIFT ##### -->
 146 <para>
 147
 148 </para>
 149
 150
 151
 152 <!-- ##### MACRO GST_SEEK_FORMAT_MASK ##### -->
 153 <para>
 154
 155 </para>
 156
 157
 158
 159 <!-- ##### MACRO GST_SEEK_FORMAT_SHIFT ##### -->
 160 <para>
 161
 162 </para>
 163
 164
 165
 166 <!-- ##### MACRO GST_SEEK_METHOD_MASK ##### -->
 167 <para>
 168
 169 </para>
 170
 171
 172
 173 <!-- ##### MACRO GST_SEEK_METHOD_SHIFT ##### -->
 174 <para>
 175
 176 </para>
 177
 178
 179
 180 <!-- ##### MACRO GST_EVENT_DISCONT_NEW_MEDIA ##### -->
 181 <para>
 182 Flag that indicates the discont event was because of a new media
 183 type.
 184 </para>
 185
 186 @event: The event to operate on
 187
 188
 189 <!-- ##### MACRO GST_EVENT_DISCONT_OFFSET ##### -->
 190 <para>
 191 The offset of the discont event. A discont evetn can hold up to 8 different
 192 format/value pairs.
 193 </para>
 194
 195 @event: The event to query
 196 @i: The offset/value pair.
 197
 198
 199 <!-- ##### MACRO GST_EVENT_DISCONT_OFFSET_LEN ##### -->
 200 <para>
 201 Get the number of offset/value pairs this event has.
 202 </para>
 203
 204 @event: The event to query.
 205
 206
 207 <!-- ##### STRUCT GstEvent ##### -->
 208 <para>
 209 The event data structure.
 210 </para>
 211
 212 @data: The parent data type.
 213 @type: The event type.
 214 @timestamp: The event timestamp.
 215 @src: The object that generated the event
 216
 217 <!-- ##### FUNCTION gst_event_new ##### -->
 218 <para>
 219
 220 </para>
 221
 222 @type:
 223 @Returns:
 224
 225
 226 <!-- ##### FUNCTION gst_event_copy ##### -->
 227 <para>
 228
 229 </para>
 230
 231 @event:
 232 @Returns:
 233
 234
 235 <!-- ##### FUNCTION gst_event_free ##### -->
 236 <para>
 237
 238 </para>
 239
 240 @event:
 241
 242
 243 <!-- ##### FUNCTION gst_event_new_seek ##### -->
 244 <para>
 245
 246 </para>
 247
 248 @type:
 249 @offset:
 250 @Returns:
 251
 252
 253 <!-- ##### FUNCTION gst_event_new_discontinuous ##### -->
 254 <para>
 255
 256 </para>
 257
 258 @new_media:
 259 @format1:
 260 @Varargs:
 261 @Returns:
 262
 263
 264 <!-- ##### FUNCTION gst_event_discont_get_value ##### -->
 265 <para>
 266
 267 </para>
 268
 269 @event:
 270 @format:
 271 @value:
 272 @Returns:
 273
 274
 275 <!-- ##### MACRO gst_event_new_filler ##### -->
 276 <para>
 277 Create a new dummy event that should be ignored
 278 </para>
 279
 280
 281
 282 <!-- ##### MACRO gst_event_new_flush ##### -->
 283 <para>
 284 Create a new flush event.
 285 </para>
 286
 287
 288