ConnectOptions
Options of KheelonaVoice.connect.
Properties
Section titled “Properties”clientSecret
Section titled “clientSecret”clientSecret:
string
The short-lived secret your server got from POST /v1/sessions. Never your API key.
endpoints?
Section titled “endpoints?”
optionalendpoints?:object
Where to connect, if your server’s POST /v1/sessions answer gave addresses (connect.webrtc_url and
connect.websocket_url). Defaults to the production service.
webrtcUrl?
Section titled “webrtcUrl?”
optionalwebrtcUrl?:string
websocketUrl?
Section titled “websocketUrl?”
optionalwebsocketUrl?:string
microphone?
Section titled “microphone?”
optionalmicrophone?:false| {deviceId?:string; }
false for typed turns only (no microphone is opened); deviceId picks the input device.
sessionId
Section titled “sessionId”sessionId:
string
The session id returned alongside the secret.
transport?
Section titled “transport?”
optionaltransport?:"webrtc"|"websocket"|"auto"
Default auto: WebRTC, falling back to the WebSocket when the network refuses WebRTC.
workletBaseUrl?
Section titled “workletBaseUrl?”
optionalworkletBaseUrl?:string
Where the AudioWorklet modules are served from, for a strict CSP.