| java.lang.Object | ||
| ↳ | com.amazonaws.ivs.player.Cue | |
| ↳ | com.amazonaws.ivs.player.TextCue | |
Class Overview
Contains information for the display of subtitles and captions including styling and positioning. Note: currently IVS streams do not contain positioning or styling information for TextCues. TextCues should be rendered in accordance with user preferences for captions/subtitles and should be cleared/reset when switching streams in the player or after a preset timeout period.
Summary
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| enum | TextCue.TextAlignment | Possible text alignment of a TextCue. |
|||||||||
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| public final float | line | The line on which the text belongs. | |||||||||
| public final float | position | The position of the text. | |||||||||
| public final float | size | The size of the cue as a percentage of the video. | |||||||||
| public final String | text | cue text | |||||||||
| public final TextCue.TextAlignment | textAlign | alignment of text | |||||||||
|
[Expand]
Inherited Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
 From class
com.amazonaws.ivs.player.Cue
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| boolean | equals(Object o) | ||||||||||
| int | hashCode() | ||||||||||
| String | toString() | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
com.amazonaws.ivs.player.Cue
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
Fields
public final float line
The line on which the text belongs.
public final float position
The position of the text.
public final float size
The size of the cue as a percentage of the video.
public final String text
cue text