getSelectedSSVoice

Returns the selected speech-synthesis voice for the requested engine.

Declaration

public func getSelectedSSVoice(
    _ ssEngine: String
) -> (engine: String, ssVoiceParams: STSSVoiceParams)

Overview

Requires initialization. Before initialization, the implementation records .conversationNotInitialized and returns an empty engine name with an empty STSSVoiceParams.

Selected voice

The returned tuple identifies the requested engine and its selected voice parameters. The engine identifier must correspond to the application’s configured speech-synthesis engine.

Parameters

• ssEngine — String. Currently the only supported speech synthesis engine identifier is "Apple". Other engines may be supported in the future.

Usage example

Only the Apple speech-synthesis engine is currently supported.

let selection = conversation.getSelectedSSVoice("Apple")
print(selection.engine)

See Also

• getSSVoices