org.digitalmediaserver.cast

Class TextTrackStyle

java.lang.Object

org.digitalmediaserver.cast.TextTrackStyle

@Immutable
public class TextTrackStyle
extends Object

Describes style information for a text track.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextTrackStyle.TextTrackEdgeType Defines the text track edge type.
static class	TextTrackStyle.TextTrackFontGenericFamily Generic font family to be used if font not defined in text track.
static class	TextTrackStyle.TextTrackFontStyle Possible text track font style.
static class	TextTrackStyle.TextTrackWindowType Text track window type.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	backgroundColor The background 32 bit RGBA color.
protected Map<String,Object>	customData Custom data set by the receiver application
protected String	edgeColor RGBA color for the edge, this value will be ignored if edgeType is TextTrackStyle.TextTrackEdgeType.NONE
protected TextTrackStyle.TextTrackEdgeType	edgeType The type of edge
protected String	fontFamily The font family.
protected TextTrackStyle.TextTrackFontGenericFamily	fontGenericFamily The text track generic font family
protected Double	fontScale The font scaling factor for the text track (the default is 1.0)
protected TextTrackStyle.TextTrackFontStyle	fontStyle The text track font style
protected String	foregroundColor The foreground 32 bit RGBA color
protected String	windowColor 32 bit RGBA color for the window.
protected Integer	windowRoundedCornerRadius Rounded corner radius absolute value in pixels (px).
protected TextTrackStyle.TextTrackWindowType	windowType The window concept is defined in CEA-608 and CEA-708.

Constructor Summary

Constructors

Constructor and Description
TextTrackStyle(String backgroundColor, Map<String,Object> customData, String edgeColor, TextTrackStyle.TextTrackEdgeType edgeType, String fontFamily, TextTrackStyle.TextTrackFontGenericFamily fontGenericFamily, Double fontScale, TextTrackStyle.TextTrackFontStyle fontStyle, String foregroundColor, String windowColor, Integer windowRoundedCornerRadius, TextTrackStyle.TextTrackWindowType windowType) Creates a new instance using the specific parameters.
TextTrackStyle(String foregroundColor, String backgroundColor, TextTrackStyle.TextTrackEdgeType edgeType, String edgeColor, String fontFamily, TextTrackStyle.TextTrackFontGenericFamily fontGenericFamily, Double fontScale, TextTrackStyle.TextTrackFontStyle fontStyle) Creates a new instance using the specific parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getBackgroundColor()
Map<String,Object>	getCustomData()
String	getEdgeColor()
TextTrackStyle.TextTrackEdgeType	getEdgeType()
String	getFontFamily()
TextTrackStyle.TextTrackFontGenericFamily	getFontGenericFamily()
Double	getFontScale()
TextTrackStyle.TextTrackFontStyle	getFontStyle()
String	getForegroundColor()
String	getWindowColor()
Integer	getWindowRoundedCornerRadius()
TextTrackStyle.TextTrackWindowType	getWindowType()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

backgroundColor

@Nullable
protected final String backgroundColor

The background 32 bit RGBA color. The alpha channel should be used for transparent backgrounds.

customData

@Nonnull
protected final Map<String,Object> customData

Custom data set by the receiver application

edgeColor

@Nullable
protected final String edgeColor

RGBA color for the edge, this value will be ignored if edgeType is TextTrackStyle.TextTrackEdgeType.NONE

edgeType

@Nullable
protected final TextTrackStyle.TextTrackEdgeType edgeType

The type of edge

fontFamily

@Nullable
protected final String fontFamily

The font family. If the font is not available in the receiver the fontGenericFamily will be used

fontGenericFamily

@Nullable
protected final TextTrackStyle.TextTrackFontGenericFamily fontGenericFamily

The text track generic font family

fontScale

@Nullable
protected final Double fontScale

The font scaling factor for the text track (the default is 1.0)

fontStyle

@Nullable
protected final TextTrackStyle.TextTrackFontStyle fontStyle

The text track font style

foregroundColor

@Nullable
protected final String foregroundColor

The foreground 32 bit RGBA color

windowColor

@Nullable
protected final String windowColor

32 bit RGBA color for the window. This value will be ignored if windowType is TextTrackStyle.TextTrackWindowType.NONE.

windowRoundedCornerRadius

@Nullable
protected final Integer windowRoundedCornerRadius

Rounded corner radius absolute value in pixels (px). This value will be ignored if windowType is not TextTrackStyle.TextTrackWindowType.ROUNDED_CORNERS.

windowType

@Nullable
protected final TextTrackStyle.TextTrackWindowType windowType

The window concept is defined in CEA-608 and CEA-708. In WebVTT it is called a region.

Constructor Detail

TextTrackStyle

public TextTrackStyle(@Nullable
                      String foregroundColor,
                      @Nullable
                      String backgroundColor,
                      @Nullable
                      TextTrackStyle.TextTrackEdgeType edgeType,
                      @Nullable
                      String edgeColor,
                      @Nullable
                      String fontFamily,
                      @Nullable
                      TextTrackStyle.TextTrackFontGenericFamily fontGenericFamily,
                      @Nullable
                      Double fontScale,
                      @Nullable
                      TextTrackStyle.TextTrackFontStyle fontStyle)

Creates a new instance using the specific parameters.

Parameters:

foregroundColor - the foreground 32 bit RGBA color.

backgroundColor - the background 32 bit RGBA color. The alpha channel should be used for transparent backgrounds.

edgeType - the type of edge.

edgeColor - the RGBA color for the edge, this value will be ignored if edgeType is TextTrackStyle.TextTrackEdgeType.NONE.

fontFamily - the font family. If the font is not available in the receiver the fontGenericFamily will be used.

fontGenericFamily - the text track generic font family.

fontScale - the font scaling factor for the text track (the default is 1.0).

fontStyle - the text track font style.

TextTrackStyle

public TextTrackStyle(@Nullable
                      String backgroundColor,
                      @Nullable
                      Map<String,Object> customData,
                      @Nullable
                      String edgeColor,
                      @Nullable
                      TextTrackStyle.TextTrackEdgeType edgeType,
                      @Nullable
                      String fontFamily,
                      @Nullable
                      TextTrackStyle.TextTrackFontGenericFamily fontGenericFamily,
                      @Nullable
                      Double fontScale,
                      @Nullable
                      TextTrackStyle.TextTrackFontStyle fontStyle,
                      @Nullable
                      String foregroundColor,
                      @Nullable
                      String windowColor,
                      @Nullable
                      Integer windowRoundedCornerRadius,
                      @Nullable
                      TextTrackStyle.TextTrackWindowType windowType)

Creates a new instance using the specific parameters.

Parameters:

backgroundColor - the background 32 bit RGBA color. The alpha channel should be used for transparent backgrounds.

customData - the custom data set by the receiver application.

edgeColor - the RGBA color for the edge, this value will be ignored if edgeType is TextTrackStyle.TextTrackEdgeType.NONE.

edgeType - the type of edge.

fontFamily - the font family. If the font is not available in the receiver the fontGenericFamily will be used.

fontGenericFamily - the text track generic font family.

fontScale - the font scaling factor for the text track (the default is 1.0).

fontStyle - the text track font style.

foregroundColor - the foreground 32 bit RGBA color.

windowColor - the 32 bit RGBA color for the window. This value will be ignored if windowType is TextTrackStyle.TextTrackWindowType.NONE.

windowRoundedCornerRadius - the rounded corner radius absolute value in pixels (px). This value will be ignored if windowType is not TextTrackStyle.TextTrackWindowType.ROUNDED_CORNERS.

windowType - the window type. The window concept is defined in CEA-608 and CEA-708. In WebVTT it is called a region.

Method Detail

getBackgroundColor

@Nullable
public String getBackgroundColor()

Returns:

The background 32 bit RGBA color. The alpha channel should be used for transparent backgrounds.

getCustomData

@Nonnull
public Map<String,Object> getCustomData()

Returns:

The custom data set by the receiver application.

getEdgeColor

@Nullable
public String getEdgeColor()

Returns:

The RGBA color for the edge, this value will be ignored if edgeType is TextTrackStyle.TextTrackEdgeType.NONE.

getEdgeType

@Nullable
public TextTrackStyle.TextTrackEdgeType getEdgeType()

Returns:

The The type of edge.

getFontFamily

@Nullable
public String getFontFamily()

Returns:

The text track font family. If the font is not available in the receiver the fontGenericFamily will be used.

getFontGenericFamily

@Nullable
public TextTrackStyle.TextTrackFontGenericFamily getFontGenericFamily()

Returns:

The The text track generic font family.

getFontScale

@Nullable
public Double getFontScale()

Returns:

The The font scaling factor for the text track (the default is 1.0).

getFontStyle

@Nullable
public TextTrackStyle.TextTrackFontStyle getFontStyle()

Returns:

The text track font style.

getForegroundColor

@Nullable
public String getForegroundColor()

Returns:

The foreground 32 bit RGBA color.

getWindowColor

@Nullable
public String getWindowColor()

Returns:

The 32 bit RGBA color for the window. This value will be ignored if windowType is TextTrackStyle.TextTrackWindowType.NONE.

getWindowRoundedCornerRadius

@Nullable
public Integer getWindowRoundedCornerRadius()

Returns:

The Rounded corner radius absolute value in pixels (px). This value will be ignored if windowType is not TextTrackStyle.TextTrackWindowType.ROUNDED_CORNERS.

getWindowType

@Nullable
public TextTrackStyle.TextTrackWindowType getWindowType()

Returns:

The window type. The window concept is defined in CEA-608 and CEA-708. In WebVTT it is called a region.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object