getLayouts

getLayouts

• getLayouts(): Promise<{ layouts: string[] }>

Returns a list of available layouts for the room.

Returns

Promise<{ layouts: string[] }>

Permissions

• room.list_available_layouts

You need to specify the permissions when creating the Video Room Token on the server side.

Example

await roomSession.getLayouts()
// returns:
{
  "layouts": [
    "8x8", "2x1", "1x1", "5up", "5x5",
    "4x4", "10x10", "2x2", "6x6", "3x3",
    "grid-responsive", "highlight-1-responsive"
  ]
}