gstreamer/docs/gst/tmpl/gstevent.sgml

<!-- ##### SECTION Title ##### -->
GstEvent

<!-- ##### SECTION Short_Description ##### -->
Event definitions.

<!-- ##### SECTION Long_Description ##### -->
<para>
The event classes are used to construct and query events.
</para>

<para>
Events are usually created with gst_event_new() which takes the event type as an argument.
properties specific to the event can be set afterwards with the provided macros. 
The event is freed with gst_event_free().
</para>
<para>
gst_event_new_seek() is a usually used to create a seek event and it takes the 
needed parameters for a seek event. 
</para>
<para>
gst_event_new_flush() creates a new flush event.
</para>

<!-- ##### SECTION See_Also ##### -->
<para>
#GstPad
</para>

<!-- ##### ENUM GstEventType ##### -->
<para>
The different major types of events.
</para>

@GST_EVENT_UNKNOWN: unknown event.
@GST_EVENT_EOS: an end-of-stream event.
@GST_EVENT_FLUSH: a flush event.
@GST_EVENT_EMPTY: an empty event.
@GST_EVENT_SEEK: a seek event.
@GST_EVENT_DISCONTINUOUS: a discontinuous event to indicate the stream has a discontinuity.
@GST_EVENT_INFO: an informational event
@GST_EVENT_ERROR: an error event

<!-- ##### MACRO GST_EVENT_TYPE ##### -->
<para>
Get the event type.
</para>

@event: The event to query.


<!-- ##### MACRO GST_EVENT_SRC ##### -->
<para>
The source object that generated this event
</para>

@event: The event to query


<!-- ##### MACRO GST_EVENT_TIMESTAMP ##### -->
<para>
Get the timestamp of the event.
</para>

@event: The event to query.


<!-- ##### ENUM GstSeekType ##### -->
<para>
The different types of seek events.
</para>

@GST_SEEK_ANY: the seek is performed anyway.
@GST_SEEK_TIMEOFFSET: this is a seek to specific timeoffset
@GST_SEEK_BYTEOFFSET: this is a seek to specific byteoffset

<!-- ##### MACRO GST_EVENT_SEEK_TYPE ##### -->
<para>
Get the seektype of the GST_EVENT_SEEK.
</para>

@event: The event to query.


<!-- ##### MACRO GST_EVENT_SEEK_OFFSET ##### -->
<para>
Get the offset of the seek event.
</para>

@event: The event to query.


<!-- ##### MACRO GST_EVENT_SEEK_FLUSH ##### -->
<para>
Qeury wether the seek event also needs a flush.
</para>

@event: The event to query.


<!-- ##### MACRO GST_EVENT_INFO_PROPS ##### -->
<para>
The properties of the info event
</para>

@event: The event to query


<!-- ##### STRUCT GstEvent ##### -->
<para>
The event data structure.
</para>

@data: The parent data type.
@type: The event type.
@timestamp: The event timestamp.
@src: 

<!-- ##### FUNCTION gst_event_new ##### -->
<para>

</para>

@type: 
@Returns: 


<!-- ##### FUNCTION gst_event_free ##### -->
<para>

</para>

@event: 


<!-- ##### FUNCTION gst_event_new_seek ##### -->
<para>

</para>

@type: 
@offset: 
@flush: 
@Returns: 


<!-- ##### MACRO gst_event_new_flush ##### -->
<para>
Create a new flush event.
</para>



<!-- ##### FUNCTION gst_event_new_info ##### -->
<para>

</para>

@firstname: 
@Varargs: 
@Returns: