63 lines
2.5 KiB
C++
63 lines
2.5 KiB
C++
// Copyright 2017 Google Inc. All rights reserved.
|
|
//
|
|
// Use of this source code is governed by a BSD-style
|
|
// license that can be found in the LICENSE file or at
|
|
// https://developers.google.com/open-source/licenses/bsd
|
|
|
|
#ifndef PACKAGER_HLS_PUBLIC_HLS_PARAMS_H_
|
|
#define PACKAGER_HLS_PUBLIC_HLS_PARAMS_H_
|
|
|
|
#include <string>
|
|
|
|
namespace shaka {
|
|
|
|
/// Defines the EXT-X-PLAYLIST-TYPE in the HLS specification. For
|
|
/// HlsPlaylistType of kLive, EXT-X-PLAYLIST-TYPE tag is omitted.
|
|
enum class HlsPlaylistType {
|
|
kVod,
|
|
kEvent,
|
|
kLive,
|
|
};
|
|
|
|
/// HLS related parameters.
|
|
struct HlsParams {
|
|
/// HLS playlist type. See HLS specification for details.
|
|
HlsPlaylistType playlist_type = HlsPlaylistType::kVod;
|
|
/// HLS master playlist output path.
|
|
std::string master_playlist_output;
|
|
/// The base URL for the Media Playlists and media files listed in the
|
|
/// playlists. This is the prefix for the files.
|
|
std::string base_url;
|
|
/// Defines the live window, or the guaranteed duration of the time shifting
|
|
/// buffer for 'live' playlists.
|
|
double time_shift_buffer_depth = 0;
|
|
/// Segments outside the live window (defined by 'time_shift_buffer_depth'
|
|
/// above) are automatically removed except for the most recent X segments
|
|
/// defined by this parameter. This is needed to accommodate latencies in
|
|
/// various stages of content serving pipeline, so that the segments stay
|
|
/// accessible as they may still be accessed by the player. The segments are
|
|
/// not removed if the value is zero.
|
|
size_t preserved_segments_outside_live_window = 0;
|
|
/// Defines the key uri for "identity" and "com.apple.streamingkeydelivery"
|
|
/// key formats. Ignored if the playlist is not encrypted or not using the
|
|
/// above key formats.
|
|
std::string key_uri;
|
|
/// The renditions tagged with this language will have 'DEFAULT' set to 'YES'
|
|
/// in 'EXT-X-MEDIA' tag. This allows the player to choose the correct default
|
|
/// language for the content.
|
|
std::string default_language;
|
|
/// This is the target segment duration requested by the user. The actual
|
|
/// segment duration may be different to the target segment duration.
|
|
/// This parameter is included here to for bandwidth estimator to exclude the
|
|
/// segments with duration less than half of the target duration from
|
|
/// bandwidth estimation. See
|
|
/// https://github.com/google/shaka-packager/issues/498 for details. It will
|
|
/// be populated from segment duration specified in ChunkingParams if not
|
|
/// specified.
|
|
double target_segment_duration = 0;
|
|
};
|
|
|
|
} // namespace shaka
|
|
|
|
#endif // PACKAGER_HLS_PUBLIC_HLS_PARAMS_H_
|