SDKsWeb
Full Web SDK reference
Full SDK reference for the Web SDK
Client
Available client methods
| Method | Description |
|---|---|
client.realtime.record() | Create a recording instance |
client.realtime.stt() | Direct low-level STT session |
client.realtime.tts() | Create a TTS stream instance |
client.realtime.tts.multiStream() | Create a TTS connection instance for multi-stream TTS |
STT Recording
Available recording methods
| Method | Description |
|---|---|
recording.finalize() | Request the server to finalize current non-final tokens |
recording.on() | Register an event handler |
recording.once() | Register a one-time event handler |
recording.off() | Remove an event handler |
recording.pause() | Pause recording |
recording.resume() | Resume recording |
recording.stop() | Stop recording |
recording.cancel() | Cancel recording |
TTS Stream
Available TTS stream methods
| Method | Description |
|---|---|
stream.sendText() | Send text to the TTS stream |
stream.sendStream() | Pipe an async iterable of text chunks into the stream |
stream.finish() | Finish the TTS stream |
stream.cancel() | Cancel the TTS stream |
stream.close() | Close the TTS stream |
stream.on() | Register an event handler |
stream.once() | Register a one-time event handler |
stream.off() | Remove an event handler |
TTS Connection
Available TTS connection methods
| Method | Description |
|---|---|
connection.connect() | Open the WebSocket connection |
connection.stream() | Open a new TTS stream on this connection |
connection.close() | Close the WebSocket connection and terminate all active streams |
connection.on() | Register an event handler |
connection.once() | Register a one-time event handler |
connection.off() | Remove an event handler |
AudioSource
Available audio source methods
| Method | Description |
|---|---|
source.start() | Start capturing audio |
source.stop() | Stop capturing audio |
source.pause() | Pause capturing audio |
source.resume() | Resume capturing audio |
PermissionResolver
Available browser permission resolver methods
| Method | Description |
|---|---|
resolver.check() | Check current permission status |
resolver.request() | Request permission from the user |