CallSettings
Call settings with additional call parameters, such as the preferred video codec, custom data, extra headers, etc.
Props
customData
customData: string
Custom string associated with a call session.
It can be passed to the cloud to be obtained from the CallAlerting event or Call History via Management 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
extraHeaders: Record<string, string>
Optional set of headers to be sent to the Voximplant cloud. Names should begin with “X-” to be processed by SDK.
preferredVideoCodec
preferredVideoCodec: Preferred video codec for a particular call that these settings are applied to.
The default value is VideoCodec.Auto.
receiveVideo
receiveVideo: boolean
Whether video receiving is enabled in a call.
The default value is false.
If the call is started without video and the user enables video in an active call via the Call.addStream API, enables video receiving.
reportStats
reportStats: boolean
Whether the CallStatsReport event should be triggered for a call.
The default value is false.
statsReportInterval
statsReportInterval: number
Call statistics collection interval in milliseconds.
The default value is 1000.
The interval value should be multiple of 500, otherwise the provided value is rounded to a less value that is multiple of 500.
To receive the CallStatsReport event, CallSettings.reportStats should be set to true.