SKTTSPlayer Class Reference

Inherits from NSObject
Declared in SKTTSPlayer.h

Overview

The actual TTS player. transforms strings into audio instructions.

  delegate

The delegate of the player.

@property (nonatomic, weak) id<SKTTSPlayerDelegate> delegate

Discussion

The delegate of the player.

Declared In

SKTTSPlayer.h

  textToSpeechConfig

Input for TTS configuration.

@property (nonatomic, strong) SKAdvisorTTSSettings *textToSpeechConfig

Discussion

Input for TTS configuration.

Declared In

SKTTSPlayer.h

+ sharedInstance

Returns the singleton SKTTSPlayer instance.

+ (instancetype)sharedInstance

Discussion

Returns the singleton SKTTSPlayer instance.

Declared In

SKTTSPlayer.h

– playString:forLanguage:

Plays the given instruction in the given language.

- (void)playString:(NSString *)instruction forLanguage:(SKAdvisorLanguage)language

Parameters

instruction

The advice instruction to be spoken by the TTS.

language

The language of the instruction.

Discussion

Plays the given instruction in the given language.

Declared In

SKTTSPlayer.h

– pausePlayingInstructions

Pause all playing instructions.

- (void)pausePlayingInstructions

Discussion

Pause all playing instructions.

Declared In

SKTTSPlayer.h

– resumePlayingInstructions

Resume the next playing instruction.

- (void)resumePlayingInstructions

Discussion

Resume the next playing instruction.

Declared In

SKTTSPlayer.h

– cancelPlayingInstructionsImmediately:

Cancel all playing instructions.

- (void)cancelPlayingInstructionsImmediately:(BOOL)immediately

Parameters

immediately

A boolean value indicating that the playing of the instructions should be stopped immediately. Passing NO as parameter will cause that the playing will be stopped after finishing the playing of the current word.

Discussion

Cancel all playing instructions.

Declared In

SKTTSPlayer.h