Interface FlexibleVideoOptions

Interface defining the props for the FlexibleVideo component.

interface FlexibleVideoOptions {
    customWidth: number;
    customHeight: number;
    rows: number;
    columns: number;
    componentsToRender: ReactNode[];
    showAspect: boolean;
    backgroundColor?: string;
    Screenboard?: ReactNode;
    annotateScreenStream?: boolean;
    localStreamScreen?: MediaStream;
}

Properties

customWidth customHeight rows columns componentsToRender showAspect backgroundColor? Screenboard? annotateScreenStream? localStreamScreen?

Properties

customWidth

customWidth: number

Custom width for each grid item.

customHeight

customHeight: number

Custom height for each grid item.

rows

rows: number

Number of rows in the grid.

columns

columns: number

Number of columns in the grid.

componentsToRender

componentsToRender: ReactNode[]

Array of React components or elements to render in the grid.

showAspect

showAspect: boolean

Flag indicating whether to show the aspect ratio.

OptionalbackgroundColor

backgroundColor?: string

Background color for each grid item.

Default

'transparent'

OptionalScreenboard

Screenboard?: ReactNode

Screenboard component to overlay on the video grid.

OptionalannotateScreenStream

annotateScreenStream?: boolean

Flag to annotate the screen stream.

Default

false

OptionallocalStreamScreen

localStreamScreen?: MediaStream

The local screen stream to use for annotation.

Settings

Member Visibility

On This Page

Properties