The line the avatar opens with, and the tone that plays while the call connects.
Two small touches that make a call feel like a call. Both are off until you turn
them on, and both work with nothing but enabled: true.
The line the avatar speaks once the session goes live. Turn it on and leave
message out to get a built-in line in the chosen language, or set your own.
| Prop | Type | Default | Description |
|---|---|---|---|
avatar.greeting.enabledRequired | boolean | No default | Speak an opening line. Nothing below applies until this is true. |
avatar.greeting.messageOptional | string | No default | Your own opening line. Omit it and the avatar speaks a built-in greeting in the chosen language. Capped at 400 characters. |
avatar.greeting.languageOptional | GreetingLanguage | "en" | Language of the built-in greeting: en, es, fr, de, hi, ru, pt, ja, or it. Ignored when you supply your own message. |
The tone that plays while the session connects — the waiting-for-pickup sound.
enabled: true plays the built-in tone, and it stops on its own once the call is
live.
| Prop | Type | Default | Description |
|---|---|---|---|
connectTone.enabledRequired | boolean | No default | Play a ringback while connecting. Nothing below applies until this is true. |
connectTone.loopOptional | boolean | true | Repeat the tone until the connection completes. |
connectTone.volumeOptional | number | 0.4 | 0 to 1. A ringback sits under the conversation, not over it. |
connectTone.fadeOutMsOptional | number | 350 | Fade-out when it stops. A hard cut clicks. |
connectTone.src is web only. React Native ships no decoder for a custom
tone, so a src you pass here is ignored and the built-in tone plays instead.
The field is in the shared type, which is why your editor will still offer it.