Interface IAccessibilitySettings
interface IAccessibilitySettings
Extends com.amazon.apmf.IStandard
The IAccessibilitySettings interface provides APIs to query accessibility
related settings value including the status of various assistive
technologies on the system, as well the closed captioning settings.
Module: /com.amazon.kepler.a11y.settings@IAccessibilitySettings
Methods
isScreenReaderEnabled()
bool isScreenReaderEnabled()
Query whether a screen reader is currently enabled.
A screen reader is an assistive technology, primarily used by customers with vision impairments.
It converts text, buttons, images and other screen elements into speech or braille. It allows
individuals to interact with and navigate through applications on device.
Returns
bool
true if a screen reader is enabled.
addScreenReaderStateListener()
Add a screen reader state listener.com.amazon.apmf.ISubscription*addScreenReaderStateListener(IEnabledStateListener*listener)
Parameters
listener
IEnabledStateListener* — Required
the listener’s onEnabledStateChanged() method is called when
the screen reader 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.
isScreenMagnifierEnabled()
bool isScreenMagnifierEnabled()
Query whether a screen magnifier is currently enabled.
A screen magnifier is an assistive technology that magnifies the contents displayed
on a device’s screen, making it easier to see for customers who have low vision.
Returns
bool
true if a screen magnifier is enabled.
addScreenMagnifierStateListener()
Add a screen magnifier state listener.com.amazon.apmf.ISubscription*addScreenMagnifierStateListener(IEnabledStateListener*listener)
Parameters
listener
IEnabledStateListener* — Required
the listener’s onEnabledStateChanged() method is called when
the screen magnifier 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.
isTextBannerEnabled()
bool isTextBannerEnabled()
Query whether a Text Banner is currently enabled.
Text banner is an accessibility feature that helps customers with visual impairments
and a limited field of view. Text Banner displays a rectangular white box on the screen
with the title of the currently focused item and related text.
Returns
bool
true if a Text Banner is enabled.
addTextBannerStateListener()
Add a Text Banner state listener.com.amazon.apmf.ISubscription*addTextBannerStateListener(IEnabledStateListener*listener)
Parameters
listener
IEnabledStateListener* — Required
the listener’s onEnabledStateChanged() method is called when
the Text Banner 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.
isColorInversionEnabled()
bool isColorInversionEnabled()
Query whether color inversion is currently enabled.
Color inversion is an accessibility feature that inverts the colors displayed on the screen,
assisting customers with visual impairments, particularly those who have difficulty reading or
viewing content due to specific color combinations or visual sensitivities.
Returns
bool
true if color inversion is enabled.
addColorInversionStateListener()
Add a color inversion state listener.com.amazon.apmf.ISubscription*addColorInversionStateListener(IEnabledStateListener*listener)
Parameters
listener
IEnabledStateListener* — Required
the listener’s onEnabledStateChanged() method is called when
the color inversion 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.
getColorCorrectionMode()
ColorCorrectionMode getColorCorrectionMode()
Query the color correction mode.
Color correction mode is an accessibility feature designed to help customers with
color vision deficiencies, such as color blindness. This feature allows users
to adjust the display to make it more accessible and user-friendly for them.
Returns
ColorCorrectionMode
the correction mode. OFF if color correction is disabled.
addColorCorrectionModeListener()
Add a color correction mode listener.com.amazon.apmf.ISubscription*addColorCorrectionModeListener(IColorCorrectionModeListener*listener)
Parameters
listener
IColorCorrectionModeListener* — Required
the listener’s onColorCorrectionModeChanged() method is called when
the color correction mode 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.
isHighContrastTextEnabled()
bool isHighContrastTextEnabled()
Query whether high contrast text is currently enabled.
High contrast text is an accessibility feature designed to help make text easier to read. It
changes most of the text on-screen to black or white, and adds a border of the opposite color.
Returns
bool
true if high contrast text is enabled.
addHighContrastTextStateListener()
Add a high contrast text state listener.com.amazon.apmf.ISubscription*addHighContrastTextStateListener(IEnabledStateListener*listener)
Parameters
listener
IEnabledStateListener* — Required
the listener’s onEnabledStateChanged() method is called when
the high contrast text 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.
isAudioDescriptionPreferred()
bool isAudioDescriptionPreferred()
Query whether audio description is currently enabled.
Audio Description is an accessibility feature that provides narration for
compatible movies and TV shows. They describe actions, characters, scene
changes, on-screen text, and other visual content.
Returns
bool
true if audio description is enabled.
addAudioDescriptionStateListener()
Add a audio description state listener.com.amazon.apmf.ISubscription*addAudioDescriptionStateListener(IEnabledStateListener*listener)
Parameters
listener
IEnabledStateListener* — Required
the listener’s onEnabledStateChanged() method is called when
the audio description 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.
getTimeToTakeAction()
TimeoutMultiplier getTimeToTakeAction()
Query the multiplier that should be used by applications when specifying
a timeout to favor customers who need more time to respond to a transient
notification or dialog.
Returns
TimeoutMultiplier
the value of the timeout multiplier.
addTimeToTakeActionListener()
Add a time to take action setting listener.com.amazon.apmf.ISubscription*addTimeToTakeActionListener(ITimeToTakeActionListener*listener)
Parameters
listener
ITimeToTakeActionListener* — Required
the listener’s onTimeToTakeActionChanged() method is called when
the time to take action setting 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.
getClosedCaptioningSettings()
Get an instance for querying closed captioning settings.IClosedCaptioningSettings*getClosedCaptioningSettings()
Returns
IClosedCaptioningSettings*
a IClosedCaptioningSettings instance.
