summaryrefslogtreecommitdiff
path: root/pwg-advanced-events.md
diff options
context:
space:
mode:
authorThibault Saunier <tsaunier@gnome.org>2016-06-17 18:41:07 -0400
committerThibault Saunier <tsaunier@gnome.org>2016-06-17 18:42:07 -0400
commit1c926934ab2873ddf909dfa0ae894c34666ea114 (patch)
treeaba4eaea37301e9fec7b88c6ccaaaa8992ea5bfd /pwg-advanced-events.md
parent208c456f816bb2782cc5c47c5024e88479287c0c (diff)
Avoid having several 'h1' title per page
Each page has one title and it looks better like that
Diffstat (limited to 'pwg-advanced-events.md')
-rw-r--r--pwg-advanced-events.md30
1 files changed, 15 insertions, 15 deletions
diff --git a/pwg-advanced-events.md b/pwg-advanced-events.md
index ea5666c..9f1d528 100644
--- a/pwg-advanced-events.md
+++ b/pwg-advanced-events.md
@@ -11,7 +11,7 @@ pipeline is not handling them correctly the whole event system of the
pipeline is broken. We will try to explain here how these methods work
and how elements are supposed to implement them.
-# Downstream events
+## Downstream events
Downstream events are received through the sink pad's event handler, as
set using `gst_pad_set_event_function ()` when the pad was created.
@@ -76,7 +76,7 @@ decoders with an id3demux or apedemux element in front of them, or
demuxers that are being fed input from sources that send additional
information about the stream in custom events, as DVD sources do).
-# Upstream events
+## Upstream events
Upstream events are generated by an element somewhere downstream in the
pipeline (example: a video sink may generate navigation events that
@@ -127,7 +127,7 @@ handling. Here they are :
thread than the streaming thread, so make sure you use appropriate
locking everywhere.
-# All Events Together
+## All Events Together
In this chapter follows a list of all defined events that are currently
being used, plus how they should be used/interpreted. You can check the
@@ -165,17 +165,17 @@ For more comprehensive information about events and how they should be
used correctly in various circumstances please consult the GStreamer
design documentation. This section only gives a general overview.
-## Stream Start
+### Stream Start
WRITEME
-## Caps
+### Caps
The CAPS event contains the format description of the following buffers.
See [Caps negotiation](pwg-negotiation.md) for more information
about negotiation.
-## Segment
+### Segment
A segment event is sent downstream to announce the range of valid
timestamps in the stream and how they should be transformed into
@@ -209,7 +209,7 @@ extract the event details. Elements may find the GstSegment API useful
to keep track of the current segment (if they want to use it for output
clipping, for example).
-## Tag (metadata)
+### Tag (metadata)
Tagging events are being sent downstream to indicate the tags as parsed
from the stream data. This is currently used to preserve tags during
@@ -227,7 +227,7 @@ ownership of.
Elements parsing this event can use the function `gst_event_parse_tag
()` to acquire the taglist that the event contains.
-## End of Stream (EOS)
+### End of Stream (EOS)
End-of-stream events are sent if the stream that an element sends out is
finished. An element receiving this event (from upstream, so it receives
@@ -256,15 +256,15 @@ not need to ever manually send an EOS event, you should also just return
GST\_FLOW\_EOS in your create or fill function (assuming your element
derives from GstBaseSrc or GstPushSrc).
-## Table Of Contents
+### Table Of Contents
WRITEME
-## Gap
+### Gap
WRITEME
-## Flush Start
+### Flush Start
The flush start event is sent downstream (in push mode) or upstream (in
pull mode) if all buffers and caches in the pipeline should be emptied.
@@ -287,7 +287,7 @@ The flush-start event is created with the `gst_event_new_flush_start
only created by elements driving the pipeline, like source elements
operating in push-mode or pull-range based demuxers/decoders.
-## Flush Stop
+### Flush Stop
The flush-stop event is sent by an element driving the pipeline after a
flush-start and tells pads and elements downstream that they should
@@ -303,13 +303,13 @@ has one parameter that controls if the running-time of the pipeline
should be reset to 0 or not. Normally after a flushing seek, the
running\_time is set back to 0.
-## Quality Of Service (QOS)
+### Quality Of Service (QOS)
The QOS event contains a report about the current real-time performance
of the stream. See more info in [Quality Of Service
(QoS)](pwg-advanced-qos.md).
-## Seek Request
+### Seek Request
Seek events are meant to request a new stream position to elements. This
new position can be set in several formats (time, bytes or “default
@@ -335,7 +335,7 @@ it should operate based on the SEGMENT events it receives.
Elements parsing this event can do this using `gst_event_parse_seek()`.
-## Navigation
+### Navigation
Navigation events are sent upstream by video sinks to inform upstream
elements of where the mouse pointer is, if and where mouse pointer