diff --git a/README.md b/README.md index 308a15657..d62ffa300 100644 --- a/README.md +++ b/README.md @@ -105,6 +105,47 @@ The `say(message: string, endCallAfterSpoken?: boolean)` can be used to invoke s vapi.say("Our time's up, goodbye!", true) ``` +The `setVolume(volume: number)` controls how loudly the assistant plays, from +`0` to `1`. This is playback only: it does not change what the assistant hears, +and it does not affect the levels reported by the `volume-level` event. + +```javascript +vapi.setVolume(0.5); +``` + +The setting is remembered, so you can call it before a call has started and it +will be applied as soon as the assistant's audio arrives. It also persists +across calls, so a volume your user picked once is not reset by hanging up. +Values outside `0` to `1` are clamped, and non-finite values are ignored. + +The `getAudioPlayer()` returns the `