KeplerA11ySettingsInterface
构造函数
new KeplerA11ySettingsInterface()
new KeplerA11ySettingsInterface(): KeplerA11ySettingsInterface
返回值
方法
addAudioDescriptionStateListener()
addAudioDescriptionStateListener(handler:
(enabled: boolean) => void):Promise<boolean>
添加音频描述状态变化的侦听器。如果侦听器已注册，则会将其移除并替换为新的侦听器。
参数
handler
(enabled: boolean) => void
音频描述状态发生变化时在主线程上调用的回调函数
返回值
Promise<boolean>
解析为布尔值的Promise，表示侦听器是否注册成功。
addCaptioningPreferencesListener()
addCaptioningPreferencesListener(handler:
(preferences:CaptioningProps) => void):Promise<boolean>
添加字幕首选项变化的侦听器。如果侦听器已注册，则会将其移除并替换为新的侦听器。
参数
handler
(preferences: CaptioningProps) => void
字幕首选项发生变化时在主线程上调用的回调函数
返回值
Promise<boolean>
解析为布尔值的Promise，表示侦听器是否注册成功。
addClosedCaptioningStateListener()
addClosedCaptioningStateListener(handler:
(enabled: boolean) => void):Promise<boolean>
添加隐藏式字幕状态变化的侦听器。如果侦听器已注册，则会将其移除并替换为新的侦听器。
参数
handler
(enabled: boolean) => void
隐藏式字幕状态发生变化时在主线程上调用的回调函数
返回值
Promise<boolean>
解析为布尔值的Promise，表示侦听器是否注册成功。
addColorCorrectionModeListener()
addColorCorrectionModeListener(handler:
(mode:ColorCorrectionMode) => void):Promise<boolean>
添加颜色校正模式变化的侦听器。如果侦听器已注册，则会将其移除并替换为新的侦听器。
参数
handler
(mode: ColorCorrectionMode) => void
颜色校正模式发生变化时在主线程上调用的回调函数
返回值
Promise<boolean>
解析为布尔值的Promise，表示侦听器是否注册成功。
addColorInversionStateListener()
addColorInversionStateListener(handler:
(enabled: boolean) => void):Promise<boolean>
添加颜色反转状态变化的侦听器。如果侦听器已注册，则会将其移除并替换为新的侦听器。
参数
handler
(enabled: boolean) => void
颜色反转状态发生变化时在主线程上调用的回调函数
返回值
Promise<boolean>
解析为布尔值的Promise，表示侦听器是否注册成功。
addHighContrastTextStateListener()
addHighContrastTextStateListener(handler:
(enabled: boolean) => void):Promise<boolean>
添加高对比度文本状态变化的侦听器。如果侦听器已注册，则会将其移除并替换为新的侦听器。
参数
handler
(enabled: boolean) => void
高对比度文本状态发生变化时在主线程上调用的回调函数
返回值
Promise<boolean>
解析为布尔值的Promise，表示侦听器是否注册成功。
addScreenMagnifierStateListener()
addScreenMagnifierStateListener(handler:
(enabled: boolean) => void):Promise<boolean>
添加屏幕放大器状态变化的侦听器。如果侦听器已注册，则会将其移除并替换为新的侦听器。
参数
handler
(enabled: boolean) => void
屏幕放大器状态发生变化时在主线程上调用的回调函数
返回值
Promise<boolean>
解析为布尔值的Promise，表示侦听器是否注册成功。
addScreenReaderStateListener()
addScreenReaderStateListener(handler:
(enabled: boolean) => void):Promise<boolean>
添加屏幕阅读器状态变化的侦听器。如果侦听器已注册，则会将其移除并替换为新的侦听器。
参数
handler
(enabled: boolean) => void
屏幕阅读器状态发生变化时在主线程上调用的回调函数
返回值
Promise<boolean>
解析为布尔值的Promise，表示侦听器是否注册成功。
addTextBannerStateListener()
addTextBannerStateListener(handler:
(enabled: boolean) => void):Promise<boolean>
添加文本横幅状态变化的侦听器。如果侦听器已注册，则会将其移除并替换为新的侦听器。
参数
handler
(enabled: boolean) => void
文本横幅状态发生变化时在主线程上调用的回调函数
返回值
Promise<boolean>
解析为布尔值的Promise，表示侦听器是否注册成功。
addTimeToTakeActionListener()
addTimeToTakeActionListener(handler:
(value:TimeoutMultiplier) => void):Promise<boolean>
添加行动时间变化的侦听器。如果侦听器已注册，则会将其移除并替换为新的侦听器。
参数
handler
(value: TimeoutMultiplier) => void
行动时间发生变化时在主线程上调用的回调函数
返回值
Promise<boolean>
解析为布尔值的Promise，表示侦听器是否注册成功。
addUiScaleSettingListener()
addUiScaleSettingListener(handler:
(newScaleSetting:UiScaleSetting) => void):Promise<boolean>
添加用户界面缩放设置变化的侦听器。如果侦听器已注册，则会将其移除并替换为新的侦听器。
参数
handler
(newScaleSetting: UiScaleSetting) => void
用户界面缩放设置发生变化时在主线程上调用的回调函数
返回值
Promise<boolean>
解析为布尔值的Promise，表示侦听器是否注册成功。
getCaptionPreferences()
getCaptionPreferences():
Promise<CaptioningProps>
获取所有字幕首选项。
返回值
Promise<CaptioningProps>
解析为包含所有字幕首选项设置对象的Promise
getColorCorrectionMode()
getColorCorrectionMode():
Promise<ColorCorrectionMode>
获取当前的颜色校正模式。
返回值
Promise<ColorCorrectionMode>
解析为当前颜色校正模式的Promise
getScaledSize()
getScaledSize(originalSize:
number, scalingProps: ScalingProps):Promise<number>
根据给定原始尺寸和缩放属性获取缩放后的尺寸。
注意： 建议使用UiScaleSettingContextProvider中的useScaledSize挂钩。
参数
originalSize
number
要缩放的原始尺寸（如果启用了PLATFORM_DENSITY_INDEPENDENT_PIXEL，则以DIP为单位；否则，以物理像素为单位）
scalingProps
定义缩放应用方式的属性
返回值
Promise<number>
解析为缩放后尺寸的Promise
getScalingMultiplier()
getScalingMultiplier(originalSize:
number, scalingProps: ScalingProps):Promise<number>
根据给定原始尺寸和缩放属性获取缩放倍数。
此方法应用于获取缩放系数，该系数可应用于具有不同缩放属性的相关值，例如图像的高度和宽度。
注意： 建议使用UiScaleSettingContextProvider中的useScalingMultiplier挂钩。
参数
originalSize
number
要缩放的原始尺寸（如果启用了PLATFORM_DENSITY_INDEPENDENT_PIXEL，则以DIP为单位；否则，以物理像素为单位）
scalingProps
定义缩放应用方式的属性
返回值
Promise<number>
解析为缩放倍数的Promise
getTimeToTakeAction()
getTimeToTakeAction():
Promise<TimeoutMultiplier>
获取当前的行动时间设置。
返回值
Promise<TimeoutMultiplier>
解析为当前超时倍数的Promise
getUiScaleSetting()
getUiScaleSetting():
Promise<UiScaleSetting>
获取当前的用户界面缩放设置。
注意： 建议使用UiScaleSettingContextProvider中的useUiScaleSetting挂钩。
返回值
Promise<UiScaleSetting>
解析为当前用户界面缩放设置的Promise
isAudioDescriptionPreferred()
isAudioDescriptionPreferred():
Promise<boolean>
检查是否首选音频描述。
返回值
Promise<boolean>
如果首选音频描述，则解析为true，否则解析为false的Promise
isClosedCaptioningEnabled()
isClosedCaptioningEnabled():
Promise<boolean>
检查是否启用了隐藏式字幕。
返回值
Promise<boolean>
如果启用了隐藏式字幕，则解析为true，否则解析为false的Promise
isColorInversionEnabled()
isColorInversionEnabled():
Promise<boolean>
检查是否启用了颜色反转。
返回值
Promise<boolean>
如果启用了颜色反转，则解析为true，否则解析为false的Promise
isHighContrastTextEnabled()
isHighContrastTextEnabled():
Promise<boolean>
检查是否启用了高对比度文本。
返回值
Promise<boolean>
如果启用了高对比度文本，则解析为true，否则解析为false的Promise
isScreenMagnifierEnabled()
isScreenMagnifierEnabled():
Promise<boolean>
检查是否启用了屏幕放大器。
返回值
Promise<boolean>
如果启用了屏幕放大器，则解析为true，否则解析为false的Promise
isScreenReaderEnabled()
isScreenReaderEnabled():
Promise<boolean>
检查是否启用了屏幕阅读器。
返回值
Promise<boolean>
如果启用了屏幕阅读器，则解析为true，否则解析为false的Promise
isTextBannerEnabled()
isTextBannerEnabled():
Promise<boolean>
检查是否启用了文本横幅。
返回值
Promise<boolean>
如果启用了文本横幅，则解析为true，否则解析为false的Promise
removeAudioDescriptionStateListener()
removeAudioDescriptionStateListener():
Promise<void>
移除音频描述状态侦听器。
返回值
Promise<void>
侦听器移除后解析的Promise。
removeCaptioningPreferencesListener()
removeCaptioningPreferencesListener():
Promise<void>
移除字幕首选项侦听器。
返回值
Promise<void>
侦听器移除后解析的Promise。
removeClosedCaptioningStateListener()
removeClosedCaptioningStateListener():
Promise<void>
移除隐藏式字幕状态侦听器。
返回值
Promise<void>
侦听器移除后解析的Promise。
removeColorCorrectionModeListener()
removeColorCorrectionModeListener():
Promise<void>
移除颜色校正模式侦听器。
返回值
Promise<void>
侦听器移除后解析的Promise。
removeColorInversionStateListener()
removeColorInversionStateListener():
Promise<void>
移除颜色反转状态侦听器。
返回值
Promise<void>
侦听器移除后解析的Promise。
removeHighContrastTextStateListener()
removeHighContrastTextStateListener():
Promise<void>
移除高对比度文本状态侦听器。
返回值
Promise<void>
侦听器移除后解析的Promise。
removeScreenMagnifierStateListener()
removeScreenMagnifierStateListener():
Promise<void>
移除屏幕放大器状态侦听器。
返回值
Promise<void>
侦听器移除后解析的Promise。
removeScreenReaderStateListener()
removeScreenReaderStateListener():
Promise<void>
移除屏幕阅读器状态侦听器。
返回值
Promise<void>
侦听器移除后解析的Promise。
removeTextBannerStateListener()
removeTextBannerStateListener():
Promise<void>
移除文本横幅状态侦听器。
返回值
Promise<void>
侦听器移除后解析的Promise。
removeTimeToTakeActionListener()
removeTimeToTakeActionListener():
Promise<void>
移除行动时间侦听器。
返回值
Promise<void>
侦听器移除后解析的Promise。
removeUiScaleSettingListener()
removeUiScaleSettingListener():
Promise<void>
移除用户界面缩放设置侦听器。
返回值
Promise<void>
侦听器移除后解析的Promise。
setAudioDescriptionPreferred()
setAudioDescriptionPreferred(enabled:
boolean):Promise<void>
设置音频描述首选项。需要com.amazon.devconf.privilege.accessibility.write权限。
参数
enabled
boolean
若首选音频描述，则为true；否则为false
返回值
Promise<void>
setCaptionPreferences()
setCaptionPreferences(prefs: CaptioningProps):
Promise<void>
一次性设置多个字幕首选项。需要com.amazon.devconf.privilege.accessibility.write权限。
参数
prefs
包含要更新的字幕首选项设置的对象。仅更新对象中存在的属性。
返回值
Promise<void>
setClosedCaptioningEnabled()
setClosedCaptioningEnabled(enabled:
boolean):Promise<void>
设置是否启用隐藏式字幕。需要com.amazon.devconf.privilege.accessibility.write权限。
参数
enabled
boolean
若要启用隐藏式字幕，则为true；若要禁用，则为false
返回值
Promise<void>
setColorCorrectionMode()
setColorCorrectionMode(mode: ColorCorrectionMode):
Promise<void>
设置颜色校正模式。需要com.amazon.devconf.privilege.accessibility.write权限。
参数
mode
要设置的颜色校正模式
返回值
Promise<void>
setColorInversionEnabled()
setColorInversionEnabled(enabled:
boolean):Promise<void>
设置是否启用颜色反转。需要com.amazon.devconf.privilege.accessibility.write权限。
参数
enabled
boolean
若要启用颜色反转，则为true；若要禁用，则为false
返回值
Promise<void>
setHighContrastTextEnabled()
setHighContrastTextEnabled(enabled:
boolean):Promise<void>
设置是否启用高对比度文本。需要com.amazon.devconf.privilege.accessibility.write权限。
参数
enabled
boolean
若要启用高对比度文本，则为true；若要禁用，则为false
返回值
Promise<void>
setScreenMagnifierEnabled()
setScreenMagnifierEnabled(enabled:
boolean):Promise<void>
设置是否启用屏幕放大器。需要com.amazon.devconf.privilege.accessibility.write权限。
参数
enabled
boolean
若要启用屏幕放大器，则为true；若要禁用，则为false
返回值
Promise<void>
setScreenReaderEnabled()
setScreenReaderEnabled(enabled:
boolean):Promise<void>
设置是否启用屏幕阅读器。需要com.amazon.devconf.privilege.accessibility.write权限。
参数
enabled
boolean
若要启用屏幕阅读器，则为true；若要禁用，则为false
返回值
Promise<void>
setTextBannerEnabled()
setTextBannerEnabled(enabled:
boolean):Promise<void>
设置是否启用文本横幅。需要com.amazon.devconf.privilege.accessibility.write权限。
参数
enabled
boolean
若要启用文本横幅，则为true；若要禁用，则为false
返回值
Promise<void>
setTimeToTakeAction()
setTimeToTakeAction(multiplier: TimeoutMultiplier):
Promise<void>
设置行动时间倍数。需要com.amazon.devconf.privilege.accessibility.write权限。
参数
multiplier
要设置的超时倍数
返回值
Promise<void>
setUiScaleSetting()
setUiScaleSetting(setting: UiScaleSetting):
Promise<void>
设置用户界面缩放设置。需要com.amazon.devconf.privilege.accessibility.write权限。
参数
setting
要设置的用户界面缩放设置
返回值
Promise<void>
Last updated: 2026年7月31日
