IClosedCaptioningSettings

​

Interface IClosedCaptioningSettings

interface IClosedCaptioningSettings

Extends com.amazon.apmf.IStandard The IClosedCaptioningSettings interface provides APIs to query closed captioning settings value.

​

Methods

​

isClosedCaptioningEnabled()

bool isClosedCaptioningEnabled()

Query whether closed captioning is currently enabled.

​

Returns

bool true if closed captioning is enabled.

---

​

addClosedCaptioningStateListener()

com.amazon.apmf.ISubscription* addClosedCaptioningStateListener(IEnabledStateListener* listener)

Add a closed captioning state listener.

​

Parameters

listener

IEnabledStateListener* — Required the listener’s onEnabledStateChanged() method is called when the closed captioning enabled state changes.

​

Returns

com.amazon.apmf.ISubscription* a IISubscription instance representing a registration of an event listener and can be used to end the delivery of any further events to the listener. See the documentation of ISubscription for details.

---

​

getClosedCaptioningPreferences()

ICaptioningPreferences* getClosedCaptioningPreferences()

Get an instance for querying closed captioning preferences.

​

Returns

ICaptioningPreferences* a ICaptioningPreferences instance.

---

​

addClosedCaptioningPreferencesListener()

com.amazon.apmf.ISubscription* addClosedCaptioningPreferencesListener(ICaptioningPreferencesListener* listener)

Add a closed captioning preferences listener.

​

Parameters

listener

ICaptioningPreferencesListener* — Required the listener’s methods are called when any closed captioning preference changed.

​

Returns

com.amazon.apmf.ISubscription* a IISubscription instance representing a registration of an event listener and can be used to end the delivery of any further events to the listener. See the documentation of ISubscription for details.

---