Skip to main content

DyteParticipant

Properties

Property nameData typeUse
idstringPeer ID of the participant
clientSpecificIdanyClient specific ID for this participant that was passed to the add participant API
namestringName set by the participant or as sent in the add participant API
picturestringURL of the participant picture, as sent in the add participant API
audioEnabledbooleanChecks if the participant is producing audio
videoEnabledbooleanChecks if the participant is producing video
audioTrackMediaStreamTrackAudio stream from the participant
videoTrackMediaStreamTrackVideo stream from the participant
isMebooleanChecks if the participant is the current participant, in which case it can be treated as DyteSelfParticipant
isPinnedbooleanChecks if the participant video is pinned (by the host, by the user, or by the preset)
metadata.preset_namestringThe preset that is applied to the participant
metadata.view_typeEnum (DyteViewTypes)The type of meeting view that the participant is in

Methods

Method nameParams (with data type)Use
pinPin the participant video to the grid for everyone in the meeting
unpinUnpin the participant video from the grid for everyone in the meeting
disableAudioDisable audio stream from another participant, effectively muting them for everyone in the meeting
disableVideoDisable video stream from another participant, effectively blanking them out for everyone in the meeting
zoomscale: number, x: number, y: numberZoom on to a participant's video for everyone in the meeting. Scale represents the scale of zoom whereas x and y represent the offset from center to reposition the video inside the container
sendMessagemessage: anySend custom event to the participant (see this section for more details)
updatePresetpreset_name: stringUpdate user preset dynamically

DyteViewTypes

DyteViewTypes is an enum that enumerates the different kind of meeting views, that are available to a participant in Dyte meeting.

DyteViewTypes {
"GROUP_CALL",
"WEBINAR"
}
TypeMeaning
GROUP_CALLA meeting where all participants are usually allowed to produce audio and video, useful for meetings where all participants are required to participate
WEBINARA meeting where only participant(s) with privilege permissions (a presenter or a group of presenters or a host or a group of hosts) are allowed to produce audio and video whereas the other participants may request permissions to ask questions or join as a presenter