From ce51cad163f26eab1e90cb77ae6c6032f8b2c391 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Tim-Philipp=20M=C3=BCller?= <tim.muller@collabora.co.uk>
Date: Thu, 26 Mar 2009 19:34:23 +0000
Subject: [PATCH] docs: add a blurb about redirect messages to playbin2 docs

---
 gst/playback/gstplaybin2.c | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/gst/playback/gstplaybin2.c b/gst/playback/gstplaybin2.c
index 71c3e8e738..483e1eda3f 100644
--- a/gst/playback/gstplaybin2.c
+++ b/gst/playback/gstplaybin2.c
@@ -187,6 +187,16 @@
  * possible yet.
  * </refsect2>
  * <refsect2>
+ * <title>Handling redirects</title>
+ * <para>
+ * Some elements may post 'redirect' messages on the bus to tell the
+ * application to open another location. These are element messages containing
+ * a structure named 'redirect' along with a 'new-location' field of string
+ * type. The new location may be a relative or an absolute URI. Examples
+ * for such redirects can be found in many quicktime movie trailers.
+ * </para>
+ * </refsect2>
+ * <refsect2>
  * <title>Examples</title>
  * |[
  * gst-launch -v playbin uri=file:///path/to/somefile.avi