changeLayoutMode()

changeLayoutMode(mode: 'tiled' | 'auto')

Changes the layout mode according to the provided param - "tiled" or "auto" (automatic).

//Changes the layout mode to automatic
sambaFrame.changeLayoutMode('auto');

//Changes the layout mode to tiled
sambaFrame.changeLayoutMode('tiled');
circle-info

There are two layout modes provided inside the room - Tiled Mode (tiled) and Automatic Mode (auto).

In Automatic Mode the current active speaker is being displayed in a larger tile and also fine-grain controls like pinning and fullscreen are hidden from the layout.

Sample use cases:

  • You may want to change the room layout mode on the fly during the call.

  • You may have developed a mode switcher outside the Samba iframe and want to control the layout inside the room.

circle-info

The related event is layoutModeChanged, if you want to be informed when the layout mode has been changed.

Last updated