Class: TextTrackStyle

  • The TextTrackStyle class describes style information for a text track.

  • It includes properties for background and foreground colors in RGBA format.

  • Properties like edgeType, edgeColor, windowType, and windowColor are available for styling edges and windows.

  • Font styling properties include fontFamily, fontGenericFamily, fontScale, and fontStyle.

  • The class also allows for customData to be set by the receiver application.

cast.framework.messages.TextTrackStyle

class   static

Describes style information for a text track.

Constructor

TextTrackStyle

new TextTrackStyle()

Properties

backgroundColor

(string or undefined)

The background 32-bit RGBA color, represented as #RRGGBBAA. The alpha channel should be used for transparent backgrounds.

customData

(non-null Object or undefined)

Custom data set by the receiver application.

edgeColor

(string or undefined)

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

edgeType

(non-null cast.framework.messages.TextTrackEdgeType or undefined)

fontFamily

(string or undefined)

If the font is not available in the receiver, the fontGenericFamily is used.

fontGenericFamily

(non-null cast.framework.messages.TextTrackFontGenericFamily or undefined)

The text track font's generic family.

fontScale

(number or undefined)

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

fontStyle

(non-null cast.framework.messages.TextTrackFontStyle or undefined)

The text track font style.

foregroundColor

(string or undefined)

The foreground 32-bit RGBA color, represented as #RRGGBBAA.

windowColor

(string or undefined)

32-bit RGBA color for the window, represented as #RRGGBBAA. This value will be ignored if windowType is NONE.

windowRoundedCornerRadius

(number or undefined)

The absolute radius of the rounded corners of the window, in pixels (px). This value will be ignored if windowType is not ROUNDED_CORNERS.

windowType

(non-null cast.framework.messages.TextTrackWindowType or undefined)

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