VideoRoomSessionMethods

getLayouts

View as Markdown

getLayouts

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

Returns a list of available layouts for the room. To set a room layout, use setLayout.

Returns

Promise<{ layouts: string[] }>

Example

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