Provides access to methods for creating whiteboards. This class must not be directly instantiated. It can be obtained using session#createWhiteboard or listening to session#incommingWhiteBoard event.

Hierarchy

  • EventEmitter2
    • Whiteboard

Constructors

  • Parameters

    • Optional options: ConstructorOptions

    Returns Whiteboard

Properties

aspectRatio: number

Aspect ratio of the whiteboard.

backgroundImage: string | Blob

Current background image shown.

backgroundVideo: string

Current background video shown.

color: string

Color used for the shapes.

height: number

Current height of the whiteboard.

lineWidth: any
remoteParticipants: string[]

Gets the identities of the remote peers attached to this Whiteboard.

tool: string

Current tool to use on user interaction.

width: number

Returns the current width of the whiteboard.

Methods