diff options
Diffstat (limited to 'docs/design/part-events.txt')
| -rw-r--r-- | docs/design/part-events.txt | 26 |
1 files changed, 14 insertions, 12 deletions
diff --git a/docs/design/part-events.txt b/docs/design/part-events.txt index c029af308e..c2fd6506f6 100644 --- a/docs/design/part-events.txt +++ b/docs/design/part-events.txt @@ -27,7 +27,7 @@ Different types of events exist to implement various functionalities. in DVD. FLUSH_START/STOP ----------------- +~~~~~~~~~~~~~~~~ A flush event is sent both downstream and upstream to clear any pending data from the pipeline. This might be needed to make the graph more responsive @@ -65,7 +65,7 @@ base_time (see part-clocks.txt and part-synchronisation.txt). EOS ---- +~~~ The EOS event can only be sent on a sinkpad. It is typically emited by the source element when it has finished sending data. This event is mainly sent @@ -107,7 +107,7 @@ A FLUSH_STOP event on an element flushes the EOS state and all pending EOS messa NEWSEGMENT -------------- +~~~~~~~~~~ A newsegment event is sent downstream by an element to indicate that the following group of buffers start and end at the specified positions. The newsegment event @@ -146,7 +146,7 @@ make the buffer timestamps increasing (part-segments.txt). TAG ---- +~~~ The tag event is sent downstream when an element has discovered metadata tags in a media file. Encoders can use this event to adjust their tagging @@ -154,15 +154,17 @@ system. A tag is serialized with buffers. BUFFERSIZE ----------- +~~~~~~~~~~ + +NOTE: This event is not yet implemented. An element can suggest a buffersize for downstream elements. This is typically done by elements that produce data on multiple source pads -such as demuxers. This event is currently not yet defined nor used. +such as demuxers. QOS ---- +~~~ A QOS, or quality of service message, is generated in an element to report to the upstream elements about the current quality of real-time performance @@ -171,7 +173,7 @@ of framedrops they have. (see part-qos.txt) SEEK ----- +~~~~ A seek event is issued by the application to configure the playback range of a stream. It is called form the application thread and travels upstream. @@ -227,7 +229,7 @@ part-seeking.txt. NAVIGATION ----------- +~~~~~~~~~~~ A navigation event is generated by a sink element to signal the elements of a navigation event such as a mouse movement or button click. @@ -235,7 +237,7 @@ Navigation events travel upstream. LATENCY -------- +~~~~~~~ A latency event is used to configure a certain latency in the pipeline. It contains a single GstClockTime with the required latency. The latency value is @@ -246,9 +248,9 @@ timestamps of the buffer in order to delay their presentation. DRAIN ------ +~~~~~ -This event is not yet implemented. +NOTE: This event is not yet implemented. Drain event indicates that upstream is about to perform a real-time event, such as pausing to present an interactive menu or such, and needs to wait for all |