mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-08 18:39:54 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: add some more docs for the events

Browse source
This commit is contained in:
Wim Taymans 2010-04-15 17:11:46 +02:00
parent 4e3266345d
commit c13e225a17
1 changed files with 15 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
gst/gstevent.h
View file

@ -77,13 +77,19 @@ typedef enum {
/** /**
* GstEventType: * GstEventType:
* @GST_EVENT_UNKNOWN: unknown event. * @GST_EVENT_UNKNOWN: unknown event.
* @GST_EVENT_FLUSH_START: Start a flush operation * @GST_EVENT_FLUSH_START: Start a flush operation. This event clears all data
* @GST_EVENT_FLUSH_STOP: Stop a flush operation * from the pipeline and unblock all streaming threads.
* @GST_EVENT_FLUSH_STOP: Stop a flush operation. This event resets the
* running-time of the pipeline.
* @GST_EVENT_EOS: End-Of-Stream. No more data is to be expected to follow * @GST_EVENT_EOS: End-Of-Stream. No more data is to be expected to follow
* without a NEWSEGMENT event. * without a NEWSEGMENT event.
* @GST_EVENT_NEWSEGMENT: A new media segment follows in the dataflow. * @GST_EVENT_NEWSEGMENT: A new media segment follows in the dataflow. The
* segment events contains information for clipping buffers and
* converting buffer timestamps to running-time and
* stream-time.
* @GST_EVENT_TAG: A new set of metadata tags has been found in the stream. * @GST_EVENT_TAG: A new set of metadata tags has been found in the stream.
* @GST_EVENT_BUFFERSIZE: Notification of buffering requirements * @GST_EVENT_BUFFERSIZE: Notification of buffering requirements. Currently not
* used yet.
* @GST_EVENT_SINK_MESSAGE: An event that sinks turn into a message. Used to * @GST_EVENT_SINK_MESSAGE: An event that sinks turn into a message. Used to
* send messages that should be emitted in sync with * send messages that should be emitted in sync with
* rendering. * rendering.
@ -94,8 +100,11 @@ typedef enum {
* @GST_EVENT_NAVIGATION: Navigation events are usually used for communicating * @GST_EVENT_NAVIGATION: Navigation events are usually used for communicating
* user requests, such as mouse or keyboard movements, * user requests, such as mouse or keyboard movements,
* to upstream elements. * to upstream elements.
* @GST_EVENT_LATENCY: Notification of new latency adjustment. Since: 0.10.12 * @GST_EVENT_LATENCY: Notification of new latency adjustment. Sinks will use
* @GST_EVENT_STEP: A request for stepping through the media. Since: 0.10.24 * the latency information to adjust their synchronisation.
* Since: 0.10.12
* @GST_EVENT_STEP: A request for stepping through the media. Sinks will usually
* execute the step operation. Since: 0.10.24
* @GST_EVENT_CUSTOM_UPSTREAM: Upstream custom event * @GST_EVENT_CUSTOM_UPSTREAM: Upstream custom event
* @GST_EVENT_CUSTOM_DOWNSTREAM: Downstream custom event that travels in the * @GST_EVENT_CUSTOM_DOWNSTREAM: Downstream custom event that travels in the
* data flow. * data flow.