summaryrefslogtreecommitdiff
path: root/docs/design/part-events.txt
diff options
context:
space:
mode:
authorJan Schmidt <thaytan@mad.scientist.com>2006-01-18 18:05:43 +0000
committerJan Schmidt <thaytan@mad.scientist.com>2006-01-18 18:05:43 +0000
commit483c800475f91cd3862862b80bb9cd7853d7c2a9 (patch)
tree7d404496dfefd8c879484cc8cdfefb49d7bf1106 /docs/design/part-events.txt
parentc33121174bfcf212291c1ed70bc81cb5d9290e0b (diff)
docs/design/part-events.txt: Remove mention of FILLER events.
Original commit message from CVS: * docs/design/part-events.txt: Remove mention of FILLER events. Add DRAIN event. * docs/design/part-sparsestreams.txt: Write some things about using NEWSEGMENT to keep sparse streams flowing.
Diffstat (limited to 'docs/design/part-events.txt')
-rw-r--r--docs/design/part-events.txt20
1 files changed, 15 insertions, 5 deletions
diff --git a/docs/design/part-events.txt b/docs/design/part-events.txt
index 6bf31ec1df..a03bdb7cb1 100644
--- a/docs/design/part-events.txt
+++ b/docs/design/part-events.txt
@@ -15,11 +15,11 @@ Different types of events exist to implement various functionalities.
GST_EVENT_EOS: no more data is to be expected on a pad.
GST_EVENT_NEWSEGMENT: A new group of buffers with common start time
GST_EVENT_TAG: Stream metadata.
- GST_EVENT_FILLER: Filler for sparse data streams
GST_EVENT_BUFFERSIZE: Buffer size requirements
GST_EVENT_QOS: A notification of the quality of service of the stream
GST_EVENT_SEEK: A seek should be performed to a new position in the stream
GST_EVENT_NAVIGATION: A navigation event.
+ GST_EVENT_DRAIN: Play all data downstream before returning.
FLUSH_START/STOP
@@ -142,10 +142,6 @@ tags in a media file. Encoders can use this event to adjust their tagging
system. A tag is serialized with buffers.
-FILLER
-------
-
-
BUFFERSIZE
----------
@@ -226,3 +222,17 @@ of a navigation event such as a mouse movement or button click.
Navigation events travel upstream.
+DRAIN
+-----
+
+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
+data it has sent to be played-out in the sink.
+
+Drain should only be used by live elements, as it may otherwise occur during
+prerolling.
+
+Usually after draining the pipeline, an element either needs to modify timestamps,
+or FLUSH to prevent subsequent data being discarded at the sinks for arriving
+late (only applies during playback scenarios).
+