Optional audioOverrides client's default audio constraints. Defaults to true
Optional callerName to use as the caller ID name when dialing out to a destination.
Optional callerNumber to use as the caller ID when dialing out to a destination. A valid phone number is required for dials out to PSTN numbers.
On an emergency call (911, or the 933 test number) this is the caller's identity: the platform
looks up the emergency address registered on this number and hands it to the emergency service as
the callback number. Use a number on your account in +E.164 form with emergency services enabled.
A Caller ID Override on the connection can replace this value: an override that applies to emergency
calls (always, emergency) always does, and a normal override is used as the fallback when this
value is not a valid number — leave the override off on connections that place emergency calls.
Optional camdeviceId to use as webcam. Overrides the client's default one.
Optional clientTelnyx's Call Control client_state. Can be used with Connections with Advanced -> Events enabled.
clientState string should be base64 encoded.
Optional customAdd custom headers to the INVITE and ANSWER request.
Header names must start with X-; other names are not forwarded. For emergency calls the
caller's coordinates can be sent as X-Latitude / X-Longitude (WGS 84, 6 to 8 decimals),
for example from navigator.geolocation. This built-in geolocation is available for U.S.
emergency calls and must be enabled by Telnyx support (PIDF-LO) on the number used as
callerNumber; without that, the headers are forwarded but not used to locate the caller.
Identity headers (From, P-Asserted-Identity) cannot be set here — the caller is identified by
callerNumber. See TelnyxRTC.newCall for an emergency-call example.
Optional debugEnable debug mode for this call.
Optional debugOutput debug logs to a file.
Optional destinationPhone number or SIP URI to dial.
Optional forceForce the use of a relay ICE candidate.
Optional iceOverrides client's default iceServers to use for certain call.
Optional idCustom ID to identify the call. This will be used as the callID in place of the UUID generated by the client.
Optional keepUse only IClientOptions.keepConnectionAliveOnSocketClose
By passing keepConnectionAliveOnSocketClose as true, the SDK will attempt to keep Peer connection alive
when the WebSocket connection is closed unexpectedly (e.g. network interruption, device sleep, etc).
Optional localOverrides client's default localElement.
Optional localIf set, the call will use this stream instead of retrieving a new one.
Optional mediaConfigures media (audio/video) in a call.
Optional sdpASBandwidthOptional useOptional micdeviceId to use as microphone. Overrides the client's default one.
Optional onOverrides client's default telnyx.notification handler for this call.
Optional preferred_Preferred codecs for the call, as entries from
RTCRtpReceiver.getCapabilities('audio').codecs.
Optional prefetchEnable or disable prefetching ICE candidates. Defaults to false.
Sets iceCandidatePoolSize to 1 when on and 0 when off. A deeper pool gains
nothing — BUNDLE negotiates the call down to a single transport, so only one
pre-gathered set is ever adopted — while costing one gathering pass per local
network interface per ICE server for each unit.
Optional remoteOverrides client's default remoteElement.
Optional remoteIf set, the call will use this stream instead of retrieving a new one.
Optional speakerdeviceId to use as speaker. Overrides the client's default one.
Optional telnyxTelnyx Call Control ID, if using Call Control services.
Optional telnyxTelnyx call leg ID, if using Call Control services.
Optional telnyxTelnyx call session ID, if using Call Control services.
Optional trickleEnable or disable Trickle ICE.
Optional useUses stereo audio instead of mono.
Optional videoOverrides client's default video constraints. Defaults to false
ICallOptions ICallOptions