[gst-cvs] gstreamer: docs: clarify the NOMINAL_BITRATE docs

[<en...@ke...>]

Module: gstreamer
Branch: master
Commit: 306c09e1b20f6f0226ceb3b9fca19f4b1dd3ffdf
URL:    http://cgit.freedesktop.org/gstreamer/gstreamer/commit/?id=306c09e1b20f6f0226ceb3b9fca19f4b1dd3ffdf

Author: Stefan Kost <en...@us...>
Date:   Wed Feb  9 15:23:13 2011 +0200

docs: clarify the NOMINAL_BITRATE docs

Tell that its a target bitrate and actual values might be different.

---

 gst/gsttaglist.h |    3 ++-
 1 files changed, 2 insertions(+), 1 deletions(-)

diff --git a/gst/gsttaglist.h b/gst/gsttaglist.h
index f4bef9c..f9be499 100644
--- a/gst/gsttaglist.h
+++ b/gst/gsttaglist.h
@@ -667,7 +667,8 @@ gboolean     gst_tag_list_get_buffer_index  (const GstTagList * list,
 /**
  * GST_TAG_NOMINAL_BITRATE:
  *
- * nominal bitrate in bits/s (unsigned integer)
+ * nominal bitrate in bits/s (unsigned integer). The actual bitrate might be
+ * different from this target bitrate.
  */
 #define GST_TAG_NOMINAL_BITRATE        "nominal-bitrate"
 /**