RTKParticipant

This module represents a single participant in the meeting. The participant object can be accessed from one of the participant lists present in the meeting.participants object. For example,

const participant1 = meeting.participants.active.get(participantId);
const participant2 = meeting.participants.joined.get(participantId);
const participant3 = meeting.participants.active.toArray()[0];
const participant4 = meeting.participants.active
  .toArray()
  .filter((p) => p.name === 'John');

• RTKParticipant
  • this. ⏏
    • .id
    • .userId
    • .name
    • .picture
    • .customParticipantId
    • .clientSpecificId
    • .device
    • .videoTrack
    • .audioTrack
    • .screenShareTracks
    • .videoEnabled
    • .audioEnabled
    • .screenShareEnabled
    • .producers
    • .manualProducerConfig
    • .supportsRemoteControl
    • .presetName
    • .stageStatus
    • .mediaJoined
    • .socketJoined
    • .isPinned
    • .pin()
    • .unpin()
    • .setIsPinned()
    • .disableAudio()
    • .kick()
    • .disableVideo()
    • .updateVideo()

this. ⏏

NOTE(ishita1805): Added a fallback value to support hive group-call till stage support is not completed for hive.

Kind: Exported member

participant.id

The peer ID of the participant. The participants are indexed by this ID in the participant map.

participant.userId

The user ID of the participant.

participant.name

The name of the participant.

participant.picture

The picture of the participant.

participant.customParticipantId

The custom id of the participant set during Add Participant REST API

participant.clientSpecificId

Deprecated

participant.device

The device configuration of the participant.

participant.videoTrack

The participant's video track.

participant.audioTrack

The participant's audio track.

participant.screenShareTracks

The participant's screenshare video and audio track.

participant.videoEnabled

This is true if the participant's video is enabled.

participant.audioEnabled

This is true if the participant's audio is enabled.

participant.screenShareEnabled

This is true if the participant is screensharing.

participant.producers

producers created by participant

participant.manualProducerConfig

producer config passed during manual subscription

participant.supportsRemoteControl

This is true if the RealtimeKit participant supports remote control.

participant.presetName

The preset of the participant.

participant.stageStatus

Denotes the participants's current stage status.

participant.mediaJoined

Returns true if the local participant has joined the meeting.

participant.socketJoined

Returns true if the local participant has joined the meeting.

participant.isPinned

Returns true if the participant is pinned.

participant.pin()

Returns participant.id if user has permission to pin participants.

participant.unpin()

Returns participant.id if user has permission to unpin participants.

participant.setIsPinned()

participant.disableAudio()

Disables audio for this participant. Requires the permission to disable participant audio.

participant.kick()

Kicks this participant from the meeting. Requires the permission to kick a participant.

participant.disableVideo()

Disables video for this participant. Requires the permission to disable video for a participant.

participant.updateVideo()

Internal method, do not use