ConferenceSettings

Conference settings with additional conference parameters, such as the preferred video codec, custom data, extra headers, etc.

Props

conferenceName: string

Сonference name. For SIP compatibility reasons it should be a non-empty string.

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: Record<string, string>

Optional set of headers to be sent to the Voximplant cloud. Names should begin with “X-” to be processed by SDK.

muteAudio: boolean

Whether the audio should be muted when the user joins a conference.

preferredVideoCodec: VideoCodec

Preferred video codec for a particular call that these settings are applied to.

The default value is VideoCodec.Auto.

reportStats: boolean

Whether the ConferenceStatsReport event should be triggered for a call.

The default value is false.

simulcast: boolean

Whether the simulcast feature is enabled in a conference call.

Applicable only for video conferences.

The default value is true.

statsReportInterval: number

Conference 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.