streams: Extend GstStreamType documentation

Users shouldn't assume it will be a single value since it's a flag.

streams: Extend GstStreamType documentation
Users shouldn't assume it will be a single value since it's a flag.
71a2bdea · Edward Hervey · Edward Hervey · 6c1bc80d · 71a2bdea
Commit 71a2bdea authored Oct 13, 2016 by Edward Hervey 🤘 Committed by Edward Hervey Oct 13, 2016
Hide whitespace changes
Inline Side-by-side

Showing with 4 additions and 0 deletions

gst/gststreams.h gst/gststreams.h +4 -0

No files found.
--- a/gst/gststreams.h
+++ b/gst/gststreams.h
@@ -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,