Rate this page:

VICalls

Interface that creates calls, conferences.

Methods

initialize

Copy URL
fun initialize(): 

Unit

Initialize the VICalls module to make calls.

Returns

  • type:

    Unit

createCall

Copy URL
fun createCall(number: 

String

,
callSettings:

CallSettings

):

Call?

Creates a new call instance. Call should be then started via Call.start API.

Parameters

  • number:

    String

    SIP URI, username or phone number to make call to. Actual routing is then performed by VoxEngine scenario. See /docs/getting-started/basic-concepts/routing-rules to learn more about routing

  • callSettings:

    CallSettings

    Call settings with additional call parameters, such as preferred video codec, custom data, extra headers etc.

Returns

createConference

Copy URL
fun createConference(number: 

String

,
conferenceSettings:

ConferenceSettings

):

Conference?

Creates a conference instance.

Parameters

  • number:

    String

    The conference name. For SIP compatibility reasons it should be a non-empty string.

  • conferenceSettings:

    ConferenceSettings

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

Returns

setIncomingCallListener

Copy URL
fun setIncomingCallListener(listener: 

IncomingCallListener?

):

Unit

Sets IncomingCallListener to handle incoming calls.

Parameters

  • Optional

    The listener to be notified of incoming calls. If null, previous listener is removed

Returns

  • type:

    Unit

getMissingPermissions

Copy URL
@JvmStatic
fun getMissingPermissions(videoSupportEnabled:

Boolean

):

List<String>

Gets the list of required permissions that have not been granted by user yet.

Parameters

  • videoSupportEnabled:

    Boolean

    Whether permissions for video calls are required

Returns

  • type:

    List<String>

Props

version

Copy URL
val version: 

String

Returns

  • type:

    String

eglBase

Copy URL
var eglBase: 

EglBase?

Externally created WebRTC EglBase.

Returns

  • type:

    EglBase?

calls

Copy URL
val calls: 

Map<String, Call>

Returns all active calls.

Returns

  • type:

    Map<String, Call>

conferences

Copy URL
val conferences: 

Map<String, Conference>

Returns all active conferences.

Returns