Interface WhiteboardState

interface WhiteboardState {
    active: boolean;
    canStart: boolean;
    users: any[];
    limit: number;
    canvas: HTMLCanvasElement | null;
}

Properties

active: boolean

True while a whiteboard session is running.

canStart: boolean

The local user may start one.

users: any[]

Participants granted drawing rights.

limit: number

Maximum participants the room's plan allows on a whiteboard.

canvas: HTMLCanvasElement | null

The live canvas element, when the SDK has created one.