Skip to content

Interface: TalklineClientOptions ​

Properties ​

PropertyTypeDescription
capabilities?string[]The server never sends a client a media feature it did not claim. By default the SDK claims the video codecs this browser can decode beyond VP8 — h264, vp9 — which is what the media server chooses by. A list given here replaces that. recording is claimed whatever this says: it is the SDK's promise to tell its host of every change to a room's recording (recordingChanged), which it keeps.
clock?Clock-
createPeerConnection?(config) => RTCPeerConnection-
iceTransportPolicy?RTCIceTransportPolicyrelay sends every peer connection through TURN from the start, as step 3 of the recovery ladder does after a failure. A host that must not reveal a participant's address to the far side of a p2p call, or knows its network blocks direct UDP, asks for it here. Default all.
identity?stringFor diagnostics and as a fallback before the first snapshot arrives. The server's RoomStateEvent.self is the authority.
media?MediaFactory-
platform?Platform-
timings?Partial<Timings>-
token?TokenSource-
transport?TransportFactory-
urlstringwss://signal.example — /ws and ?v=1 are filled in when they are missing, and left alone when the host has its own path.

Talkline documentation