mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2025-02-25 07:26:29 +00:00
288 lines
4.8 KiB
Text
288 lines
4.8 KiB
Text
<!-- ##### 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_DISCONTINUOUS: a discontinuous event to indicate the stream has a discontinuity.
|
|
@GST_EVENT_NEW_MEDIA: a new media stream is started
|
|
@GST_EVENT_QOS: a quality of service event
|
|
@GST_EVENT_SEEK: a seek event.
|
|
@GST_EVENT_FILLER: a dummy element that should be ignored by plugins
|
|
|
|
<!-- ##### 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_METHOD_CUR: Seek to an relative position
|
|
@GST_SEEK_METHOD_SET: Seek to an absolute position
|
|
@GST_SEEK_METHOD_END: Seek relative to the end of the stream
|
|
@GST_SEEK_FLAG_FLUSH: Flush any pending data while seeking
|
|
@GST_SEEK_FLAG_ACCURATE: Seek as accuratly as possible
|
|
@GST_SEEK_FLAG_KEY_UNIT: Seek to a nearby key unit
|
|
|
|
<!-- ##### ENUM GstSeekAccuracy ##### -->
|
|
<para>
|
|
The seekaccuracy gives more information of how the seek was performed,
|
|
if the seek was accurate or fuzzy.
|
|
</para>
|
|
|
|
@GST_SEEK_CERTAIN:
|
|
@GST_SEEK_FUZZY:
|
|
|
|
<!-- ##### MACRO GST_EVENT_SEEK_TYPE ##### -->
|
|
<para>
|
|
Get the seektype of the GST_EVENT_SEEK.
|
|
</para>
|
|
|
|
@event: The event to query.
|
|
|
|
|
|
<!-- ##### MACRO GST_EVENT_SEEK_FORMAT ##### -->
|
|
<para>
|
|
The format of the seek value
|
|
</para>
|
|
|
|
@event: The event operate on
|
|
|
|
|
|
<!-- ##### MACRO GST_EVENT_SEEK_METHOD ##### -->
|
|
<para>
|
|
The seek method to use as one of #GstSeekType
|
|
</para>
|
|
|
|
@event: The event operate on
|
|
|
|
|
|
<!-- ##### MACRO GST_EVENT_SEEK_FLAGS ##### -->
|
|
<para>
|
|
The optional seek flags
|
|
</para>
|
|
|
|
@event: The event operate on
|
|
|
|
|
|
<!-- ##### MACRO GST_EVENT_SEEK_OFFSET ##### -->
|
|
<para>
|
|
Get the offset of the seek event.
|
|
</para>
|
|
|
|
@event: The event to query.
|
|
|
|
|
|
<!-- ##### MACRO GST_EVENT_SEEK_ACCURACY ##### -->
|
|
<para>
|
|
Indicates how accurate the event was performed.
|
|
</para>
|
|
|
|
@event: The event to query
|
|
|
|
|
|
<!-- ##### MACRO GST_SEEK_FLAGS_MASK ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### MACRO GST_SEEK_FLAGS_SHIFT ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### MACRO GST_SEEK_FORMAT_MASK ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### MACRO GST_SEEK_FORMAT_SHIFT ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### MACRO GST_SEEK_METHOD_MASK ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### MACRO GST_SEEK_METHOD_SHIFT ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### MACRO GST_EVENT_DISCONT_NEW_MEDIA ##### -->
|
|
<para>
|
|
Flag that indicates the discont event was because of a new media
|
|
type.
|
|
</para>
|
|
|
|
@event: The event to operate on
|
|
|
|
|
|
<!-- ##### MACRO GST_EVENT_DISCONT_OFFSET ##### -->
|
|
<para>
|
|
The offset of the discont event. A discont evetn can hold up to 8 different
|
|
format/value pairs.
|
|
</para>
|
|
|
|
@event: The event to query
|
|
@i: The offset/value pair.
|
|
|
|
|
|
<!-- ##### MACRO GST_EVENT_DISCONT_OFFSET_LEN ##### -->
|
|
<para>
|
|
Get the number of offset/value pairs this event has.
|
|
</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: The object that generated the event
|
|
|
|
<!-- ##### FUNCTION gst_event_new ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@type:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_event_copy ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@event:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_event_free ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@event:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_event_new_seek ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@type:
|
|
@offset:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_event_new_discontinuous ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@new_media:
|
|
@format1:
|
|
@Varargs:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_event_discont_get_value ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@event:
|
|
@format:
|
|
@value:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### MACRO gst_event_new_filler ##### -->
|
|
<para>
|
|
Create a new dummy event that should be ignored
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### MACRO gst_event_new_flush ##### -->
|
|
<para>
|
|
Create a new flush event.
|
|
</para>
|
|
|
|
|
|
|