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

Public Attributes

base::Optional< TextNumberline
 
base::Optional< TextNumberposition
 
base::Optional< TextNumberwidth
 
base::Optional< TextNumberheight
 
std::string region
 The region to draw the cue in.
 
WritingDirection writing_direction = WritingDirection::kHorizontal
 
TextAlignment text_alignment = TextAlignment::kCenter
 How to align the text within the cue box.
 

Detailed Description

Definition at line 55 of file text_sample.h.

Member Data Documentation

◆ height

base::Optional<TextNumber> shaka::media::TextSettings::height

For horizontal cues, this is the height of the area to draw cues. For vertical cues, this is the width. Percent units are relative to the window.

Definition at line 69 of file text_sample.h.

◆ line

base::Optional<TextNumber> shaka::media::TextSettings::line

The line offset of the cue. For horizontal cues, this is the vertical offset. Percent units are relative to the window.

Definition at line 58 of file text_sample.h.

◆ position

base::Optional<TextNumber> shaka::media::TextSettings::position

The position offset of the cue. For horizontal cues, this is the horizontal offset. Percent units are relative to the window.

Definition at line 61 of file text_sample.h.

◆ width

base::Optional<TextNumber> shaka::media::TextSettings::width

For horizontal cues, this is the width of the area to draw cues. For vertical cues, this is the height. Percent units are relative to the window.

Definition at line 65 of file text_sample.h.

◆ writing_direction

WritingDirection shaka::media::TextSettings::writing_direction = WritingDirection::kHorizontal

The direction to draw text. This is also used to determine how cues are positioned within the region.

Definition at line 76 of file text_sample.h.


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