Rate this page:

ConferenceSettings

Methods

toString

Copy URL
fun toString(): 

String

Returns

  • type:

    String

Props

customData

Copy URL
var customData: 

String?

This API is in beta and subject to change.

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

Returns

  • type:

    String?

extraHeaders

Copy URL
var extraHeaders: 

Map<String, String>?

This API is in beta and subject to change.

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

Returns

  • type:

    Map<String, String>?

preferredVideoCodec

Copy URL
var preferredVideoCodec: 

VideoCodec

This API is in beta and subject to change.

Preferred video codec for a particular call that this CallSettings are applied to. VideoCodec.Auto by default.

Returns

enableSimulcast

Copy URL
var enableSimulcast: 

Boolean

This API is in beta and subject to change.

Whether simulcast feature is enabled in a conference call.

Applicable only for video conference calls.

The default value is false.

Returns

  • type:

    Boolean

receiveVideo

Copy URL
var receiveVideo: 

Boolean

This API is in beta and subject to change.

Whether to receive video in a conference call.

Returns

  • type:

    Boolean

muteAudio

Copy URL
var muteAudio: 

Boolean

This API is in beta and subject to change.

Whether audio is muted at the conference start.

Returns

  • type:

    Boolean

localVideoStream

Copy URL
var localVideoStream: 

LocalVideoStream?

This API is in beta and subject to change.

Local video stream to be sent on conference start.

Returns