Class useWhiteboard

constructor

• new useWhiteboard(): useWhiteboard

  Returns useWhiteboard

whiteboardUrl

import React from "react";
import { useWhiteboard } from "@videosdk.live/react-sdk";

function WhiteboardComponent() {
  const { whiteboardUrl } = useWhiteboard();

  return (
    <div>
      {whiteboardUrl && (
        <iframe src={whiteboardUrl} width="800" height="600"></iframe>
      )}
    </div>
  );
}

export default WhiteboardComponent;
Copy

startWhiteboard

• startWhiteboard(): Promise<void>
  • This method can be used to start a whiteboard session for all participants and generates a whiteboardUrl for rendering the whiteboard.

  Returns Promise<void>

  Throws

  • Errors.ERROR_ACTION_PERFORMED_BEFORE_MEETING_JOINED — called before meeting is joined
  • Errors.ERROR_MEETING_RECONNECTING — meeting is reconnecting
  • Errors.START_WHITEBOARD_FAILED — server rejected the request
  • Errors.WHITEBOARD_OPERATION_IN_PROGRESS — a whiteboard operation is already in progress

  Example

  import { useWhiteboard } from "@videosdk.live/react-sdk";
  
  const { startWhiteboard } = useWhiteboard();
  
  async function beginWhiteboard() {
    try {
      await startWhiteboard();
    } catch (err) {
      console.log("startWhiteboard failed", err);
    }
  }
  Copy

stopWhiteboard

• stopWhiteboard(): Promise<void>
  • This method can be used to stop the active whiteboard session for all participants.

  Returns Promise<void>

  Throws

  • Errors.ERROR_ACTION_PERFORMED_BEFORE_MEETING_JOINED — called before meeting is joined
  • Errors.ERROR_MEETING_RECONNECTING — meeting is reconnecting
  • Errors.STOP_WHITEBOARD_FAILED — server rejected the request
  • Errors.WHITEBOARD_OPERATION_IN_PROGRESS — a whiteboard operation is already in progress

  Example

  import { useWhiteboard } from "@videosdk.live/react-sdk";
  
  const { stopWhiteboard } = useWhiteboard();
  
  async function endWhiteboard() {
    try {
      await stopWhiteboard();
    } catch (err) {
      console.log("stopWhiteboard failed", err);
    }
  }
  Copy