Interface: ConferenceListener

ConferenceListener

ConferenceListener can be used for getting notifications of all changes in the Conference that were made by the application and remote participants. For example, if one of the remote participants who played a role of a moderator changed the name of the conference, then onConferenceNameChanged method of the listener would be called.

Methods

onConferenceEnded(conference)

This method is called when the conference is ended by the application.

Parameters:
Name Type Description
conference Conference

The conference that was ended.

onConferenceMessageReceived()

Deprecated:
  • Either #onMeReceivedMessageFromApplication and #onMeReceivedMessageFromParticipant instead.

onConferenceNameChanged(name)

This method is called when the name of the conference is changed by either the application or a moderator.

Parameters:
Name Type Description
name String

The new name of the conference.

onConferenceRecordingStarted(conference)

This method is called when the recording of the conference is started or resumed by either the application or a moderator.

Parameters:
Name Type Description
conference Conference

The conference the recording of which was started or resumed.

onConferenceRecordingStopped(conference)

This method is called when the recording of the conference is paused or stopped by either the application or a moderator.

Parameters:
Name Type Description
conference Conference

The conference the recording of which was paused or stopped.

onMeExpelled(me)

This method is called when the local participant is expelled from the conference by the application only.

Parameters:
Name Type Description
me Me

The local participant who was expelled from the conference.

onMeLayoutChanged(me)

This method is called when the layout of the local participant is changed by either the application or a moderator.

Parameters:
Name Type Description
me Me

The local participant whose layout was changed.

onMeNameChanged(me)

This method is called when the name of the local participant is changed by either the application or a moderator.

Parameters:
Name Type Description
me Me

The local participant whose name was changed.

onMeReceivedMessageFromApplication(me, message)

This method is called when the local participant receives a message from the application.

Parameters:
Name Type Description
me Me

The local participant whose received the message.

message String

The text of the message.

onMeReceivedMessageFromParticipant(me, message, participant)

This method is called when the local participant receives a message from a remote participant.

Parameters:
Name Type Description
me Me

The local participant whose received the message.

message String

The text of the message.

participant Participant

The remote participant who sent the message.

onMeRoleChanged(me)

This method is called when the role of the local participant is changed by either the application or a moderator.

Parameters:
Name Type Description
me Me

The local participant whose role was changed.

onNetworkQualityChanged(quality)

This method is called when the quality of the network changes. The quality is estimated as mean opinion score which is in range from 0 to 5, where 0 means no network connection at all and 5 means excellent network.

Parameters:
Name Type Description
quality Number

The estimated quality of the network as a number in range from 0 to 5.

onParticipantExited(participant)

This method is called when a remote participant leaves the conference because of his own will or because the application expelled him.

Parameters:
Name Type Description
participant Participant

The remote participant who left the conference.

onParticipantExpelled()

Deprecated:
  • Use #onMeExpelled instead.

onParticipantJoined(participant)

This method is called when a remote participant joins the conference.

Parameters:
Name Type Description
participant Participant

The remote participant who joined the conference.

onParticipantLayoutChanged(participant)

This method is called when the layout of a remote participant is changed by the application or by a moderator or by the participant himself.

Parameters:
Name Type Description
participant Participant

The remote participant whose layout was changed.

onParticipantMediaChanged(participant)

This method is called when a remote participant starts or stops streaming his primary audio or/and video.

Parameters:
Name Type Description
participant Participant

The remote participant who started or stopped streaming his primary audio or/and video.

onParticipantNameChanged(participant)

This method is called when the name of a remote participant is changed by the application or by a moderator or by the participant himself.

Parameters:
Name Type Description
participant Participant

The remote participant whose name was changed.

onParticipantRoleChanged(participant)

This method is called when the role of a remote participant is changed by either the application or a moderator.

Parameters:
Name Type Description
participant Participant

The remote participant whose role was changed.

onParticipantSecondaryMediaChanged(participant)

This method is called when a remote participant starts or stops streaming his secondary audio or/and video.

Parameters:
Name Type Description
participant Participant

The remote participant who started or stopped streaming his secondary audio or/and video.