Skip to content

RoleType

Ajša Terko edited this page Jul 23, 2025 · 1 revision



default

Description

Role type value for DefaultRole. Participants with this role are visible and audible by everyone in the conference. If no specific role is provided when joining a participant into conference, this role type will be assigned to them.



listener

Description

Role type value for ListenerRole. Participants with this role have certain restrictions when it comes to sharing media - they cannot turn on their camera, share their screen, unmute their microphone, or send DTMF. However, they can still send text through the data channel.



monitor

Description

Role type value for MonitorRole. Participants with this role are fully restricted from sharing media - they cannot turn on their camera, share their screen, unmute their microphone, send DTMF, or send text through data channel. Participants with this role are invisible to others in the conference. As a result, remote participants will not receive a ParticipantJoinedEvent event when a participant with this role joins. If a participant transitions from a visible role to Monitor, all participants to whom they should no longer be visible will receive a ParticipantLeftEvent event. Also, if a participant transitions to this role while their camera video, screen share, or audio is on, all of it will be disabled automatically, and participant will receive corresponding CameraVideoRemovedEvent or ScreenShareRemovedEvent events with reason roleChanged.



advisor

Description

Role type value for AdvisorRole. Participants with this role are visible and audible only by a subset of participants who are specified in advise array. Additionally, they can only send text through data channel to participants in that array. They are invisible to other participants in the conference. As a result, remote participants will not receive ParticipantJoinedEvent events, nor will they be able to hear or see the audio and video content produced by participant with this role. If a participant transitions from a visible role to Advisor, all participants to whom they should no longer be visible will receive a ParticipantLeftEvent event.



auditor

Description

Role type value for AuditorRole. Participants with this role are fully restricted from sharing media - they cannot turn on their camera, share their screen, unmute their microphone, send DTMF, or send text through data channel. Participants with this role are invisible to others in the conference. As a result, remote participants will not receive a ParticipantJoinedEvent event when a participant with this role joins. If a participant transitions from a visible role to Auditor, all participants to whom they should no longer be visible will receive a ParticipantLeftEvent event. Also, if a participant transitions to this role while their camera video, screen share, or audio is on, all of it will be disabled automatically, and participant will receive corresponding CameraVideoRemovedEvent or ScreenShareRemovedEvent events with reason roleChanged. The difference compared to monitor is that this role can see all other participants, regardless of their role. For example, they can see Advisors (even if the particular Advisor is not advising them), Monitors, other Auditors, as well as Listeners, and Default roles.

Tutorials

Migration guides

Reference documentation

Clone this wiki locally