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

Defines a single input/output stream. More...

#include <packager.h>

Public Attributes

std::string input
 Input/source media file path or network stream URL. Required.
 
std::string stream_selector
 
std::string output
 
std::string segment_template
 Specifies segment template. Can be empty.
 
std::string output_format
 
bool skip_encryption = false
 
std::string drm_label
 
uint32_t trick_play_factor = 0
 
uint32_t bandwidth = 0
 
std::string language
 
std::string hls_name
 
std::string hls_group_id
 
std::string hls_playlist_name
 
std::string hls_iframe_playlist_name
 
std::vector< std::string > hls_characteristics
 

Detailed Description

Defines a single input/output stream.

Definition at line 73 of file packager.h.

Member Data Documentation

◆ bandwidth

uint32_t shaka::StreamDescriptor::bandwidth = 0

Optional user-specified content bit rate for the stream, in bits/sec. If specified, this value is propagated to the $Bandwidth$ template parameter for segment names. If not specified, its value may be estimated.

Definition at line 105 of file packager.h.

◆ drm_label

std::string shaka::StreamDescriptor::drm_label

Specifies a custom DRM stream label, which can be a DRM label defined by the DRM system. Typically values include AUDIO, SD, HD, UHD1, UHD2. If not provided, the DRM stream label is derived from stream type (video, audio), resolutions etc.

Definition at line 97 of file packager.h.

◆ hls_characteristics

std::vector<std::string> shaka::StreamDescriptor::hls_characteristics

Optional for HLS output. It defines the CHARACTERISTICS attribute of the stream.

Definition at line 125 of file packager.h.

◆ hls_group_id

std::string shaka::StreamDescriptor::hls_group_id

Required for audio when outputting HLS. It defines the group ID for the output stream. This is used as the GROUP-ID attribute for EXT-X-MEDIA.

Definition at line 116 of file packager.h.

◆ hls_iframe_playlist_name

std::string shaka::StreamDescriptor::hls_iframe_playlist_name

Optional for HLS output. It defines the name of the I-Frames only playlist for the stream. For Video only. Usually ends with .m3u8.

Definition at line 122 of file packager.h.

◆ hls_name

std::string shaka::StreamDescriptor::hls_name

Required for audio when outputting HLS. It defines the name of the output stream, which is not necessarily the same as output. This is used as the NAME attribute for EXT-X-MEDIA.

Definition at line 113 of file packager.h.

◆ hls_playlist_name

std::string shaka::StreamDescriptor::hls_playlist_name

Required for HLS output. It defines the name of the playlist for the stream. Usually ends with .m3u8.

Definition at line 119 of file packager.h.

◆ language

std::string shaka::StreamDescriptor::language

Optional value which contains a user-specified language tag. If specified, this value overrides any language metadata in the input stream.

Definition at line 108 of file packager.h.

◆ output

std::string shaka::StreamDescriptor::output

Specifies output file path or init segment path (if segment template is specified). Can be empty for self initialization media segments.

Definition at line 83 of file packager.h.

◆ output_format

std::string shaka::StreamDescriptor::output_format

Optional value which specifies output container format, e.g. "mp4". If not specified, will detect from output / segment template name.

Definition at line 89 of file packager.h.

◆ skip_encryption

bool shaka::StreamDescriptor::skip_encryption = false

If set to true, the stream will not be encrypted. This is useful, e.g. to encrypt only video streams.

Definition at line 92 of file packager.h.

◆ stream_selector

std::string shaka::StreamDescriptor::stream_selector

Stream selector, can be audio, video, text or a zero based stream index. Required.

Definition at line 79 of file packager.h.

◆ trick_play_factor

uint32_t shaka::StreamDescriptor::trick_play_factor = 0

If set to a non-zero value, will generate a trick play / trick mode stream with frames sampled from the key frames in the original stream. trick_play_factor defines the sampling rate.

Definition at line 101 of file packager.h.


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