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 participantsNamedJohn = meeting.participants.active.toArray()
  .filter((p) => p.name === 'John');

• RTKParticipant
  • .id
  • .userId
  • .name
  • .picture
  • .customParticipantId
  • .device
  • .videoTrack
  • .audioTrack
  • .screenShareTracks
  • .videoEnabled
  • .audioEnabled
  • .screenShareEnabled
  • .producers
  • .manualProducerConfig
  • .supportsRemoteControl
  • .presetName
  • .stageStatus
  • .isPinned
  • .pin()
  • .unpin()
  • .disableAudio()
  • .kick()
  • .disableVideo()
  • .registerVideoElement(videoElem)
  • .deregisterVideoElement([videoElem])

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

Kind: instance property of RTKParticipant

The user ID of the participant.

Kind: instance property of RTKParticipant

The name of the participant.

Kind: instance property of RTKParticipant

The picture of the participant.

Kind: instance property of RTKParticipant

The custom id of the participant set during https://developers.cloudflare.com/api/resources/realtime_kit/subresources/meetings/methods/add_participant ↗ REST API

Kind: instance property of RTKParticipant

The device configuration of the participant.

Kind: instance property of RTKParticipant

The participant's video track.

Kind: instance property of RTKParticipant

The participant's audio track.

Kind: instance property of RTKParticipant

The participant's screenshare video and audio track.

Kind: instance property of RTKParticipant

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

Kind: instance property of RTKParticipant

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

Kind: instance property of RTKParticipant

This is true if the participant is screensharing.

Kind: instance property of RTKParticipant

producers created by participant

Kind: instance property of RTKParticipant

producer config passed during manual subscription

Kind: instance property of RTKParticipant

This is true if the participant supports remote control.

Kind: instance property of RTKParticipant

The preset of the participant.

Kind: instance property of RTKParticipant

Denotes the participants's current stage status.

Kind: instance property of RTKParticipant

Returns true if the participant is pinned.

Kind: instance property of RTKParticipant

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

Kind: instance method of RTKParticipant

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

Kind: instance method of RTKParticipant

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

Kind: instance method of RTKParticipant

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

Kind: instance method of RTKParticipant

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

Kind: instance method of RTKParticipant

Kind: instance method of RTKParticipant

Kind: instance method of RTKParticipant