Rate this page:

CallSettings

Props

customData

Copy URL
customData: 

string

|

null

Custom string associated with the call session. It can be passed to the cloud to be obtained from the CallAlerting event or Call History via the HTTP API. Maximum size is 200 bytes. Use the Call.sendMessage method to pass a string over the limit; in order to pass a large data use media_session_access_url on your backend.

enableSimulcast

Copy URL
enableSimulcast: 

undefined

|

false

|

true

Whether the simulcast feature should be enabled in a conference call.

extraHeaders

Copy URL
extraHeaders: 

{[key: string]: string}

|

null

Optional custom parameter (SIP headers) that should be passes with call (INVITE) message. Parameter names should start with "X-" to be processed. Headers size limit is 200 bytes

preferredVideoCodec

Copy URL
preferredVideoCodec: 

VideoCodec

Preferred video codec for a particular call that this CallSettings are applied to. The default codec is VideoCodec.AUTO. For android, overrides ClientConfig.preferredVideoCodec global configuration.

setupCallKit

Copy URL
IOS
setupCallKit: 

undefined

|

false

|

true

Whether the outgoing call on iOS is to be made with CallKit. Applicable only for outgoing calls.

video

Copy URL
video: 

VideoFlags

Whether video should be supported for the call.