[FFmpeg-devel] [PATCH V2 1/2] doc/muxers: fix and update docs for HLS muxer

[Gyan]

On 28-06-2019 08:36 PM, Jun Zhao wrote:
> From: Jun Zhao <barryjzhao at tencent.com>
>
> fix and update docs for HLS muxer
>
> Signed-off-by: Jun Zhao <barryjzhao at tencent.com>
> ---
>   doc/muxers.texi |   24 ++++++++++++++++--------
>   1 files changed, 16 insertions(+), 8 deletions(-)
>
> diff --git a/doc/muxers.texi b/doc/muxers.texi
> index dd64672..d179584 100644
> --- a/doc/muxers.texi
> +++ b/doc/muxers.texi
> @@ -525,7 +525,7 @@ See also the @ref{framehash} muxer.
>   @anchor{hls}
>   @section hls
>   
> -Apple HTTP Live Streaming muxer that segments MPEG-TS according to
> +Apple HTTP Live Streaming muxer that segments MPEG-TS/fragmented MP4 according to
>   the HTTP Live Streaming (HLS) specification.
>   
>   It creates a playlist file, and one or more segment files. The output filename
> @@ -767,20 +767,20 @@ ffmpeg -f lavfi -re -i testsrc -c:v h264 -hls_flags delete_segments \
>     -hls_key_info_file file.keyinfo out.m3u8
>   @end example
>   
> - at item -hls_enc @var{enc}
> + at item hls_enc @var{enc}
>   Enable (1) or disable (0) the AES128 encryption.
>   When enabled every segment generated is encrypted and the encryption key
>   is saved as @var{playlist name}.key.
>   
> - at item -hls_enc_key @var{key}
> + at item hls_enc_key @var{key}
>   Hex-coded 16byte key to encrypt the segments, by default it
>   is randomly generated.
>   
> - at item -hls_enc_key_url @var{keyurl}
> + at item hls_enc_key_url @var{keyurl}
>   If set, @var{keyurl} is prepended instead of @var{baseurl} to the key filename
>   in the playlist.
>   
> - at item -hls_enc_iv @var{iv}
> + at item hls_enc_iv @var{iv}
>   Hex-coded 16byte initialization vector for every segment instead
>   of the autogenerated ones.
>   
> @@ -901,14 +901,22 @@ are always written into temporary file regardles of this flag if @code{master_pl
>   
>   @end table
>   
> - at item hls_playlist_type event
> + at item hls_playlist_type @var{int}
> +Set the HLS playlist type, Default value is 0.

I would prefer if you add an entry for PLAYLIST_TYPE_NONE in the options 
table and document it here.

Then change int to value.

> +
> +Other possible values:
> + at table @option
> +
> + at item event
>   Emit @code{#EXT-X-PLAYLIST-TYPE:EVENT} in the m3u8 header. Forces
>   @option{hls_list_size} to 0; the playlist can only be appended to.
>   
> - at item hls_playlist_type vod
> + at item vod
>   Emit @code{#EXT-X-PLAYLIST-TYPE:VOD} in the m3u8 header. Forces
>   @option{hls_list_size} to 0; the playlist must not change.
>   
> + at end table
> +
>   @item method
>   Use the given HTTP method to create the hls files.
>   @example
> @@ -1090,7 +1098,7 @@ Use persistent HTTP connections. Applicable only for HTTP output.
>   @item timeout
>   Set timeout for socket I/O operations. Applicable only for HTTP output.
>   
> - at item -ignore_io_errors
> + at item ignore_io_errors
>   Ignore IO errors during open, write and delete. Useful for long-duration runs with network output.
>   
>   @item headers

Gyan