HERE iOS SDK Developer's Guide

NMATTSAudioOutput

Class Summary

class NMATTSAudioOutput

Derived from: NMAAudioOutput

A TTS audio output segment consisting of a single string.

Include: NMAKit.framework/headers/NMATTSAudioOutput.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMATTSAudioOutput

[For complete information, see the section Class Details]

Public Property Summary

Table 1. Public Properties
Public Properties

[readable, writable, assign] float  pitchMultiplier

The pitch multiplier with which the text is spoken

[readable, writable, assign] float  speechRate

The speech rate at which the text is spoken

[readable, writable, assign] NSString *  text

The text string to speak

[readable, writable, assign] AVSpeechSynthesisVoice *  voice

The voice used to speak the text

Instance Method Summary

Table 2. Instance Methods
Instance Method Summary

-(nonnull instancetype) init

Must initalize with a text string

-(nullable instancetype) initWithText:(nonnull NSString *) text

Initializes an NMATTSAudioOutput with the given text string

Class Method Summary

Table 3. Class Methods
Class Methods

+(nullable instancetype) audioOutputWithText:(nonnull NSString *) text

Creates an NMATTSAudioOutput with the given text string

+(nonnull instancetype) new

Must initalize with a text string

Class Details

A TTS audio output segment consisting of a single string.

Note:

Audio output should never be played directly. Instead it should be passed to the NMAAudioManager (via the playOutput method) to be played.

Public Property Details

[readable, writable, assign] float pitchMultiplier

The pitch multiplier with which the text is spoken.

Note:

The default value is 1.0;

[readable, writable, assign] float speechRate

The speech rate at which the text is spoken.

Note:

The default value is AVSpeechUtteranceDefaultSpeechRate.

[readable, writable, assign] NSString * text

The text string to speak.

[readable, writable, assign] AVSpeechSynthesisVoice * voice

The voice used to speak the text.

Note:

By default, the voice will be selected based on the current locale of the device.

Instance Method Details

-(nonnull instancetype) init

Must initalize with a text string.

-(nullable instancetype) initWithText:(nonnull NSString *) text

Initializes an NMATTSAudioOutput with the given text string.

Class Method Details

+(nullable instancetype) audioOutputWithText:(nonnull NSString *) text

Creates an NMATTSAudioOutput with the given text string.

+(nonnull instancetype) new

Must initalize with a text string.