Avaya Client Services API Reference (Windows)
Avaya Client Services API Reference (Windows)
Avaya.ClientServices
ActiveParticipant Class
ActiveParticipant Properties
AssignAsLecturerCapability Property
AssignAsModeratorCapability Property
AssignAsPresenterCapability Property
AudioStatus Property
BlockVideoCapability Property
CameraRemoteControlCapability Property
ConnectionStatus Property
EntryTime Property
HandLoweredTime Property
HandRaisedTime Property
InConferencePrivateChatCapability Property
IsActiveAudioParticipant Property
IsActiveVideoParticipant Property
IsApplicationSharingActive Property
IsAudioMutedByServer Property
isCameraRemoteControllable Property
IsHandRaised Property
IsLecturer Property
IsModerator Property
IsPresenter Property
IsRestrictedParticipant Property
IsVideoBlockedByServer Property
LastSpokenTime Property
LowerHandAndUnmuteAudioCapability Property
LowerHandCapability Property
MuteCapability Property
UnassignAsLecturerCapability Property
UnassignAsPresenterCapability Property
UnblockVideoCapability Property
UnmuteCapability Property
VideoChannelId Property
VideoPinCapability Property
VideoStatus Property
WasPreviouslyNotVisibleInParticipantList Property

# ActiveParticipant Properties

The ActiveParticipant type exposes the following members.

Properties

| Name | Description
--- | --- | ---
| Address | Participant's network-provided address, as known to the conferencing system. (Inherited from Participant.)
| AssignAsLecturerCapability | Capability info indicating whether local user can set a selected participant as lecturer. The capability returns not supported if the conference call does not support selection of a participant as the lecturer, or if the local user does not have permission to set a participant as the lecturer on the call.
| AssignAsModeratorCapability | Capability info indicating whether local user can set a selected participant as moderator. The capability returns not supported if the conference call does not support selection of a participant as the moderator, or if the local user does not have permission to set a participant as the moderator on the call.
| AssignAsPresenterCapability | Capability info indicating whether local user can assign a selected participant as presenter.The capability returns not supported if the conference call does not support selection of a participant as the presenter, or if the local user does not have permission to assign a participant as the presenter on the call.
| AudioStatus | Participant's audio status, as known by the conferencing system.
| BlockVideoCapability | Capability info indicating local user can block a selected participant's video. The capability returns not supported if the conference call does not support control of another participant's video, or if the local user does not have permission to block another participant's video on the call.
| CameraRemoteControlCapability | Capability info indicating whether local user can control the participant's camera. Typically, a conference room system's camera is remotely controllable, where position/tilt/zoom (PTZ) of the camera can be controlled programmatically. The capability returns not supported if the participant does not have a remote controllable camera.
| ConnectionStatus | ParticipantData's connection status (connecting, connected, disconnecting, etc.), as known to the conferencing system.
| DisplayName | Participant's network-provided display name, as known to the conferencing system. (Inherited from Participant.)
| EntryTime | Participant's entry time to the conference.
| HandLoweredTime | The time participant has lowered hand.
| HandRaisedTime | The time participant has raised hand.
| Id | Participant's unique id as given by the conference system. (Inherited from Participant.)
| InConferencePrivateChatCapability | Returns whether the user supports private chat in conference.
| IsActiveAudioParticipant | Information as to whether the participant is an active talker.
| IsActiveVideoParticipant | Information as to whether the participant is an active video participant.
| IsApplicationSharingActive | Information as to whether the participant's web collaboration is active.
| IsAudioMutedByServer | Information as to whether participant's audio sending to other participants is blocked by server. Could happen if moderator has muted participant's audio, or participant has sent request to mute own audio (network operation or DTMF digit). Remarks Local user can unmute participant's audio based on participant's capabilities.
| isCameraRemoteControllable | Information as to whether the participant's camera is controllable.
| IsHandRaised | Determines whether the participant's hand is raised.
| IsLecturer | Information as to whether the participant is a lecturer.
| IsLocalUser | Information as to whether the participant is the local user. (Inherited from Participant.)
| IsModerator | Information as to whether the participant is a moderator.
| IsPresenter | Information as to whether the participant is a presenter.
| IsRestrictedParticipant | A Boolean value indicating whether the participant has limited capabilities on the call. Restricted participant cannot be lecturer or presenter and cannot become a normal participant. Restricted participant has no moderator controls and can only have a single receive-only video stream. Restricted participant cannot unblock camera and send video, or cannot perform remote camera control operations (e.g., control camera of a remote room system). Restricted participant is muted by the conference server by default, and can only be unmuted by the moderator, e.g., by getting moderator's attention to be unmuted through raise hand mechanism.
| IsVideoBlockedByServer | Information as to whether participant's video sending to other participants is blocked by server. Could happen if moderator has blocked participant's video, or participant has sent request to block own video (network operation or DTMF digit). Remarks Local user can unblock participant's video based on participant's capabilities.
| LastSpokenTime | Participant's last spoken time.
| LowerHandAndUnmuteAudioCapability | Capability info indicating whether local user can lower participant's hand and unmute audio.
| LowerHandCapability | Capability info indicating whether local user can lower a raised hand on the conference call. The capability returns not supported if the conference call does not support raise hand feature, or if the local user does not have permission to lower another participant's hand.
| MuteCapability | Capability info indicating whether local user can mute a selected participant. The capability returns not supported if the conference call does not support muting of selected participant, or if the local user does not have permission to mute another participant on the call.
| UnassignAsLecturerCapability | Capability info indicating whether local user can unset a selected participant as lecturer. The capability returns not supported if the conference call does not support unselection of a participant as the lecturer, or if the local user does not have permission to unset a participant as the lecturer on the call.
| UnassignAsPresenterCapability | Capability info indicating whether local user can unassign a selected participant as presenter.The capability returns not supported if the conference call does not support deselection of a participant as the presenter, or if the local user does not have permission to unassign a participant as the presenter on the call.
| UnblockVideoCapability | Capability info indicating local user can unblock a selected participant's video. The capability returns not supported if the conference call does not support control of another participant's video, or if the local user does not have permission to unblock another participant's video on the call.
| UnmuteCapability | Capability info indicating whether local user can unmute a selected participant. The capability returns not supported if the conference call does not support unmuting of selected participant, or if the local user does not have permission to unmute another participant on the call.
| VideoChannelId | Video channel id associated with the video participant during multi video stream conference call.
| VideoPinCapability | Returns whether the local user can pin a current participant's video in a specific position of the current video layout. This capability returns not supported if the conference call does not support video pinning/unpinning, or video pin/unpin requests.
| VideoStatus | ParticipantData's video status, as known by the conferencing system.
| WasPreviouslyNotVisibleInParticipantList | A Boolean value indicating that the participant is on the conference call but was previously not listed in the conference roster. This can happen when there are more participants on the conference call than what can be provided by the conference server in the roster.

Top
See Also

#### Reference

ActiveParticipant Class
Avaya.ClientServices Namespace

© 2017 Avaya LLC. All Rights Reserved.