aboutsummaryrefslogtreecommitdiffstats
path: root/libavformat/segment.c
diff options
context:
space:
mode:
authorStefano Sabatini <stefasab@gmail.com>2012-01-14 11:00:16 +0100
committerStefano Sabatini <stefasab@gmail.com>2012-07-03 21:48:50 +0200
commit77dcae5d74cdd6fba903752122fc77f423de6d3e (patch)
treeaf0572b03a82a872c4a98779c48a65053c78e837 /libavformat/segment.c
parenta5af29336ab4d483f122215482b74a2f0043d125 (diff)
downloadffmpeg-77dcae5d74cdd6fba903752122fc77f423de6d3e.tar.gz
lavf/segment: apply misc fixes to the private options internal documentation
Option help message tell what the option *does*, not what the set field represents.
Diffstat (limited to 'libavformat/segment.c')
-rw-r--r--libavformat/segment.c20
1 files changed, 10 insertions, 10 deletions
diff --git a/libavformat/segment.c b/libavformat/segment.c
index caa9a89844..f28e07efa3 100644
--- a/libavformat/segment.c
+++ b/libavformat/segment.c
@@ -34,11 +34,11 @@ typedef struct {
const AVClass *class; /**< Class for private options. */
int number;
AVFormatContext *avf;
- char *format; /**< Set by a private option. */
- char *list; /**< Set by a private option. */
- int list_size; /**< Set by a private option. */
- float time; /**< Set by a private option. */
- int wrap; /**< Set by a private option. */
+ char *format; ///< format to use for output segment files
+ char *list; ///< filename for the segment list file
+ int list_size; ///< number of entries for the segment list file
+ float time; ///< segment duration
+ int wrap; ///< number after which the index wraps
int64_t offset_time;
int64_t recording_time;
int has_video;
@@ -247,11 +247,11 @@ static int seg_write_trailer(struct AVFormatContext *s)
#define OFFSET(x) offsetof(SegmentContext, x)
#define E AV_OPT_FLAG_ENCODING_PARAM
static const AVOption options[] = {
- { "segment_format", "container format used for the segments", OFFSET(format), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
- { "segment_time", "segment length in seconds", OFFSET(time), AV_OPT_TYPE_FLOAT, {.dbl = 2}, 0, FLT_MAX, E },
- { "segment_list", "output the segment list", OFFSET(list), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
- { "segment_list_size", "maximum number of playlist entries", OFFSET(list_size), AV_OPT_TYPE_INT, {.dbl = 5}, 0, INT_MAX, E },
- { "segment_wrap", "number after which the index wraps", OFFSET(wrap), AV_OPT_TYPE_INT, {.dbl = 0}, 0, INT_MAX, E },
+ { "segment_format", "set container format used for the segments", OFFSET(format), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
+ { "segment_time", "set segment length in seconds", OFFSET(time), AV_OPT_TYPE_FLOAT, {.dbl = 2}, 0, FLT_MAX, E },
+ { "segment_list", "set the segment list filename", OFFSET(list), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
+ { "segment_list_size", "set the maximum number of playlist entries", OFFSET(list_size), AV_OPT_TYPE_INT, {.dbl = 5}, 0, INT_MAX, E },
+ { "segment_wrap", "set number after which the index wraps", OFFSET(wrap), AV_OPT_TYPE_INT, {.dbl = 0}, 0, INT_MAX, E },
{ NULL },
};