Hierarchy

  • default
    • ParticipantService

Accessors

  • get activeSpeaker(): Participant
  • It returns the currently active speaker as a Participant object. It returns null if no current active speaker is active in the current meeting.

    Returns Participant

  • get participants(): Participant[]
  • participants, property provides the array of participants in the meeting. Refer Participant, for the attributes of a participant.

    Returns Participant[]

  • get selfParticipant(): Participant
  • selfParticipant, property provides the information of your own participant. Refer to Participant, for the attributes structure of a participant.

    Returns Participant

  • get spotlightedParticipant(): Participant
  • It returns participant object of the spotlighted participant. It returns null if no participant is spotlighted in the current meeting.

    Returns Participant

Methods

  • Allows observing changes to properties. Provide the property which you are interested in and a callback. Whenever the property value changes, you will be notified via the callback.

    Usage:

    Example

    sdk.meetingService.participantService.observe("selfParticipant", function() {
    console.info("selfParticipant is changed to : ", sdk.meetingService.participantService.selfParticipant)
    });

    Parameters

    • property: keyof ParticipantService

      The name of the property to observe for changes.

    • callback: (() => void)

      on change event for the property.

        • (): void
        • Returns void

    Returns void

Generated using TypeDoc