From e2bb22c6330541d38f10fc847d0c393fa0f4e946 Mon Sep 17 00:00:00 2001 From: Joey Parrish Date: Tue, 17 Oct 2017 10:59:58 -0700 Subject: [PATCH] Update docs for HLS descriptor fields These fields are no longer required, and have sensible defaults. Change-Id: I35bd489c8e6058f3272210cb6f3b0f504819e7c0 --- docs/source/options/hls_stream_descriptors.rst | 14 +++++++------- packager/app/packager_main.cc | 15 +++++++-------- 2 files changed, 14 insertions(+), 15 deletions(-) diff --git a/docs/source/options/hls_stream_descriptors.rst b/docs/source/options/hls_stream_descriptors.rst index 384df1d1cb..6e36769861 100644 --- a/docs/source/options/hls_stream_descriptors.rst +++ b/docs/source/options/hls_stream_descriptors.rst @@ -3,16 +3,16 @@ HLS specific stream descriptor fields :hls_name: - Required for audio when outputting HLS. name of the output stream. This is - not (necessarily) the same as output. This is used as the NAME attribute for - EXT-X-MEDIA. + Used for HLS audio to set the NAME attribute for EXT-X-MEDIA. + Defaults to the base of the playlist name. :hls_group_id: - Required for audio when outputting HLS. The group ID for the output stream. - This is used as the GROUP-ID attribute for EXT-X-MEDIA. + Used for HLS audio to set the GROUP-ID attribute for EXT-X-MEDIA. + Defaults to 'audio' if not specified. :playlist_name: - Required for HLS output. Name of the playlist for the stream. Usually ends - with '.m3u8'. + Used for HLS to name the playlist for the stream. Usually ends + with '.m3u8'. If unspecified, defaults to something of the form + 'stream_0.m3u8', 'stream_1.m3u8', 'stream_2.m3u8', etc. diff --git a/packager/app/packager_main.cc b/packager/app/packager_main.cc index af49db2215..c525a6a605 100644 --- a/packager/app/packager_main.cc +++ b/packager/app/packager_main.cc @@ -85,14 +85,13 @@ const char kUsage[] = " - trick_play_factor (tpf): Optional value which specifies the trick\n" " play, a.k.a. trick mode, stream sampling rate among key frames.\n" " If specified, the output is a trick play stream.\n" - " - hls_name: Required for audio when outputting HLS.\n" - " name of the output stream. This is not (necessarily) the same as\n" - " output. This is used as the NAME attribute for EXT-X-MEDIA.\n" - " - hls_group_id: Required for audio when outputting HLS.\n" - " The group ID for the output stream. This is used as the GROUP-ID\n" - " attribute for EXT-X-MEDIA.\n" - " - playlist_name: Required for HLS output.\n" - " Name of the playlist for the stream. Usually ends with '.m3u8'.\n"; + " - hls_name: Used for HLS audio to set the NAME attribute for\n" + " EXT-X-MEDIA. Defaults to the base of the playlist name.\n" + " - hls_group_id: Used for HLS audio to set the GROUP-ID attribute for\n" + " EXT-X-MEDIA. Defaults to 'audio' if not specified.\n" + " - playlist_name: Used for HLS to name the playlist for the stream.\n" + " Usually ends with '.m3u8'. If unspecified, defaults to something of\n" + " the form 'stream_0.m3u8', 'stream_1.m3u8', 'stream_2.m3u8', etc.\n"; enum ExitStatus { kSuccess = 0,