Rate this page:

VICalls

Interface that creates calls, conferences.

Methods

createCall

Copy URL

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

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

getMissingPermissions

Copy URL

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>

initialize

Copy URL

Initialize the VICalls module to make calls.

Returns

  • type:

    Unit

setIncomingCallListener

Copy URL

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

Props

calls

Copy URL

Returns all active calls.

Returns

  • type:

    Map<String, Call>

conferences

Copy URL

Returns all active conferences.

Returns

eglBase

Copy URL

Externally created WebRTC EglBase.

Returns

  • type:

    EglBase?

version

Copy URL

Returns

  • type:

    String