[prev in list] [next in list] [prev in thread] [next in thread] 

List:       gstreamer-cvs
Subject:    gst-docs: design: streams: markup and readability fixes
From:       reynaldo () kemper ! freedesktop ! org (Reynaldo H !  Verdejo Pinochet)
Date:       2016-12-30 9:17:52
Message-ID: 20161230091752.5587C761F1 () kemper ! freedesktop ! org
[Download RAW message or body]

Module: gst-docs
Branch: master
Commit: 54a1f8e3288ca9c44f48b5096026a70d247f2ef8
URL:    http://cgit.freedesktop.org/gstreamer/gst-docs/commit/?id=54a1f8e3288ca9c44f48b5096026a70d247f2ef8


Author: Reynaldo H. Verdejo Pinochet <reynaldo@osg.samsung.com>
Date:   Fri Dec 30 00:24:42 2016 -0800

design: streams: markup and readability fixes

---

 markdown/design/streams.md | 32 ++++++++++++++++----------------
 1 file changed, 16 insertions(+), 16 deletions(-)

diff --git a/markdown/design/streams.md b/markdown/design/streams.md
index 24f4f87..4661a77 100644
--- a/markdown/design/streams.md
+++ b/markdown/design/streams.md
@@ -1,17 +1,17 @@
 # Streams
 
-    This document describes the objects that are passed from element to
-    element in the streaming thread.
+This document describes the objects that are passed from element to
+element in the streaming thread.
 
 ## Stream objects
 
 The following objects are to be expected in the streaming thread:
 
   - events
-  - STREAM_START (START)
-  - SEGMENT (SEGMENT)
-  - EOS * (EOS)
-  - TAG (T)
+  - `STREAM_START` (START)
+  - `SEGMENT` (SEGMENT)
+  - `EOS` * (EOS)
+  - `TAG` (T)
   - buffers * (B)
 
 Objects marked with * need to be synchronised to the clock in sinks and
@@ -37,19 +37,19 @@ more buffers are to be processed after the EOS event.
 
 2) **`SEGMENT`**, rate, start/stop, time
    - marks valid buffer timestamp range (start, stop)
-   - marks stream_time of buffers (time). This is the stream time of buffers
+   - marks `stream_time` of buffers (time). This is the stream time of buffers
      with a timestamp of S.start.
    - marks playback rate (rate). This is the required playback rate.
-   - marks applied rate (applied_rate). This is the already applied playback
+   - marks applied rate (`applied_rate`). This is the already applied playback
      rate. (See also [trickmodes](design/trickmodes.md))
-   - marks running_time of buffers. This is the time used to synchronize
+   - marks `running_time` of buffers. This is the time used to synchronize
      against the clock.
 
 3) **N buffers**
-   - displayable buffers are between start/stop of the SEGMENT (S). Buffers
+   - displayable buffers are between start/stop of the `SEGMENT` (S). Buffers
      outside the segment range should be dropped or clipped.
 
-   - running_time:
+   - `running_time`:
 
 ```
         if (S.rate > 0.0)
@@ -62,7 +62,7 @@ more buffers are to be processed after the EOS event.
     against the clock (See also
     [synchronisation](design/synchronisation.md)).
 
-  - stream_time:
+  - `stream_time`:
     *  current position in stream between 0 and duration.
 
 ```
@@ -71,12 +71,12 @@ more buffers are to be processed after the EOS event.
 
 
 4) **`EOS`**
-   - marks the end of data, nothing is to be expected after EOS, elements
-     should refuse more data and return GST_FLOW_EOS. A FLUSH_STOP
-     event clears the EOS state of an element.
+   - marks the end of data, nothing is to be expected after `EOS`, elements
+     should refuse more data and return `GST_FLOW_EOS`. A `FLUSH_STOP`
+     event clears the `EOS` state of an element.
 
 ## Elements
 
-These events are generated typically either by the GstBaseSrc class for
+These events are generated typically either by the `GstBaseSrc` class for
 sources operating in push mode, or by a parser/demuxer operating in
 pull-mode and pushing parsed/demuxed data downstream.

_______________________________________________
gstreamer-commits mailing list
gstreamer-commits@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/gstreamer-commits


[prev in list] [next in list] [prev in thread] [next in thread]