Skip to content
Neeraj Swarnkar edited this page Nov 22, 2022 · 5 revisions

Layout

This wiki explains the layout of remote videos in the SDK.

Developer can update the remote videos' layout type for the current meeting from the 5 layout types available options for the specific participant/device only.

image

Screenshot is added from our Kitchen Sink app.

API

To know about changeVideoLayout APIs in detail, please visit → https://webex.github.io/webex-js-sdk/api/

Uses below API to change layout type for the current meeting for the specific participant/device only

changeVideoLayout(layoutType, renderInfo = {})
Asynchronous Yes
Parameters layoutType, renderInfo
Returns promise

layoutType possible values user can pass ['Single', 'ActivePresence', 'Prominent', 'Equal', 'OnePlusN'].

renderInfo preferred dimensions for the remote main and content streams (server can ignore it)

const layoutType = 'Equal';
const renderInfo =  {
   "main": {
         "width": "1920", 
         "height": "1080"
      }
};

meeting.changeVideoLayout(layoutType, renderInfo);

Layout Types

There are 5 layout types available in meetings, which are

  1. Single
  2. ActivePresence
  3. Prominent
  4. Equal
  5. OnePlusN

We can check that in our public Kitchen Sink app.

Types with screenshots are added below -

Single

image2022-10-11_16-8-50

Equal

image2022-10-11_16-7-58

Active Presence

image2022-10-11_16-8-34

Prominent

image2022-10-11_16-8-23

One+N

image2022-10-11_16-8-14

Screenshots are added from our Kitchen Sink app.

Clone this wiki locally