Shaka Packager SDK
Public Member Functions | List of all members
shaka::media::TextStreamInfo Class Reference
Inheritance diagram for shaka::media::TextStreamInfo:
shaka::media::StreamInfo

Public Member Functions

 TextStreamInfo (int track_id, int32_t time_scale, int64_t duration, Codec codec, const std::string &codec_string, const std::string &codec_config, uint16_t width, uint16_t height, const std::string &language)
 
bool IsValidConfig () const override
 
std::string ToString () const override
 
std::unique_ptr< StreamInfoClone () const override
 
uint16_t width () const
 
uint16_t height () const
 
const std::map< std::string, TextRegion > & regions () const
 
void AddRegion (const std::string &id, const TextRegion &region)
 
const std::string & css_styles () const
 
void set_css_styles (const std::string &styles)
 
void AddSubStream (uint16_t index, TextSubStreamInfo info)
 
const std::map< uint16_t, TextSubStreamInfo > & sub_streams () const
 
- Public Member Functions inherited from shaka::media::StreamInfo
 StreamInfo (StreamType stream_type, int track_id, int32_t time_scale, int64_t duration, Codec codec, const std::string &codec_string, const uint8_t *codec_config, size_t codec_config_size, const std::string &language, bool is_encrypted)
 
StreamType stream_type () const
 
uint32_t track_id () const
 
int32_t time_scale () const
 
int64_t duration () const
 
Codec codec () const
 
const std::string & codec_string () const
 
const std::vector< uint8_t > & codec_config () const
 
const std::string & language () const
 
bool is_encrypted () const
 
bool has_clear_lead () const
 
const EncryptionConfigencryption_config () const
 
void set_duration (int64_t duration)
 
void set_codec (Codec codec)
 
void set_codec_config (const std::vector< uint8_t > &data)
 
void set_codec_string (const std::string &codec_string)
 
void set_language (const std::string &language)
 
void set_is_encrypted (bool is_encrypted)
 
void set_has_clear_lead (bool has_clear_lead)
 
void set_encryption_config (const EncryptionConfig &encryption_config)
 

Detailed Description

Definition at line 49 of file text_stream_info.h.

Constructor & Destructor Documentation

◆ TextStreamInfo()

shaka::media::TextStreamInfo::TextStreamInfo ( int  track_id,
int32_t  time_scale,
int64_t  duration,
Codec  codec,
const std::string &  codec_string,
const std::string &  codec_config,
uint16_t  width,
uint16_t  height,
const std::string &  language 
)

No encryption supported.

Parameters
track_idis the track ID of this stream.
time_scaleis the time scale of this stream.
durationis the duration of this stream.
codecis the media codec.
codec_stringis the codec in string format.
codec_configis configuration for this text stream. This could be the metadata that applies to all the samples of this stream. This may be empty.
widthof the text. This may be 0.
heightof the text. This may be 0.
languageis the language of this stream. This may be empty.

Definition at line 14 of file text_stream_info.cc.

Member Function Documentation

◆ Clone()

std::unique_ptr< StreamInfo > shaka::media::TextStreamInfo::Clone ( ) const
overridevirtual
Returns
A new copy of this stream info. The copy will be of the same type as the original. This should be used when a copy is needed without explicitly knowing the stream info type.

Implements shaka::media::StreamInfo.

Definition at line 54 of file text_stream_info.cc.

◆ IsValidConfig()

bool shaka::media::TextStreamInfo::IsValidConfig ( ) const
overridevirtual
Returns
true if this object has appropriate configuration values, false otherwise.

Implements shaka::media::StreamInfo.

Definition at line 38 of file text_stream_info.cc.

◆ ToString()

std::string shaka::media::TextStreamInfo::ToString ( ) const
overridevirtual
Returns
A human-readable string describing the stream info.

Reimplemented from shaka::media::StreamInfo.

Definition at line 42 of file text_stream_info.cc.


The documentation for this class was generated from the following files: