Rate this page:

ConferenceSettings

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

Props

customData
Optional
Copy URL

Custom string associated with a conference 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 Conference.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

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

localVideoStream
Optional
Copy URL

Local video stream to be sent to a conference

muteAudio
Optional
Copy URL

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

preferredVideoCodec
Optional
Copy URL

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

The default value is VideoCodec.Auto.

statsCollectionInterval
Optional
Copy URL

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.

To receive the ConferenceStatsReceived event, set this interval when joining or creating a conference.

Rate this page: