layoutModeChanged

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.

When the user changes the layout mode by clicking on the mode switcher, the layoutModeChanged event will be emitted.

You can also change the layout mode programmatically through the SDK. Use the changeLayoutMode method to achieve that.

Sample payload

{
  "type": "layoutModeChanged",
  "data": {
    "mode": "tiled"
  }
}

Sample subscription code

sambaFrame.on('layoutModeChanged', (event) => {
  const data = event.data;
  //Possible values for "mode" field are "tiled" and "auto"
  console.log('Layout mode has been changed to', data.mode);
});

Last updated