Package com.amazonaws.ivs.player

Class TextCue

java.lang.Object

com.amazonaws.ivs.player.Cue

com.amazonaws.ivs.player.TextCue

public class TextCue
extends Cue

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TextCue.TextAlignment	Possible text alignment of a TextCue.

Field Summary

Fields

Modifier and Type	Field	Description
final float	line	The line on which the text belongs.
final float	position	The position of the text.
final float	size	The size of the cue as a percentage of the video.
final String	text	cue text
final TextCue.TextAlignment	textAlign	alignment of text

Fields inherited from class com.amazonaws.ivs.player.Cue

endTime, startTime

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

line

public final float line

The line on which the text belongs.

size

public final float size

The size of the cue as a percentage of the video.

position

public final float position

The position of the text.

textAlign

@NonNull
public final TextCue.TextAlignment textAlign

alignment of text

text

@NonNull
public final String text

cue text

Method Details

equals

public boolean equals(Object o)

Overrides:

equals in class Cue

hashCode

public int hashCode()

Overrides:

hashCode in class Cue

toString

public String toString()

Overrides:

toString in class Object