Click or drag to resize

ActiveParticipant Properties

The ActiveParticipant type exposes the following members.

Properties
  NameDescription
Public propertyAddress
Participant's network-provided address, as known to the conferencing system.
(Inherited from Participant.)
Public propertyAssignAsLecturerCapability
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.
Public propertyAssignAsModeratorCapability
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.
Public propertyAssignAsPresenterCapability
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.
Public propertyAudioStatus
Participant's audio status, as known by the conferencing system.
Public propertyBlockVideoCapability
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.
Public propertyCameraRemoteControlCapability
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.
Public propertyConnectionStatus
ParticipantData's connection status (connecting, connected, disconnecting, etc.), as known to the conferencing system.
Public propertyDisplayName
Participant's network-provided display name, as known to the conferencing system.
(Inherited from Participant.)
Public propertyEntryTime
Participant's entry time to the conference.
Public propertyHandLoweredTime
The time participant has lowered hand.
Public propertyHandRaisedTime
The time participant has raised hand.
Public propertyId
Participant's unique id as given by the conference system.
(Inherited from Participant.)
Public propertyInConferencePrivateChatCapability
Returns whether the user supports private chat in conference.
Public propertyIsActiveAudioParticipant
Information as to whether the participant is an active talker.
Public propertyIsActiveVideoParticipant
Information as to whether the participant is an active video participant.
Public propertyIsApplicationSharingActive
Information as to whether the participant's web collaboration is active.
Public propertyIsAudioMutedByServer
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.
Public propertyisCameraRemoteControllable
Information as to whether the participant's camera is controllable.
Public propertyIsHandRaised
Determines whether the participant's hand is raised.
Public propertyIsLecturer
Information as to whether the participant is a lecturer.
Public propertyIsLocalUser
Information as to whether the participant is the local user.
(Inherited from Participant.)
Public propertyIsModerator
Information as to whether the participant is a moderator.
Public propertyIsPresenter
Information as to whether the participant is a presenter.
Public propertyIsRestrictedParticipant
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.
Public propertyIsVideoBlockedByServer
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.
Public propertyLastSpokenTime
Participant's last spoken time.
Public propertyLowerHandAndUnmuteAudioCapability
Capability info indicating whether local user can lower participant's hand and unmute audio.
Public propertyLowerHandCapability
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.
Public propertyMuteCapability
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.
Public propertyUnassignAsLecturerCapability
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.
Public propertyUnassignAsPresenterCapability
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.
Public propertyUnblockVideoCapability
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.
Public propertyUnmuteCapability
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.
Public propertyVideoChannelId
Video channel id associated with the video participant during multi video stream conference call.
Public propertyVideoPinCapability
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.
Public propertyVideoStatus
ParticipantData's video status, as known by the conferencing system.
Public propertyWasPreviouslyNotVisibleInParticipantList
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