Rate this page:

ConferenceListener

Interface that handles conference events.

Methods

onConferenceConnected

Copy URL
fun onConferenceConnected(conference: 

Conference

,
headers:

Map<String, String>?

):

Unit

This API is in beta and subject to change.

Triggered when conference is connected.

Parameters

  • conference:

    Conference

    Conference object that invoked the event

  • headers:

    Map<String, String>?

    Optional

    Optional SIP headers received with message

Returns

  • type:

    Unit

onConferenceDisconnected

Copy URL
fun onConferenceDisconnected(conference: 

Conference

,
headers:

Map<String, String>?

,
answeredElsewhere:

Boolean

):

Unit

This API is in beta and subject to change.

Triggered when the conference is disconnected.

Parameters

  • conference:

    Conference

    Conference object that invoked the event

  • headers:

    Map<String, String>?

    Optional

    Optional SIP headers received with message

  • answeredElsewhere:

    Boolean

    Whether the conference is answered on another device via SIP forking

Returns

  • type:

    Unit

onConferenceFailed

Copy URL
fun onConferenceFailed(conference: 

Conference

,
code:

Int

,
description:

String

,
headers:

Map<String, String>?

):

Unit

This API is in beta and subject to change.

Triggered if conference is failed.

Parameters

  • conference:

    Conference

    Conference object that invoked the event

  • code:

    Int

    Status code of the conference failure

  • description:

    String

    Status message of the conference failure

  • headers:

    Map<String, String>?

    Optional

    Optional SIP headers received with message

Returns

  • type:

    Unit

onSIPInfoReceived

Copy URL
fun onSIPInfoReceived(conference: 

Conference

,
type:

String

,
content:

String

,
headers:

Map<String, String>?

):

Unit

This API is in beta and subject to change.

Triggered when an INFO message is received.

Parameters

  • conference:

    Conference

    Conference object that invoked the event

  • type:

    String

    MIME type of INFO message

  • content:

    String

    Body of INFO message

  • headers:

    Map<String, String>?

    Optional

    Optional SIP headers received with message

Returns

  • type:

    Unit

onMessageReceived

Copy URL
fun onMessageReceived(conference: 

Conference

,
text:

String

):

Unit

This API is in beta and subject to change.

Triggered when a message is received within the conference.

Implemented atop SIP INFO for communication between conference endpoint and Voximplant cloud, and is separated from Voximplant messaging API.

Parameters

  • conference:

    Conference

    Conference object that invoked the event

  • text:

    String

    Content of the message

Returns

  • type:

    Unit

onEndpointAdded

Copy URL
fun onEndpointAdded(conference: 

Conference

,
endpoint:

Endpoint

):

Unit

This API is in beta and subject to change.

Triggered when new endpoint is added to the conference. It is recommended to set Endpoint.setEndpointListener for the new endpoint, when this event is triggered.

Parameters

  • conference:

    Conference

    Conference object that invoked the event

  • endpoint:

    Endpoint

    New endpoint

Returns

  • type:

    Unit

onEndpointRemoved

Copy URL
fun onEndpointRemoved(conference: 

Conference

,
endpoint:

Endpoint

):

Unit

This API is in beta and subject to change.

Triggered after endpoint is removed from the conference. Event is not triggered on conference end.

Parameters

  • conference:

    Conference

    Conference object that invoked the event

  • endpoint:

    Endpoint

    Removed endpoint

Returns

  • type:

    Unit

onConferenceStatsReceived

Copy URL
fun onConferenceStatsReceived(conference: 

Conference

,
conferenceStats:

ConferenceStats

):

Unit

This API is in beta and subject to change.

Triggered periodically with interval configured with CallManagerConfig.statsCollectionInterval with conference statistics.

Parameters

Returns

  • type:

    Unit

onConferenceReconnecting

Copy URL
fun onConferenceReconnecting(conference: 

Conference

):

Unit

This API is in beta and subject to change.

Triggered when the connection to the Voximplant Cloud is lost due to a network issues and media streams may be interrupted in the conference.

Once the connection to the Voximplant Cloud is restored and media streams are active, ConferenceListener.onConferenceReconnected event is triggered.

Until ConferenceListener.onConferenceReconnected event is invoked, the following API calls will fail with CallError.InvalidCallState error:

  1. Conference.startScreenSharing
  2. Conference.stopScreenSharing
  3. Conference.addVideoStream
  4. Conference.removeVideoStream

Parameters

  • conference:

    Conference

    Conference object that invoked the event

Returns

  • type:

    Unit

onConferenceReconnected

Copy URL
fun onConferenceReconnected(conference: 

Conference

):

Unit

This API is in beta and subject to change.

Triggered when the connection to the Voximplant Cloud is restored and media stream are active in the call.

Parameters

  • conference:

    Conference

    Conference object that invoked the event

Returns

  • type:

    Unit

onLocalVoiceActivityChanged

Copy URL
fun onLocalVoiceActivityChanged(conference: 

Conference

,
voiceDetected:

Boolean

):

Unit

This API is in beta and subject to change.

Triggered when a voice activity is detected from the current participant.

Parameters

  • conference:

    Conference

    Conference object that invoked the event

  • voiceDetected:

    Boolean

Returns

  • type:

    Unit