GstEvent
<!-- ##### SECTION Short_Description ##### -->
-Event definitions.
+Structure describing events that are passed up and down a pipeline
<!-- ##### SECTION Long_Description ##### -->
<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().
+The event should be unreferenced with gst_event_unref().
</para>
<para>
gst_event_new_seek() is a usually used to create a seek event and it takes the
<!-- ##### SECTION See_Also ##### -->
<para>
-#GstPad
+#GstPad, #GstElement
</para>
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### STRUCT GstEvent ##### -->
+<para>
+
+</para>
+
+@mini_object:
+@type:
+@timestamp:
+@src:
+@structure:
+
<!-- ##### ENUM GstEventType ##### -->
<para>
-The different major types of events.
+
+</para>
+
+@GST_EVENT_UNKNOWN:
+@GST_EVENT_FLUSH_START:
+@GST_EVENT_FLUSH_STOP:
+@GST_EVENT_EOS:
+@GST_EVENT_NEWSEGMENT:
+@GST_EVENT_TAG:
+@GST_EVENT_FILLER:
+@GST_EVENT_QOS:
+@GST_EVENT_SEEK:
+@GST_EVENT_NAVIGATION:
+@GST_EVENT_CUSTOM_UP:
+@GST_EVENT_CUSTOM_DS:
+@GST_EVENT_CUSTOM_DS_OOB:
+@GST_EVENT_CUSTOM_BOTH:
+@GST_EVENT_CUSTOM_BOTH_OOB:
+
+<!-- ##### MACRO GST_EVENT_TRACE_NAME ##### -->
+<para>
+The name used for memory allocation tracing
</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:
-@GST_EVENT_ERROR:
+
<!-- ##### MACRO GST_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
+
+
<!-- ##### ENUM GstSeekType ##### -->
<para>
-The different types of seek events.
+The different types of seek events. When constructing a seek event a format,
+a seek method and optional flags are OR-ed together. The seek event is then
+inserted into the graph with #gst_pad_send_event() or #gst_element_send_event().
+
+Following example illustrates how to insert a seek event (1 second in the stream)
+in a pipeline.
+<example>
+<title>Insertion of a seek event into a pipeline</title>
+ <programlisting>
+ gboolean res;
+ GstEvent *event;
+
+ event = gst_event_new_seek (
+ GST_FORMAT_TIME | /* seek on time */
+ GST_SEEK_METHOD_SET | /* set the absolute position */
+ GST_SEEK_FLAG_FLUSH, /* flush any pending data */
+ 1 * GST_SECOND); /* the seek offset (1 second) */
+
+ res = gst_element_send_event (GST_ELEMENT (osssink), event);
+ if (!res) {
+ g_warning ("seek failed");
+ }
+ </programlisting>
+</example>
</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
+@GST_SEEK_TYPE_NONE:
+@GST_SEEK_TYPE_CUR:
+@GST_SEEK_TYPE_SET:
+@GST_SEEK_TYPE_END:
-<!-- ##### MACRO GST_EVENT_SEEK_TYPE ##### -->
+<!-- ##### MACRO gst_event_ref ##### -->
<para>
-Get the seektype of the GST_EVENT_SEEK.
+Increase the refcount of this event
</para>
-@event: The event to query.
+@ev: The event to refcount
-<!-- ##### MACRO GST_EVENT_SEEK_OFFSET ##### -->
+<!-- ##### MACRO gst_event_unref ##### -->
<para>
-Get the offset of the seek event.
+Decrease the refcount of an event, freeing it if the refcount reaches 0
</para>
-@event: The event to query.
+@ev: The event to unref
-<!-- ##### MACRO GST_EVENT_SEEK_FLUSH ##### -->
+<!-- ##### MACRO gst_event_copy ##### -->
<para>
-Qeury wether the seek event also needs a flush.
+Copy the event using the event specific copy function
</para>
-@event: The event to query.
+@ev: The event to copy
+@Returns: A new event that is a copy of the given input event
-<!-- ##### STRUCT GstEvent ##### -->
+<!-- ##### FUNCTION gst_event_new_custom ##### -->
<para>
-The event data structure.
+
</para>
-@data: The parent data type.
-@type: The event type.
-@timestamp: The event timestamp.
-@src:
+@type:
+@structure:
+@Returns:
-<!-- ##### FUNCTION gst_event_new ##### -->
+
+<!-- ##### FUNCTION gst_event_get_structure ##### -->
+<para>
+
+</para>
+
+@event:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_event_new_flush_start ##### -->
+<para>
+
+</para>
+
+@Returns:
+
+
+<!-- ##### FUNCTION gst_event_new_flush_stop ##### -->
+<para>
+
+</para>
+
+@Returns:
+
+
+<!-- ##### FUNCTION gst_event_new_eos ##### -->
<para>
</para>
-@type:
@Returns:
-<!-- ##### FUNCTION gst_event_free ##### -->
+<!-- ##### FUNCTION gst_event_new_newsegment ##### -->
+<para>
+
+</para>
+
+@rate:
+@format:
+@start_value:
+@stop_value:
+@base:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_event_parse_newsegment ##### -->
+<para>
+
+</para>
+
+@event:
+@rate:
+@format:
+@start_value:
+@end_value:
+@base:
+
+
+<!-- ##### FUNCTION gst_event_new_tag ##### -->
+<para>
+
+</para>
+
+@taglist:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_event_parse_tag ##### -->
+<para>
+
+</para>
+
+@event:
+@taglist:
+
+
+<!-- ##### FUNCTION gst_event_new_filler ##### -->
+<para>
+Create a new dummy event that should be ignored
+</para>
+
+@Returns:
+
+
+<!-- ##### FUNCTION gst_event_new_qos ##### -->
+<para>
+
+</para>
+
+@proportion:
+@diff:
+@timestamp:
+@Returns:
+
+
+<!-- ##### FUNCTION gst_event_parse_qos ##### -->
<para>
</para>
@event:
+@proportion:
+@diff:
+@timestamp:
<!-- ##### FUNCTION gst_event_new_seek ##### -->
</para>
+@rate:
+@format:
+@flags:
+@cur_type:
+@cur:
+@stop_type:
+@stop:
+@Returns:
+<!-- # Unused Parameters # -->
@type:
@offset:
-@flush:
-@Returns:
-<!-- ##### MACRO gst_event_new_flush ##### -->
+<!-- ##### FUNCTION gst_event_parse_seek ##### -->
<para>
-Create a new flush event.
+
</para>
+@event:
+@rate:
+@format:
+@flags:
+@cur_type:
+@cur:
+@stop_type:
+@stop:
+
+
+<!-- ##### FUNCTION gst_event_new_navigation ##### -->
+<para>
+
+</para>
+
+@structure:
+@Returns:
projects / platform / upstream / gstreamer.git / blobdiff