Web.Speech.TTS.Utterance

type PitchRateVolume = { pitch :: Number, rate :: Number, volume :: Number }

Pitch, rate and volume for an utterance.

• Pitch: Between 0 (lowest) and 2 (highest), with 1 being the default pitch for the current platform or voice.
• Rate: Note that the documentation looks suspicious, and rateMax has been set to 2.0.
• Volume: Between 0 (lowest) and 1 (highest), with 1 being the default.

data Utterance :: Type

Represents a SpeechSynthesisUtterance

createWithVoiceAndPitch :: Voice -> PitchRateVolume -> String -> Effect Utterance

Creates an utterance with voice, pitch, rate and volume, and text.

createWithVoiceAndRate :: Voice -> Number -> String -> Effect Utterance

Creates an utterance with voice, pitch, rate and volume, and text.

defaultPitch :: Number

The default pitch.

defaultPitchRateVolume :: PitchRateVolume

The default pitch, rate and volume.

defaultRate :: Number

The default rate.

defaultVolume :: Number

The default volume.

lang :: Utterance -> String

SpeechSynthesisUtterance.lang (getter)

listenToBoundary :: Utterance -> (Maybe (SpeechSynthesisEvent -> Effect Unit)) -> Effect Unit

SpeechSynthesisUtterance: boundary event

listenToEnd :: Utterance -> (Maybe (SpeechSynthesisEvent -> Effect Unit)) -> Effect Unit

SpeechSynthesisUtterance: end event

pitch :: Utterance -> Number

SpeechSynthesisUtterance.pitch (getter)

pitchMax :: Number

The maximum pitch.

pitchMin :: Number

The minimum pitch.

rate :: Utterance -> Number

SpeechSynthesisUtterance.rate (getter)

rateMax :: Number

Note that this is capped to 2.0. Even though the documentation says 10.0 is possible, I don't think this makes any sense, since even with 2.0 the voice is very fast, and I doesn't accept changes above 3.0 or 4.0 anyways and falls back to 1.0. See Rate.

rateMin :: Number

The minimum rate.

text :: Utterance -> String

SpeechSynthesisUtterance.text (getter)

utterance :: SpeechSynthesisEvent -> Utterance

SpeechSynthesisEvent.utterance

voice :: Utterance -> Voice

SpeechSynthesisUtterance.voice (getter)

volume :: Utterance -> Number

SpeechSynthesisUtterance.volume (getter)

volumeMax :: Number

The maximum volume.

volumeMin :: Number

The minimum volume.