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