Atalasoft MobileImage API Reference
Instance Methods | Class Methods | List of all members
kfxKUTVoiceover Class Reference

Accessibiity support. More...

#import <kfxKUTVoiceover.h>

Inheritance diagram for kfxKUTVoiceover:

Instance Methods

(BOOL) - isVoiceoverActive
 Determine if voiceover (acessibility) is active or not. More...
(void) - speakPhrase:
 Uses the built-in speech synthesizer to speak a phrase. More...
(void) - stopSpeaking
 Stop the current phrase being spoken. More...

Class Methods

(instancetype) + sharedInstance
 Get Singleton instance. More...

Detailed Description

Accessibiity support.

Use the Voiceover class for checking for the existience of voiceover, and for calling speech synthsis explicity.

Method Documentation

- (BOOL) isVoiceoverActive

Determine if voiceover (acessibility) is active or not.

This method can be called to determine if iOS system voiceover is enabled. An application can call this to decide if it should play any unsolicited voice messages using the speakPhrase method.

+ (instancetype) sharedInstance

Get Singleton instance.

Methods and properties of this class should be accessed using the sharedInstance class method to get back a Singleton object. This will ensure that only once instance of the speech synthesizer is running, and speaking a phrase will immediately stop the previous phrase.

- (void) speakPhrase: (NSString *)  phrase

Uses the built-in speech synthesizer to speak a phrase.

This method allows the application a means of calling the internal speech synthesize to speak a phrase, to support voiceover enabled applications. Although the voiceover system will automatically speak words on the screen for controls that the user can interact with, such as buttons, there are times when an application may want to play an unsolicated spoken message. In this case, the normal workflow will be to call isVoiceoverActive to see if it is enabled, and then if so, make the call to speakPhrase. Calling speakPhrase will immediately terminate the previous phrase if it is still in the process of being spoken, and speak the new phrase.

phraseis the message to be spoken.
- (void) stopSpeaking

Stop the current phrase being spoken.

This method can be called to immediately stop a currently speaking phrase, if any.

The documentation for this class was generated from the following file:
Untitled Document © 2016 Atalasoft, Inc., 116 Pleasant St, Suite 321, Easthampton, MA 01027, U.S.A. All rights reserved. Use is subject to license terms.