Interface: ConferenceListener

ConferenceListener

ConferenceListener interface defines a set of methods which are used for notifying local participant about changes in the Conference. Notifications are always sent for changes that were caused by the application or by the actions of remote participants, but they are never sent for changes that were caused by the actions of the local participant himself. For example, if the conference was renamed by the remote participant, then ConferenceListener#onConferenceNameChanged method would be called, but if it was the local participant who renamed the conference by calling Conference#setName method, then no notification would be sent.

Methods

onConferenceEnded()

Notifies the local participant about the end of the conference. The conference could be ended by the application or by any remote participant who played a role of MODERATOR.

onConferenceMessageReceived(message)

Notifies the local participant about receiving a new message addressed to all the participants in the conference. The message could be send by any remote participant.

Parameters:
Name Type Description
message Message

The received message

onConferenceNameChanged(name)

Notifies the local participant about changing the name of the conference. The name of the conference could be changed by the application or by any remote participant who played a role of MODERATOR.

Parameters:
Name Type Description
name String

The new name of the conference

onConferenceRecordingStarted()

Notifies the local participant about starting or resuming recording of the conference. The conference recording could be started/resumed by the application or by any remote participant who played a role of MODERATOR.

onConferenceRecordingStopped()

Notifies the local participant about stopping or pausing recording of the conference. The conference recording could be stopped/paused by the application or by any remote participant who played a role of MODERATOR.

onNetworkQualityChanged(quality)

Notifies the local participant about changing in network quality. 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)

Notifies the local participant about a remote participant who left the conference on his own will. of MODERATOR.

Parameters:
Name Type Description
participant Participant

The local or remote participant who left the conference

onParticipantExpelled(participant)

Notifies the local participant about the local or remote participant who was expelled from the conference for by the application or by a remote participant who played a role of MODERATOR.

Parameters:
Name Type Description
participant Participant

The local or remote participant who was expelled from the conference

onParticipantJoined(participant)

Notifies the local participant about a new remote participant who joined the conference.

Parameters:
Name Type Description
participant Participant

The remote participant who joined the conference

onParticipantLayoutChanged(participant, layout)

Notifies the local participant about changing the layout of the local or remote participant. The layout of the participant could be changed by himself, by the application or by any remote participant who played a role of MODERATOR. This notification is fired for the local participant only if his layout was changed by somebody else.

Parameters:
Name Type Description
participant Participant

The local or remote participant whose layout was changed

layout ConferenceLayout

The new layout of the participant

onParticipantMediaChanged(participant)

Notifies the local participant about changes in primary media stream of the remote participant. The notification could be about starting streaming the new (previously not streamed) video or audio track, or about stopping streaming the old (previously streamed) video or audio track.

Parameters:
Name Type Description
participant Participant

The remote participant whose primary media stream was changed

onParticipantMessageReceived(participant, message)

Notifies the local participant about receiving a new message addressed to him (aka a private message). The message could be send by any remote participant.

Parameters:
Name Type Description
participant Participant

The local participant whom the messages is addressed to

message Message

The received message

onParticipantNameChanged(participant, name)

Notifies the local participant about changing the name of the local or remote participant. The name of the participant could be changed by himself, by the application or by any remote participant who played a role of MODERATOR. This notification is fired for the local participant only if his name was changed by somebody else.

Parameters:
Name Type Description
participant Participant

The local or remote participant whose name was changed

name String

The new name of the participant

onParticipantRoleChanged(participant, role)

Notifies the local participant about changing the role of the local or remote participant. The role of the participant could be changed by himself, by the application or by any remote participant who played a role of MODERATOR. This notification is fired for the local participant only if his role was changed by somebody else.

Parameters:
Name Type Description
participant Participant

The local or remote participant whose role was changed

role ParticipantRole

The new role of the participant

onParticipantSecondaryMediaChanged(participant)

Notifies the local participant about changes in secondary Media stream of the remote participant. The notification could be about starting streaming the new (previously not streamed) video or audio track, or about stopping streaming the old (previously streamed) video or audio track.

Parameters:
Name Type Description
participant Participant

The remote participant whose secondary media stream was changed