Merge remote-tracking branch 'origin/0.10'

[platform/upstream/gstreamer.git] / docs / design / part-latency.txt

diff --git a/docs/design/part-latency.txt b/docs/design/part-latency.txt
index 464e3a0..315c756 100644 (file)
--- a/docs/design/part-latency.txt
+++ b/docs/design/part-latency.txt
@@ -95,7 +95,7 @@ capture pipelines.
   * the sink will receive the buffer with timestamp 0 at time >= D. At this
     point the buffer is too late already and might be dropped. This state of
     constantly dropping data will not change unless a constant latency
-    correction is added to the incomming buffer timestamps.
+    correction is added to the incoming buffer timestamps.
 
   The problem is due to the fact that the sink is set to (pending) PLAYING
   without being prerolled, which only happens in live pipelines. 
@@ -220,6 +220,31 @@ separate async state change thread (like the one currently used for going from
 PAUSED->PLAYING in a non-live pipeline).
 
 
+Query
+~~~~~
+
+The pipeline latency is queried with the LATENCY query.
+
+ (out) "live", G_TYPE_BOOLEAN (default FALSE)
+        - if a live element is found upstream
+
+ (out) "min-latency", G_TYPE_UINT64 (default 0)
+        - the minimum latency in the pipeline
+
+ (out) "max-latency", G_TYPE_UINT64 (default 0)
+        - the maximum latency in the pipeline
+
+
+Event
+~~~~~
+
+The latency in the pipeline is configured with the LATENCY event, which contains
+the following fields:
+
+      "latency", G_TYPE_UINT64
+        - the configured latency in the pipeline
+
+
 Latency compensation
 ~~~~~~~~~~~~~~~~~~~~