@100mslive/hms-video-store/src/interfaces/session-store/whiteboard.ts

@100mslive Core SDK which abstracts the complexities of webRTC while providing a reactive store for data management with a unidirectional data flow

import { HMSPermissionType } from '../role';

export interface HMSWhiteboardCreateOptions {
  id?: string; // unique whiteboard id generated by SDK, use to open previously created whiteboard
  title?: string;
  reader?: string[]; // list of roles that can view whiteboard
  writer?: string[]; // list of roles that can edit whiteboard
  admin?: string[]; // list of roles that can close whiteboard
  presence?: boolean; // enable presence tracking
  attributes?: Array<{ name: string; value: unknown }>;
}

export interface HMSWhiteboard {
  id: string; // unique whiteboard id generated by backend
  open?: boolean; // whether whiteboard is open or not
  title?: string;
  owner?: string; // user id for whiteboard owner
  permissions?: Array<HMSPermissionType>;
  presence?: boolean;
  attributes?: Array<{ name: string; value: unknown }>;
  /**
   * the URL that needs to be used as the iframe src
   */
  url?: string;
  /**
   * address to be used to connect to whiteboard grpc communication service
   * @internal
   */
  addr?: string;
  /**
   *  security token to be used for whiteboard API
   * @internal
   */
  token?: string;
}