This plugin exposes information on the status of various accessibility features of mobile operating systems, including, for example, whether a screen reader is running, invert colors is enabled, and the preferred scaling for text. It also allows an application to send a string to be spoken by the screen reader, or a command to stop the screen reader from speaking.
There are some actions, such as the speak action, that will only work if the VoiceOver is running.
Makes an asynchronous call to native MobileAccessibility to determine if the plugin is loaded.
Returns
True if the plugin is loaded or false if not.
Supported Platforms
Makes an asynchronous call to native MobileAccessibility to determine if a screen reader is running.
True if the screen reader is running or false if not running.
An iOS-specific proxy for the IsScreenReaderRunning method. This method will return false on Android.
True if the voice over is running or false if not running.
An Android OS-specific proxy for the IsScreenReaderRunning method. This method will return false on iOS.
True if the talk back is running or false if not running.
On Android, this method returns true if ChromeVox is active and properly initialized with access to the text to speech API in the WebView. If TalkBack is running but ChromeVox is not active, this method is useful to alert the user of a potential problem.
Returns true if ChromeVox is active and properly initialized with access to the text to speech API in the WebView.
Makes an asynchronous call to native MobileAccessibility to determine if Bold Text is enabled.
True if bold text is enabled or false if not.
Makes an asynchronous call to native MobileAccessibility to determine if system-level closed captioning is enabled on the device.
True if closed captioning is enabled or false if not
Makes an asynchronous call to native MobileAccessibility to determine if Darker System Colors is enabled.
True if darker systems colors is enabled or false if not
Makes an asynchronous call to native MobileAccessibility to determine if Grayscale is enabled.
True if grayscale is enabled or false if not
Makes an asynchronous call to native MobileAccessibility to determine if Guided Access is enabled.
True if guided access is enabled or false if not
Makes an asynchronous call to native MobileAccessibility to determine if the display colors have been inverted.
True if inverted colors is enabled or false if not
Makes an asynchronous call to native MobileAccessibility to determine if mono audio is enabled.
True if mono audio is enabled or false if not
Makes an asynchronous call to native MobileAccessibility to determine if reduce motion is enabled.
True if reduce motion is enabled or false if not
Makes an asynchronous call to native MobileAccessibility to determine if reduce transparency is enabled.
True if reduce transparency is enabled or false if not
Makes an asynchronous call to native MobileAccessibility to determine if speak screen is enabled.
True if speak screen is enabled or false if not
Makes an asynchronous call to native MobileAccessibility to determine if speak selection is enabled.
True if speak selection is enabled or false if not
Makes an asynchronous call to native MobileAccessibility to determine if switch control is running.
True if switch control is enabled or false if not
Makes an asynchronous call to native MobileAccessibility to determine if Touch Exploration is enabled on Android.
True if touch exploration is enabled or false if not
Makes an asynchronous call to native MobileAccessibility to return the current text zoom percent value for the application.
Current text zoom percent value for the application
Makes an asynchronous call to native MobileAccessibility to set the current text zoom percent value for the WebView.
True if the zoom was set correctly or false if not
Parameters
TextZoom (Decimal) A percentage value by which text in the WebView should be scaled.
Makes an asynchronous call to native MobileAccessibility to retrieve the user's preferred text zoom from system settings and apply it to the application WebView.
Specifies whether or not the application should use the user's preferred text zoom from system settings to scale text within the WebView. When set to true, this method calls UpdateTextZoom() to apply new text zoom settings to the application WebView. When set to false, the application WebView text zoom will be reset to the default value of 100 percent. The plugin uses local storage to retain the preference and will call UpdateTextZoom() after a Cordova resume event.
IsUsePreferredZoom: A Boolean value which specifies whether to use the preferred text zoom of a default percent value of 100.
Speaks a given string through the screenreader. On Android, if ChromeVox is active, it will use the specified queueMode and properties.
String (string) A string to be announced by a screen reader.
QueueMode (Optional number) Valid modes are 0 for flush; 1 for queue.
Properties (Optional Object) Speech properties to use for this utterance.
Stops speech.