Pin Participants - Prebuilt

This feature allows participants to pin self or other participants in the meeting.

• permissions.pin: If it is true then that participant can pin or unpin other participants in the meeting, by default it is set to false.
• layout.type: It should be a any of GRID or SPOTLIGHT or SIDEBAR, by default it is set to GRID.
• layout.priority: if set to speaker then speaker will get high priority even though someone else is pinned.Otherwise pin participate will get higher priority for layout.

note

If no participant is pinned, then the default meeting layout will automatically changed to GRID whether layout was set to SPOTLIGHT or SIDEBAR while meeting initialization. When any participant gets pinned the layout will be change to the layout set while initializing the meeting.

Better understanding of Layouts

1. GRID Layout

This layout is default layout if no participants are pinned, it will look same as a normal meeting grid layout, when any participant is pinned that participant will be moved on top of the main screen grid above all non pinned participants

While screenshare as well the main view will contain only screenshare media but the side panel view of participant grid will maintain same order of pinned and unpinned participants.

2. SIDEBAR Layout

This layout will have one main screen view and other sidebar grid layout. Only pinned participant will be visible in this layout, all unpinned participants will not be visible in this layout. If more than one participant is pinned then the first participant who was pinned will appear in main screen layout and all other remaining pinned particiapants will be visible in sidebar.

If any pinned participant started screenshare then the screenshare media will be visible in main screen layout and all other pinned participants webcam view will be visible in sidebar

3. SPOTLIGHT Layout

This layout will only contain main screen layout, multiple pinned participants will be visible in main screen view. Same as SIDEBAR layout only pinned participants will be visible in main screen.

If any pinned participant started screenshare then only screenshare view will be visible in main screen, no webcam view will be visible when any pinned participant started screenshare.

Pin attributes

index.html

const config = {
  // ...
  permissions: {
    pin: true,
  },
  layout: {
    type: "SIDEBAR", // "SPOTLIGHT" | "SIDEBAR" | "GRID"
    priority: "PIN", // "SPEAKER" | "PIN",
    gridSize: 3,
  },
  // ...
};