Skip to main content

Permissions

A reference for the common permission identifiers.

Video

A full list of possible permissions to be used when creating Room Tokens. Send a list of the names to specify fine grained permissions for each Room member.

Permission NameDescription
room.hide_video_mutedHide the videos of members with muted video.
room.show_video_mutedShow the videos of members with muted video.
room.list_available_layoutsGet a list of available layouts.
room.playbackPlay custom video streams in the room.
room.recordingRecord the room and obtain access to the recordings.
room.set_layoutSet the current layout.
room.set_positionSet the position for multiple members at once.
room.set_metaSet the metadata for multiple members at once.
room.streamStart and control outbound streams.
room.stream.startStart outbound streams.
room.member.audio_muteMute the audio of any member in the room.
room.member.audio_unmuteUnmute the audio of any member in the room.
room.member.deafDeaf the audio of any member in the room.
room.member.undeafUndeaf the audio of any member in the room.
room.member.removeRemove any member from the room.
room.member.set_input_sensitivitySet the audio input sensitivity of any member in the room.
room.member.set_input_volumeSet the audio input volume of any member in the room.
room.member.set_output_volumeSet the audio output volume of any member in the room.
room.member.video_muteMute the video of any member in the room.
room.member.video_unmuteUnmute the video of any member in the room.
room.member.set_positionSet the position in layout for any member in the room.
room.member.set_metaSet the metadata for any member in the room.
room.self.additional_sourceAdd additional devices to the room to stream multiple sources.
room.self.audio_muteMute the audio of yourself.
room.self.audio_unmuteUnmute the audio of yourself.
room.self.deafDeaf the audio of yourself.
room.self.undeafUndeaf the audio of yourself.
room.self.screenshareShare your screen.
room.self.set_input_sensitivitySet your own audio input sensitivity.
room.self.set_input_volumeSet your own audio input volume.
room.self.set_output_volumeSet your own audio output volume.
room.self.video_muteMute your own video.
room.self.video_unmuteUnmute your own video.
room.self.set_positionSet your position in the layout.
room.self.set_metaSet your own metadata in the room.

Default Permissions

By default, a token is created with the following permissions:

  • room.self.audio_mute
  • room.self.audio_unmute
  • room.self.video_mute
  • room.self.video_unmute
  • room.self.deaf
  • room.self.undeaf
  • room.self.set_input_volume
  • room.self.set_output_volume
  • room.self.set_input_sensitivity
  • room.self.screenshare
  • room.self.additional_source

These default permissions allow the member to control their own audio and video settings without affecting the room settings or other members.