Shaka Packager SDK
Public Attributes | List of all members
shaka::HlsParams Struct Reference

HLS related parameters. More...

#include <hls_params.h>

Public Attributes

HlsPlaylistType playlist_type = HlsPlaylistType::kVod
 HLS playlist type. See HLS specification for details.
 
std::string master_playlist_output
 HLS master playlist output path.
 
std::string base_url
 
double time_shift_buffer_depth = 0
 
size_t preserved_segments_outside_live_window = 0
 
std::string key_uri
 
std::string default_language
 
std::string default_text_language
 
bool is_independent_segments
 
double target_segment_duration = 0
 
uint32_t media_sequence_number = 0
 

Detailed Description

HLS related parameters.

Definition at line 23 of file hls_params.h.

Member Data Documentation

◆ base_url

std::string shaka::HlsParams::base_url

The base URL for the Media Playlists and media files listed in the playlists. This is the prefix for the files.

Definition at line 30 of file hls_params.h.

◆ default_language

std::string shaka::HlsParams::default_language

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. This applies to both audio and text tracks. The default language for text tracks can be overriden by 'default_text_language'.

Definition at line 50 of file hls_params.h.

◆ default_text_language

std::string shaka::HlsParams::default_text_language

Same as above, but this overrides the default language for text tracks, i.e. subtitles or close-captions.

Definition at line 53 of file hls_params.h.

◆ key_uri

std::string shaka::HlsParams::key_uri

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.

Definition at line 44 of file hls_params.h.

◆ media_sequence_number

uint32_t shaka::HlsParams::media_sequence_number = 0

Custom EXT-X-MEDIA-SEQUENCE value to allow continuous media playback across packager restarts. See #691 for details.

Definition at line 64 of file hls_params.h.

◆ preserved_segments_outside_live_window

size_t shaka::HlsParams::preserved_segments_outside_live_window = 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.

Definition at line 40 of file hls_params.h.

◆ target_segment_duration

double shaka::HlsParams::target_segment_duration = 0

This is the target segment duration requested by the user. The actual segment duration may be different to the target segment duration. It will be populated from segment duration specified in ChunkingParams if not specified.

Definition at line 61 of file hls_params.h.

◆ time_shift_buffer_depth

double shaka::HlsParams::time_shift_buffer_depth = 0

Defines the live window, or the guaranteed duration of the time shifting buffer for 'live' playlists.

Definition at line 33 of file hls_params.h.


The documentation for this struct was generated from the following file: