Class: ActiveParticipant

Constructor

new ActiveParticipant(participantService, conference)

ActiveParticipant class represents an active conference participant.

Parameters:
Name Type Description
participantService AvayaClientServices.Services.Conference.ParticipantService
conference AvayaClientServices.Services.Conference.Conference

Methods

blockVideo() → {AvayaClientServices.Base.Promise}

Block video of this participant (moderator mute)

Returns:
{ AvayaClientServices.Base.Promise }

Promise associated with specific request.

changeParticipantName() → {AvayaClientServices.Base.Promise}

Change participant name in VMR

Parameters:
Type Description
String
Returns:
{ AvayaClientServices.Base.Promise }

Promise associated with specific request.

controlRemoteCamera(action) → {AvayaClientServices.Base.Promise}

control remote camera

Parameters:
Name Type Description
action AvayaClientServices.Services.Conference.CameraControl
Returns:
{ AvayaClientServices.Base.Promise }

Promise associated with specific request.

getAddress() → {string}

Returns participant's address

Inherited From:
Returns:
{ string }

getAllPossibleContactMatches() → {AvayaClientServices.Services.Contacts.MatchedContactsWithMatchLevel|undefined}

Return all possible contact matches or undefined if there are no matches.

Inherited From:
Returns:

getBestContactMatch() → {AvayaClientServices.Services.Contacts.Contact|undefined}

Return best possible contact match. If no match was found, undefined is returned.

Inherited From:
Returns:

getContentFromParticipant() → {AvayaClientServices.Services.Conference.ContentFromParticipantStatus}

Get participant contentFrom status.

Returns:

getContentToParticipant() → {AvayaClientServices.Services.Conference.MediaToParticipantStatus}

Get participant contentTo status.

Returns:

getDisplayName() → {string}

Returns participant's display name.

Inherited From:
Returns:
{ string }

getFeccRecvSupport() → {boolean}

Get participant feccRecvSupport status.

Returns:
{ boolean }

getJoinTime() → {date}

Get participant joined time.

Returns:
{ date }

getLastSpokenTime() → {date}

Get participant last spoken time.

Returns:
{ date }

getParticipantAudioStatus() → {AvayaClientServices.Services.Conference.MediaFromParticipantStatus}

Get audio from participant status.

Returns:

getParticipantConnectionStatus() → {AvayaClientServices.Services.Conference.ParticipantConnectionStatus}

Get participant connection status.

Returns:

getParticipantId() → {string}

Returns participant's unique id.

Inherited From:
Returns:
{ string }

getParticipantVideoStatus() → {AvayaClientServices.Services.Conference.MediaFromParticipantStatus}

Get video from participant status.

Returns:

getRole() → {AvayaClientServices.Services.Conference.ParticipantRole}

Get participant role

Returns:

isAudioMuted() → {boolean}

Get participant audio muted status.

Returns:
{ boolean }

isConferenceOwner() → {boolean}

Is conference owner

Returns:
{ boolean }

isHandRaised() → {boolean}

Get participant raised hand status.

Returns:
{ boolean }

isLecturer() → {boolean}

Get participant lecturer status.

Returns:
{ boolean }

isLocalUser() → {boolean}

Returns true, if participant is self.

Inherited From:
Returns:
{ boolean }

isModerator() → {boolean}

Check if this participant has a moderator role.

Returns:
{ boolean }

isPresenter() → {boolean}

Get participant presenter status.

Returns:
{ boolean }

isRestrictedParticipant() → {boolean}

Check if this participant has a restricted participant role.

Returns:
{ boolean }

isVideoBlocked() → {boolean}

Get participant video blocked status.

Returns:
{ boolean }

lowerHand(boolean) → {AvayaClientServices.Base.Promise}

Called to lower participant's hand on the conference call. Available only for moderators.

Parameters:
Name Type Description
boolean

unmuteAudio - true: make this participant not muted; false: keep current mute status and just lower the hand

Returns:
{ AvayaClientServices.Base.Promise }

Promise associated with specific request.

mute() → {AvayaClientServices.Base.Promise}

Mute this participant (moderator mute)

Returns:
{ AvayaClientServices.Base.Promise }

Promise associated with specific request.

<protected> setAddress(address)

Sets participant's address.

Parameters:
Name Type Description
address string
Inherited From:

setAsLecturer() → {AvayaClientServices.Base.Promise}

Set this participant as the conference lecturer.

Returns:
{ AvayaClientServices.Base.Promise }

Promise associated with specific request.

setDisplayName(displayName)

Returns participant's display name.

Parameters:
Name Type Description
displayName string
Inherited From:

unblockVideo() → {AvayaClientServices.Base.Promise}

Unblock video of this participant

Returns:
{ AvayaClientServices.Base.Promise }

Promise associated with specific request.

unmute() → {AvayaClientServices.Base.Promise}

Unmute this participant

Returns:
{ AvayaClientServices.Base.Promise }

Promise associated with specific request.

unsetAsLecturer() → {AvayaClientServices.Base.Promise}

Unset this participant as lecturer

Returns:
{ AvayaClientServices.Base.Promise }

Promise associated with specific request.

wasPreviouslyNotVisibleInParticipantList() → {boolean}

Check if this participant was hidden in participant list.

Returns:
{ boolean }

Managing callbacks

addOnParticipantActiveTalkerStatusChangedCallback(callback) → {void}

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.ActiveParticipant#onParticipantActiveTalkerStatusChangedCallback

Function to be called

Returns:
{ void }

addOnParticipantAudioStatusChangedCallback(callback) → {void}

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.ActiveParticipant#onParticipantAudioStatusChangedCallback

Function to be called

Returns:
{ void }

addOnParticipantCollaborationStatusChangedCallback(callback) → {void}

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.ActiveParticipant#onParticipantCollaborationStatusChangedCallback

Function to be called

Returns:
{ void }

addOnParticipantConnectionStatusChangedCallback(callback) → {void}

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.ActiveParticipant#onParticipantConnectionStatusChangedCallback

Function to be called

Returns:
{ void }

addOnParticipantDisplayNameChangedCallback(callback) → {void}

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.ActiveParticipant#onParticipantDisplayNameChangedCallback

Function to be called

Returns:
{ void }

addOnParticipantHandLoweredCallback(callback) → {void}

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.ActiveParticipant#onParticipantHandLoweredCallback

Function to be called

Returns:
{ void }

addOnParticipantHandRaisedCallback(callback) → {void}

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.ActiveParticipant#onParticipantHandRaisedCallback

Function to be called

Returns:
{ void }

addOnParticipantNameChangedCallback(callback) → {void}

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.ActiveParticipant#onParticipantNameChangedCallbacks

Function to be called

Returns:
{ void }

addOnParticipantSetAsLecturerCallback(callback) → {void}

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.ActiveParticipant#onParticipantSetAsLecturerCallback

Function to be called

Returns:
{ void }

addOnParticipantSetAsModeratorCallback(callback) → {void}

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.ActiveParticipant#onParticipantSetAsModeratorCallback

Function to be called

Returns:
{ void }

addOnParticipantSetAsPresenterCallback(callback) → {void}

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.ActiveParticipant#onParticipantSetAsPresenterCallback

Function to be called

Returns:
{ void }

addOnParticipantStatusChangedCallback(callback) → {void}

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.ActiveParticipant#onParticipantStatusChangedCallback

Function to be called

Returns:
{ void }

addOnParticipantUnsetAsLecturerCallback(callback) → {void}

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.ActiveParticipant#onParticipantUnsetAsLecturerCallback

Function to be called

Returns:
{ void }

addOnParticipantUnsetAsModeratorCallback(callback) → {void}

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.ActiveParticipant#onParticipantUnsetAsModeratorCallback

Function to be called

Returns:
{ void }

addOnParticipantUnsetAsPresenterCallback(callback) → {void}

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.ActiveParticipant#onParticipantUnsetAsPresenterCallback

Function to be called

Returns:
{ void }

addOnParticipantVideoStatusChangedCallback(callback) → {void}

Add callback on specific event

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.ActiveParticipant#onParticipantVideoStatusChangedCallback

Function to be called

Returns:
{ void }

removeOnParticipantActiveTalkerStatusChangedCallback(callback) → {void}

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.ActiveParticipant#onParticipantActiveTalkerStatusChangedCallback

Function to be removed

Returns:
{ void }

removeOnParticipantAudioStatusChangedCallback(callback) → {void}

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.ActiveParticipant#onParticipantAudioStatusChangedCallback

Function to be removed

Returns:
{ void }

removeOnParticipantCollaborationStatusChangedCallback(callback) → {void}

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.ActiveParticipant#onParticipantCollaborationStatusChangedCallback

Function to be removed

Returns:
{ void }

removeOnParticipantConnectionStatusChangedCallback(callback) → {void}

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.ActiveParticipant#onParticipantConnectionStatusChangedCallback

Function to be removed

Returns:
{ void }

removeOnParticipantDisplayNameChangedCallback(callback) → {void}

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.ActiveParticipant#onParticipantDisplayNameChangedCallback

Function to be removed

Returns:
{ void }

removeOnParticipantHandLoweredCallback(callback) → {void}

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.ActiveParticipant#onParticipantHandLoweredCallback

Function to be removed

Returns:
{ void }

removeOnParticipantHandRaisedCallback(callback) → {void}

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.ActiveParticipant#onParticipantHandRaisedCallback

Function to be removed

Returns:
{ void }

removeOnParticipantNameChangedCallback(callback) → {void}

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.ActiveParticipant#onParticipantNameChangedCallbacks

Function to be removed

Returns:
{ void }

removeOnParticipantSetAsLecturerCallback(callback) → {void}

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.ActiveParticipant#onParticipantSetAsLecturerCallback

Function to be removed

Returns:
{ void }

removeOnParticipantSetAsModeratorCallback(callback) → {void}

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.ActiveParticipant#onParticipantSetAsModeratorCallback

Function to be removed

Returns:
{ void }

removeOnParticipantSetAsPresenterCallback(callback) → {void}

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.ActiveParticipant#onParticipantSetAsPresenterCallback

Function to be removed

Returns:
{ void }

removeOnParticipantStatusChangedCallback(callback) → {void}

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.ActiveParticipant#onParticipantStatusChangedCallback

Function to be removed

Returns:
{ void }

removeOnParticipantUnsetAsLecturerCallback(callback) → {void}

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.ActiveParticipant#onParticipantUnsetAsLecturerCallback

Function to be removed

Returns:
{ void }

removeOnParticipantUnsetAsModeratorCallback(callback) → {void}

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.ActiveParticipant#onParticipantUnsetAsModeratorCallback

Function to be removed

Returns:
{ void }

removeOnParticipantUnsetAsPresenterCallback(callback) → {void}

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.ActiveParticipant#onParticipantUnsetAsPresenterCallback

Function to be removed

Returns:
{ void }

removeOnParticipantVideoStatusChangedCallback(callback) → {void}

Remove previously added callback

Parameters:
Name Type Description
callback AvayaClientServices.Services.Conference.ActiveParticipant#onParticipantVideoStatusChangedCallback

Function to be removed

Returns:
{ void }

Callbacks

addOnParticipantMatchedContactsChangedCallback(callback) → {void}

Adds new onParticipantMatchedContactsChangedCallback.

Parameters:
Name Type Description
callback AvayaClientServices.Services.Participant#onParticipantMatchedContactsChangedCallback

Function to be called

Inherited From:
Returns:
{ void }

removeOnParticipantMatchedContactsChangedCallback(callback) → {void}

Removes existing onParticipantMatchedContactsChangedCallback.

Parameters:
Name Type Description
callback AvayaClientServices.Services.Participant#onParticipantMatchedContactsChangedCallback

Function to be removed

Inherited From:
Returns:
{ void }

Capabilities

getAssignParticipantAsLecturerCapability() → {AvayaClientServices.Base.Capability}

Returns the capability indicating if the participant can become a lecturer.

Inherited From:
Returns:

getBlockParticipantVideoCapability() → {AvayaClientServices.Base.Capability}

Returns the capability indicating if the video of participant can be blocked.

Inherited From:
Returns:

getChangeParticipantNameCapability() → {AvayaClientServices.Base.Capability}

Returns the capability indicating if the participant can change another participant name(if first one is owner of VRM)

Inherited From:
Returns:

getChangeRoleCapability() → {AvayaClientServices.Base.Capability}

Returns the capability indicating if the participant's role can be changed.

Inherited From:
Returns:

getLowerParticipantHandCapability() → {AvayaClientServices.Base.Capability}

Returns the capability indicating if the participant's hand can be lowered.

Inherited From:
Returns:

getMuteParticipantAudioCapability() → {AvayaClientServices.Base.Capability}

Returns the capability indicating if the audio of participant can be muted.

Inherited From:
Returns:

getRemoteCameraControlCapability() → {AvayaClientServices.Base.Capability}

Returns the capability indicating if the participant's remote camera can be controlled.

Inherited From:
Returns:

getUnblockParticipantVideoCapability() → {AvayaClientServices.Base.Capability}

Returns the capability indicating if the video of participant can be unblocked.

Inherited From:
Returns:

getUnmuteParticipantAudioCapability() → {AvayaClientServices.Base.Capability}

Returns the capability indicating if the audio of participant can be unmuted.

Inherited From:
Returns:

Type Definitions

onParticipantActiveTalkerStatusChangedCallback(participant, isActiveTalker) → {void}

Called to report that this participant's active talker status has changed.

Parameters:
Name Type Description
participant AvayaClientServices.Services.Conference.ActiveParticipant

Participant object that the callback is associated with

isActiveTalker boolean

Active talker status for this participant

Returns:
{ void }

onParticipantAudioStatusChangedCallback(participant, newStatus) → {void}

Called to report that the audio direction changed for this participant.

Parameters:
Name Type Description
participant AvayaClientServices.Services.Conference.ActiveParticipant

Participant object that the callback is associated with

newStatus AvayaClientServices.Services.Conference.MediaFromParticipantStatus

New audio status for this participant

Returns:
{ void }

onParticipantCollaborationStatusChangedCallback(participant) → {void}

Called to report that the collaboration status has changed for this participant.

Parameters:
Name Type Description
participant AvayaClientServices.Services.Conference.ActiveParticipant

Participant object that the callback is associated with Participant object that the callback is associated with

Returns:
{ void }

onParticipantConnectionStatusChangedCallback(participant) → {void}

Called to report that the connection status has changed for this participant.

Parameters:
Name Type Description
participant AvayaClientServices.Services.Conference.ActiveParticipant

Participant object that the callback is associated with Participant object that the callback is associated with

Returns:
{ void }

onParticipantDisplayNameChangedCallback(participant) → {void}

Called to report that this participant's name has changed.

Parameters:
Name Type Description
participant AvayaClientServices.Services.Conference.ActiveParticipant

Participant object that the callback is associated with

Returns:
{ void }

onParticipantHandLoweredCallback(participant) → {void}

Called to report that this participant's hand has lowered.

Parameters:
Name Type Description
participant AvayaClientServices.Services.Conference.ActiveParticipant

Participant object that the callback is associated with

Returns:
{ void }

onParticipantHandRaisedCallback(participant) → {void}

Called to report that this participant's hand has raised.

Parameters:
Name Type Description
participant AvayaClientServices.Services.Conference.ActiveParticipant

Participant object that the callback is associated with

Returns:
{ void }

onParticipantMatchedContactsChangedCallback(participant) → {void}

Interface for callback function to be invoked when matched contacts for this participant are changed.

Parameters:
Name Type Description
participant AvayaClientServices.Services.Participant

Participant the matched contacts of which were changed

Inherited From:
Returns:
{ void }

onParticipantSetAsLecturerCallback(participant) → {void}

Called to report that this participant is now the conference lecturer.

Parameters:
Name Type Description
participant AvayaClientServices.Services.Conference.ActiveParticipant

Participant object that the callback is associated with

Returns:
{ void }

onParticipantSetAsModeratorCallback(participant) → {void}

Called to report that this participant is now the conference moderator.

Parameters:
Name Type Description
participant AvayaClientServices.Services.Conference.ActiveParticipant

Participant object that the callback is associated with

Returns:
{ void }

onParticipantSetAsPresenterCallback(participant) → {void}

Called to report that this participant is now the conference presenter.

Parameters:
Name Type Description
participant AvayaClientServices.Services.Conference.ActiveParticipant

Participant object that the callback is associated with

Returns:
{ void }

onParticipantStatusChangedCallback(participant, status) → {void}

Called to report that the authorization status has changed for this participant.

Parameters:
Name Type Description
participant AvayaClientServices.Services.Conference.ActiveParticipant

Participant object that the callback is associated with Participant object that the callback is associated with

status AvayaClientServices.Services.Conference.ParticipantAuthorizationStatus
Returns:
{ void }

onParticipantUnsetAsLecturerCallback(participant) → {void}

Called to report that this participant is no longer the conference lecturer.

Parameters:
Name Type Description
participant AvayaClientServices.Services.Conference.ActiveParticipant

Participant object that the callback is associated with

Returns:
{ void }

onParticipantUnsetAsModeratorCallback(participant) → {void}

Called to report that this participant is no longer the conference moderator.

Parameters:
Name Type Description
participant AvayaClientServices.Services.Conference.ActiveParticipant

Participant object that the callback is associated with

Returns:
{ void }

onParticipantUnsetAsPresenterCallback(participant) → {void}

Called to report that this participant is no longer the conference presenter.

Parameters:
Name Type Description
participant AvayaClientServices.Services.Conference.ActiveParticipant

Participant object that the callback is associated with

Returns:
{ void }

onParticipantVideoStatusChangedCallback(participant, newStatus) → {void}

Called to report that the video direction changed for this participant.

Parameters:
Name Type Description
participant AvayaClientServices.Services.Conference.ActiveParticipant

Participant object that the callback is associated with

newStatus AvayaClientServices.Services.Conference.MediaFromParticipantStatus

New video status for this participant

Returns:
{ void }
©2016 Avaya Inc. All Rights Reserved.