segment: small docs addition
authorTim-Philipp Müller <tim@centricular.com>
Sat, 4 Apr 2015 18:29:51 +0000 (19:29 +0100)
committerTim-Philipp Müller <tim@centricular.com>
Sat, 4 Apr 2015 18:32:27 +0000 (19:32 +0100)
https://bugzilla.gnome.org/show_bug.cgi?id=690564

gst/gstsegment.h

index dfe6ace..f0f7af5 100644 (file)
@@ -179,7 +179,8 @@ typedef enum { /*< flags >*/
  * @start: the start of the segment
  * @stop: the stop of the segment
  * @time: the stream time of the segment
- * @position: the position in the segment
+ * @position: the position in the segment (used internally by elements
+ *     such as sources, demuxers or parsers to track progress)
  * @duration: the duration of the segment
  *
  * A helper structure that holds the configured region of