Class AddVideosGrid

Service

AddVideosGrid

Description

Service to manage and update video and audio components on a grid in the user interface. This service helps organize and configure participants and streams into different grid layouts.

Method

addVideosGrid Adds video and audio cards to the main and alternate grids based on the parameters and configuration options provided.

Param: options

Configuration options for setting up the grid.

Param: options.mainGridStreams

Streams or participants to display on the main grid.

Param: options.altGridStreams

Streams or participants to display on the alternate grid.

Param: options.numtoadd

The number of items to add to the grid.

Param: options.numRows

The number of rows for the main grid.

Param: options.numCols

The number of columns for the main grid.

Param: options.actualRows

The actual rows currently displayed.

Param: options.lastrowcols

The number of columns in the last row of the grid.

Param: options.removeAltGrid

Whether to remove the alternate grid layout.

Param: options.parameters

Additional parameters for updating the grid, controlling appearance, and handling events.

Returns

A promise that resolves once the grid layout is updated.

Example

await addVideosGridService.addVideosGrid({
  mainGridStreams: [...],
  altGridStreams: [...],
  numtoadd: 4,
  numRows: 2,
  numCols: 2,
  actualRows: 2,
  lastrowcols: 2,
  removeAltGrid: false,
  parameters: {
    eventType: 'webinar',
    updateAddAltGrid: (value) => {},
    ref_participants: participantsList,
    islevel: '1',
    videoAlreadyOn: true,
    localStreamVideo: localStream,
    keepBackground: true,
    virtualStream: virtualStream,
    forceFullDisplay: false,
    otherGridStreams: otherStreamsArray,
    updateOtherGridStreams: (newStreams) => {},
    updateMiniCardsGrid: (params) => {},
    getUpdatedAllParams: () => ({ /* updated parameters * / }),
  },
});

Constructors

constructor

Methods

addVideosGrid

Constructors

constructor

Methods

addVideosGrid

Settings

Member Visibility

On This Page

Constructors
Methods