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

Public Attributes

TextNumber width {100, TextUnitType::kPercent}
 The width of the region; percent units are relative to the window.
 
TextNumber height {100, TextUnitType::kPercent}
 The height of the region; percent units are relative to the window.
 
TextNumber window_anchor_x {0, TextUnitType::kPercent}
 
TextNumber window_anchor_y {0, TextUnitType::kPercent}
 
TextNumber region_anchor_x {0, TextUnitType::kPercent}
 
TextNumber region_anchor_y {0, TextUnitType::kPercent}
 
bool scroll = false
 

Detailed Description

Definition at line 19 of file text_stream_info.h.

Member Data Documentation

◆ region_anchor_x

TextNumber shaka::media::TextRegion::region_anchor_x {0, TextUnitType::kPercent}

The x and y coordinates of the anchor point within the region. Percent units are relative to the region size. For example: if this is (100, 100), then the bottom right of the region should be placed at the window anchor point. See https://www.w3.org/TR/webvtt1/#regions.

Definition at line 35 of file text_stream_info.h.

◆ scroll

bool shaka::media::TextRegion::scroll = false

If true, cues are scrolled up when adding new cues; if false, cues are added above existing cues or replace existing ones.

Definition at line 40 of file text_stream_info.h.

◆ window_anchor_x

TextNumber shaka::media::TextRegion::window_anchor_x {0, TextUnitType::kPercent}

The x and y coordinates of the anchor point within the window. Percent units are relative to the window. In WebVTT this is called the "viewport region anchor".

Definition at line 28 of file text_stream_info.h.


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