Customization Object

The Customization object is used in both Create Room and Join Room APIs to configure the UI/UX of the classroom.

Schema

{
  "showLobby": boolean,
  "showClassTitle": boolean,
  "showLogo": boolean,
  "showHeader": boolean,
  "showParticipantName": boolean,
  "showMicIndicator": boolean,
  "needChat": boolean,
  "needControlbar": boolean,
  "allowScreenShare": boolean,
  "allowHandRaise": boolean,
  "allowRecording": boolean,
  "allowIngress": boolean,
  "validateDomain": boolean,
  "theme": "system" | "light" | "dark"
}

Properties

Key	Type	Default	Description
showLobby	boolean	true	Show audio/video setup screen before joining room.
showClassTitle	boolean	true	Display the room title in the header.
showLogo	boolean	true	Show organization logo (if configured).
showHeader	boolean	true	Show the top navigation bar.
showParticipantName	boolean	true	Show participant names on their video tiles.
showMicIndicator	boolean	true	Show microphone muted/active icon on video tiles.
needChat	boolean	true	Enable chat sidebar functionality.
needControlbar	boolean	true	Show the bottom control bar (mute, video, screenshare buttons).
allowScreenShare	boolean	true	Allow this participant to share their screen.
allowHandRaise	boolean	true	Allow this participant to use the Hand Raise feature.
allowRecording	boolean	true	Allow this participant to start/stop recordings.
allowIngress	boolean	false	Allow injecting RTMP streams into the room.
validateDomain	boolean	true	Enforce domain validation for iframe embedding security.
theme	string	system	UI Color theme. Options: system (follows OS), light, dark.

Usage Examples

Minimal Viewer

Hides all controls for a passive "webinar" style viewer.

{
  "showLobby": false,
  "needChat": false,
  "needControlbar": false,
  "allowScreenShare": false,
  "theme": "dark"
}

Student Restricted

Standard student view but prevents recording.

{
  "showLobby": true,
  "needChat": true,
  "allowHandRaise": true,
  "allowRecording": false,
  "allowScreenShare": true
}