Rate this page:

CallSettings

Props

customData

Optional
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 using 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.

extraHeaders

Optional
Copy URL
extraHeaders: 

{[key: string]: string}

|

null

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

preferredVideoCodec

Optional
Copy URL
preferredVideoCodec: 

VideoCodec

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

setupCallKit

Optional
Copy URL
IOS
setupCallKit: 

undefined

|

false

|

true

Specify if the outgoing call on iOS will be made with CallKit. Applicable only for outgoing calls.

video

Optional
Copy URL
video: 

VideoFlags

Tells if video should be supported for the call