DyteGrid
Properties
Property name | Data type | Use |
---|---|---|
layouts | Layout | Various layouts modes that the meeting videos grid can be set in |
Methods
Method name | Params (with data type) | Use |
---|---|---|
update | gridConfig: GridConfig | Update the grid config by passing the relevant fields that need to be updated |
setOverlay | element: HTMLElement | Set an overlay / filter on the entire meeting grid, read more about this in the usage section |
Layouts
layouts
is an enum that enumerates the different applicable modes for meeting
video grid.
DyteGrid.layouts {
MULTI,
HIGHLIGHTED
}
Layout name | Meaning |
---|---|
MULTI | sets the participant videos in a grid |
HIGHLIGHTED | makes the selected participant video occupy the majority of the screen |
GridConfig
Property | Data type | Required | Use |
---|---|---|---|
layout | Layout | No | Various layouts modes that the meeting videos grid can be set in |
participantVideo | object | No | Object containing information related to participant video streams on the meeting grid |
participantVideo.fit | string | No | Video fitting and cropping behaviour on the grid, can be set to contain or cover - contain maintains aspect ratio and leaves margin whereas cover fits the video to fit container size and crops if required |