streams: Extend GstStreamType documentation

Users shouldn't assume it will be a single value since it's a flag.
This commit is contained in:
Edward Hervey 2016-10-13 12:03:20 +02:00 committed by Edward Hervey
parent 6c1bc80d27
commit 71a2bdeaf7

View file

@ -48,6 +48,10 @@ G_BEGIN_DECLS
*
* #GstStreamType describes a high level classification set for
* flows of data in #GstStream objects.
*
* Note that this is a flag, and therefore users should not assume it
* will be a single value. Do not use the equality operator for checking
* whether a stream is of a certain type.
*/
typedef enum {
GST_STREAM_TYPE_UNKNOWN = 1 << 0,