Class useWhiteboard

constructor

• new useWhiteboard(): useWhiteboard

  Returns useWhiteboard

whiteboardUrl

import { View, Text } from "react-native";
import { WebView } from "react-native-webview";
import { useWhiteboard } from "@videosdk.live/react-native-sdk";

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

  if (!whiteboardUrl) {
    return (
      <View style={{ flex: 1, alignItems: "center", justifyContent: "center" }}>
        <Text>No active whiteboard session</Text>
      </View>
    );
  }

  return (
    <View style={{ flex: 1 }}>
      <WebView source={{ uri: whiteboardUrl }} style={{ flex: 1 }} />
    </View>
  );
}

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>

  Example

  import { useWhiteboard } from "@videosdk.live/react-native-sdk";
  
  const { startWhiteboard } = useWhiteboard();
  
  const run = async () => {
    await startWhiteboard();
  };
  
  run();
  Copy

stopWhiteboard

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

  Returns Promise<void>

  Example

  import { useWhiteboard } from "@videosdk.live/react-native-sdk";
  
  const { stopWhiteboard } = useWhiteboard();
  
  const run = async () => {
    await stopWhiteboard();
  };
  
  run();
  Copy