MediaSFU Shared
    Preparing search index...

    Function startWhiteboard

    • Start (or reconfigure) the shared whiteboard.

      Emits startWhiteboard for a new session and updateWhiteboard when one is already running, matching the SDK's own modal. Breakout rooms and the whiteboard are mutually exclusive, which is checked here.

      This applies the session state only. Layout follow-up (onScreenChanges, prepopulateUserMedia, main-pane sizing) is deliberately left to you, since a headless surface owns its own layout.

      Parameters

      Returns Promise<HeadlessActionResult>

      await startWhiteboard({ parameters, users: [{ name: 'Paul' }] });