Rate this page:

CallManager

This API is in beta and subject to change.

Interface that creates calls, conferences, and local video streams.

Methods

call

Copy URL
fun call(number: 

String

,
callSettings:

CallSettings

):

Call?

This API is in beta and subject to change.

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

callConference

Copy URL
fun callConference(number: 

String

,
conferenceSettings:

ConferenceSettings

):

Conference?

This API is in beta and subject to change.

Creates call to a dedicated conference without proxy session. For details see the video conferencing guide.

Parameters

  • number:

    String

    The number to call. For SIP compatibility reasons it should be a non-empty string even if the number itself is not used by a Voximplant cloud scenario

  • conferenceSettings:

    ConferenceSettings

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

Returns

setIncomingCallListener

Copy URL
fun setIncomingCallListener(listener: 

IncomingCallListener?

):

Unit

This API is in beta and subject to change.

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

createLocalVideoStream

Copy URL
fun createLocalVideoStream(videoSource: 

VideoSource

):

LocalVideoStream?

This API is in beta and subject to change.

Creates a local video stream using the provided video source

Video source can be one the following:

  1. CallManager - to capture the video from a device camera
  2. ScreenCaptureVideoSource - to capture a device screen
  3. CustomVideoSource - to capture a custom video frames

Parameters

  • videoSource:

    VideoSource

    The video source for the local video stream

Returns

getInstance

Copy URL
@JvmStatic
@JvmOverloads
fun getInstance(context:

Context

,
callsConfig:

CallManagerConfig?

):

CallManager

Parameters

Returns

Props

calls

Copy URL
val calls: 

Map<String, Call>

This API is in beta and subject to change.

Returns all active calls.

Returns

  • type:

    Map<String, Call>

conferences

Copy URL
val conferences: 

Map<String, Conference>

This API is in beta and subject to change.

Returns all active conferences.

Returns