Text To Speech API

model.utteranceOpts

An optional data structure supplied to the component model that configures the Text To Speech component behaviour, as described below. As part of the component model, can be managed through the ChangeApplier API to assist in coordination with other components.

var tts = fluid.textToSpeech({
    model: {
        utteranceOpts: {
            volume: 1
        }
    },
});

text

The string of text to be appended to the queue and spoken.

interrupt

An optional boolean value. The default value is false. Setting it to true will remove all texts from the queue before adding the text. Setting it to false will not affect previously queued texts.

options

An optional javascript object. Allows for the configuration of the specific SpeechSynthesisUtterance instance used for this particular text. The configuration passed in here takes the same form as model.utteranceOpts and will override them for this instance only.

fluid.queueSpeech("Hello world", false, {
    volume: 0.5
});

• name: A human-readable name that describes the voice.
• voiceURI: A URI specifying the location of the speech synthesis service for this voice.
• lang: The language code for this voice.
• default: Set to true if this is the default voice used by the browser.
• localService: The API can use both local and remote services to handle speech synthesis. If this attribute is set to true the speech synthesis for this voice is handled by a local service. If it’s false a remote service is being used. This attribute can be useful if you’re building an app that needs to work offline. You could use a remote service when an internet connection is present, and fallback to a local service if a connection is not available.

text

The text that has been added to the queue.

fluid.textToSpeech({
    model: {
        utteranceOpts: {
            text: "Override other texts"
        }
    }
});

fluid.textToSpeech({
    model: {
        utteranceOpts: {
            lang: "en-US"
        }
    }
});

var availableVoices = SpeechSynthesis.getVoices();
var voiceToUse = availableVoices[0];
fluid.textToSpeech({
model: {
utteranceOpts: {
voice: voiceToUse
}
}
});

fluid.textToSpeech({
    model: {
        utteranceOpts: {
            volume: 0.5
        }
    }
});

fluid.textToSpeech({
    model: {
        utteranceOpts: {
            rate: 2.5
        }
    }
});

fluid.textToSpeech({
    model: {
        utteranceOpts: {
            pitch: 1.2
        }
    }
});