1 <!-- ##### SECTION Title ##### -->
4 <!-- ##### SECTION Short_Description ##### -->
7 <!-- ##### SECTION Long_Description ##### -->
9 The event classes are used to construct and query events.
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().
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.
22 gst_event_new_flush() creates a new flush event.
25 <!-- ##### SECTION See_Also ##### -->
30 <!-- ##### ENUM GstEventType ##### -->
32 The different major types of events.
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_SEEK: a seek event.
40 @GST_EVENT_DISCONTINUOUS: a discontinuous event to indicate the stream has a discontinuity.
41 @GST_EVENT_INFO: an informational event
42 @GST_EVENT_ERROR: an error event
44 <!-- ##### MACRO GST_EVENT_TYPE ##### -->
49 @event: The event to query.
52 <!-- ##### MACRO GST_EVENT_SRC ##### -->
54 The source object that generated this event
57 @event: The event to query
60 <!-- ##### MACRO GST_EVENT_TIMESTAMP ##### -->
62 Get the timestamp of the event.
65 @event: The event to query.
68 <!-- ##### ENUM GstSeekType ##### -->
70 The different types of seek events.
73 @GST_SEEK_ANY: the seek is performed anyway.
74 @GST_SEEK_TIMEOFFSET: this is a seek to specific timeoffset
75 @GST_SEEK_BYTEOFFSET: this is a seek to specific byteoffset
77 <!-- ##### MACRO GST_EVENT_SEEK_TYPE ##### -->
79 Get the seektype of the GST_EVENT_SEEK.
82 @event: The event to query.
85 <!-- ##### MACRO GST_EVENT_SEEK_OFFSET ##### -->
87 Get the offset of the seek event.
90 @event: The event to query.
93 <!-- ##### MACRO GST_EVENT_SEEK_FLUSH ##### -->
95 Qeury wether the seek event also needs a flush.
98 @event: The event to query.
101 <!-- ##### MACRO GST_EVENT_INFO_PROPS ##### -->
103 The properties of the info event
106 @event: The event to query
109 <!-- ##### STRUCT GstEvent ##### -->
111 The event data structure.
114 @data: The parent data type.
115 @type: The event type.
116 @timestamp: The event timestamp.
119 <!-- ##### FUNCTION gst_event_new ##### -->
128 <!-- ##### FUNCTION gst_event_free ##### -->
136 <!-- ##### FUNCTION gst_event_new_seek ##### -->
147 <!-- ##### MACRO gst_event_new_flush ##### -->
149 Create a new flush event.
154 <!-- ##### FUNCTION gst_event_new_info ##### -->