TextTrackStyle

Describes style information for a text track.

Specifies how a text track's text will be displayed on-screen. The text is displayed inside a rectangular "window". The appearance of both the text and the window are configurable.

With the exception of fontScale, which has a predefined default value, any attribute that is not explicitly set will remain "unspecified", and the Cast Receiver will select an appropriate value.

Colors are represented as strings “#RRGGBBAA” where XX are the two hexadecimal symbols that represent the 0-255 value for the specific channel/color. It follows CSS 8-digit hex color notation (See http://dev.w3.org/csswg/css-color/#hex-notation).

see Android | iOS | Chrome

Hierarchy

• TextTrackStyle

Index

Properties

• backgroundColor
• customData
• edgeColor
• edgeType
• fontFamily
• fontGenericFamily
• fontScale
• fontStyle
• foregroundColor
• windowColor
• windowCornerRadius
• windowType

Properties

Optional backgroundColor

• backgroundColor? : undefined | string

Background RGBA color, represented as "#RRGGBBAA". The alpha channel should be used for transparent backgrounds.

---

Optional customData

• customData? : undefined | object

Custom application data.

---

Optional edgeColor

• edgeColor? : undefined | string

RGBA color for the edge, represented as "#RRGGBBAA". This value will be ignored if edgeType is none.

---

Optional edgeType

• edgeType? : "depressed" | "dropShadow" | "none" | "outline" | "raised"

---

Optional fontFamily

• fontFamily? : undefined | string

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

---

Optional fontGenericFamily

• fontGenericFamily? : "casual" | "cursive" | "monoSansSerif" | "monoSerif" | "sansSerif" | "serif" | "smallCaps"

---

Optional fontScale

• fontScale? : undefined | number

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

---

Optional fontStyle

• fontStyle? : "bold" | "boldItalic" | "italic" | "normal"

---

Optional foregroundColor

• foregroundColor? : undefined | string

Foreground RGBA color, represented as "#RRGGBBAA".

---

Optional windowColor

• windowColor? : undefined | string

RGBA color for the window, represented as "#RRGGBBAA". This value will be ignored if windowType is none. Some receiver devices may not support this attribute.

---

Optional windowCornerRadius

• windowCornerRadius? : undefined | number

Rounded corner radius absolute value in pixels (px). This value will be ignored if windowType is not rounded. Some receiver devices may not support this attribute.

---

Optional windowType

• windowType? : "none" | "normal" | "rounded"

The window concept is defined in CEA-608 and CEA-708, See http://goo.gl/M3ea0X. In WebVTT is called a region. Some receiver devices may not support this attribute.