Provides the configuration for the Text to Speech Module. It is used to control the language of the generated voice, the voice’s style and pace.

var onTTSComplete = function(audioTrackAsset, eventArgs) {
print("Synthesis complete!");
}

var onTTSError = function(error, description) {
print("Synthesis error!");
}

var options = TextToSpeech.Options.create();
options.voiceName = TextToSpeech.VoiceNames.Sam;
options.voicePace = 100;
options.voiceStyle = TextToSpeech.VoiceStyles.Two;

script.ttsModule.synthesize("Text to speech example", options, onTTSComplete, onTTSError);
interface Options {
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
}

Hierarchy (view full)

Methods

  • Returns true if the object matches or derives from the passed in type.

    Parameters

    • type: string

    Returns boolean

  • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

    Parameters

    Returns boolean