event: add some more documentation on stream-id

... where it might end up being used for.
This commit is contained in:
Mark Nauwelaerts 2016-02-22 14:09:56 +01:00
parent 7e5a892f89
commit 0f63073c23

View file

@ -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.
*/