ICaptioningPreferences

​

Interface ICaptioningPreferences

interface ICaptioningPreferences

Extends com.amazon.apmf.IStandard The ICaptioningPreferences interface provides APIs to query captioning preferences.

​

Methods

​

getTextSize()

TextSize getTextSize()

Get the caption text size.

​

Returns

TextSize the current text size.

---

​

getTextColor()

Color getTextColor()

Get the caption text color.

​

Returns

Color the current text color.

---

​

getTextFont()

Font getTextFont()

Get the caption text font.

​

Returns

Font the current text font.

---

​

getTextEdgeStyle()

EdgeStyle getTextEdgeStyle()

Get the caption text edge style.

​

Returns

EdgeStyle the current text edge style.

---

​

getTextOpacity()

Opacity getTextOpacity()

Get the caption text opacity.

​

Returns

Opacity the current text opacity.

---

​

getTextBackgroundColor()

Color getTextBackgroundColor()

Get the color of the background that is placed behind the caption text to enhance its readability.

​

Returns

Color the current text background color.

---

​

getTextBackgroundOpacity()

Opacity getTextBackgroundOpacity()

Get the opacity of the background that is placed behind the caption text to enhance its readability.

​

Returns

Opacity the current text background opacity.

---

​

getWindowBackgroundColor()

Color getWindowBackgroundColor()

Get the color of the designated area on the screen where the closed caption text is displayed.

​

Returns

Color the current window background color.

---

​

getWindowBackgroundOpacity()

Opacity getWindowBackgroundOpacity()

Get the opacity of the designated area on the screen where the closed caption text is displayed.

​

Returns

Opacity the current window background opacity.

---