From: Mark Nauwelaerts <mnauw@users.sourceforge.net>
Date: Mon, 22 Feb 2016 13:09:56 +0000 (+0100)
Subject: event: add some more documentation on stream-id
X-Git-Tag: 1.10.4~390
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=0f63073c23c89722251b96660c89fee0cb18e2f6;p=platform%2Fupstream%2Fgstreamer.git

event: add some more documentation on stream-id

... where it might end up being used for.
---

diff --git a/gst/gstevent.c b/gst/gstevent.c
index 7eb41d3..e0e0ea6 100644
--- a/gst/gstevent.c
+++ b/gst/gstevent.c
@@ -1460,7 +1460,10 @@ gst_event_parse_sink_message (GstEvent * event, GstMessage ** msg)
  * stream is split into (potentially) multiple new streams, e.g. in a demuxer,
  * but not for every single element in the pipeline.
  * gst_pad_create_stream_id() or gst_pad_create_stream_id_printf() can be
- * used to create a stream-id.
+ * used to create a stream-id.  There are no particular semantics for the
+ * stream-id, though it should be deterministic (to support stream matching)
+ * and it might be used to order streams (besides any information conveyed by
+ * stream flags).
  *
  * Returns: (transfer full): the new STREAM_START event.
  */