コンストラクタ
new KeplerA11ySettingsInterface()
new KeplerA11ySettingsInterface(): 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>
UIスケール設定の変更に対するリスナーを追加します。リスナーが既に登録されている場合、登録されているリスナーは削除され、新規登録するリスナーに置き換えられます。
パラメーター
handler
(newScaleSetting: UiScaleSetting) => void
UIスケール設定が変更されたときにメインスレッドで呼び出されるコールバック関数
戻り値
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
scalingProps スケーリングの適用方法を定義するプロパティ戻り値
Promise<number>
スケーリングされたサイズに解決されるPromiseオブジェクト
getScalingMultiplier()
getScalingMultiplier(originalSize:number, scalingProps: ScalingProps): Promise<number>
指定された元のサイズとスケーリングプロパティに対するスケール倍率を取得します。
スケール倍率を取得するには、このメソッドを使用する必要があります。スケール倍率は、画像の高さや幅など、同じスケーリングプロパティを持たない関連値に適用できます。
注：UiScaleSettingContextProviderのuseScalingMultiplierフックを使用することをお勧めします。
パラメーター
originalSize
number
スケーリングする元のサイズ（単位：PLATFORM_DENSITY_INDEPENDENT_PIXELが有効になっている場合はDIP数、そうでない場合は物理ピクセル数）
scalingProps
scalingProps スケーリングの適用方法を定義するプロパティ戻り値
Promise<number>
スケール倍率に解決されるPromiseオブジェクト
getTimeToTakeAction()
getTimeToTakeAction():Promise<TimeoutMultiplier>
現在の操作時間の設定を取得します。
戻り値
Promise<TimeoutMultiplier>
現在のタイムアウト乗数に解決されるPromiseオブジェクト
getUiScaleSetting()
getUiScaleSetting():Promise<UiScaleSetting>
現在のUIスケール設定を取得します。
注：UiScaleSettingContextProviderのuseUiScaleSettingフックを使用することをお勧めします。
戻り値
Promise<UiScaleSetting>
現在のUIスケール設定に解決される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>
UIスケール設定のリスナーを削除します。
戻り値
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
CaptioningProps 更新対象となる字幕サポートの設定を含むオブジェクト。このオブジェクトに存在するプロパティのみが更新されます。戻り値
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
ColorCorrectionMode 設定する色補正モード戻り値
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
TimeoutMultiplier 設定するタイムアウト乗数戻り値
Promise<void>
setUiScaleSetting()
setUiScaleSetting(setting: UiScaleSetting):Promise<void>
UIスケール設定を行います。com.amazon.devconf.privilege.accessibility.write権限が必要です。
パラメーター
setting
UiScaleSetting 行うべきUIスケール設定戻り値
Promise<void>
