Speech QML Type

Voice output with approximate lip-sync for characters. More...

• List of all members, including inherited members

Detailed Description

Speech lets a character say things while its mouth moves along. Two kinds of input are supported:

• Plain text - spoken via text-to-speech when the platform provides an engine (Qt TextToSpeech); the mouth follows a viseme timeline derived from the text's letters. Without a TTS engine the same timeline animates silently.
• Audio files (wav/mp3) - played back while the mouth follows the audio's loudness envelope; a zero-crossing heuristic separates wide "s"-like sounds from open vowels.

The mouth shape is published through the continuous properties mouthOpen, mouthWide and mouthRound which Head consumes via its speechSource property. Character wires this up automatically - typically you only call say():

import Clayground.Character3D

Character {
    id: hero
    Component.onCompleted: hero.say("Hello! Welcome to Clayground.")
}

// Or play a recorded line:
// hero.say("dialog/intro.wav")

// Advanced configuration via the speech engine:
// hero.speech.rate = 0.2
// hero.speech.volume = 0.8

Strings ending in a known audio extension (wav/mp3/ogg/m4a/flac) are treated as file paths or URLs, anything else as text to speak.

See also Character and Head.