Type Alias ZoomVideoSdkWhiteboardHelperType

Whiteboard helper interface.

type ZoomVideoSdkWhiteboardHelperType = {
    canStartShareWhiteboard: () => Promise<boolean>;
    canStopShareWhiteboard: () => Promise<boolean>;
    exportWhiteboard: (format: string) => Promise<Errors>;
    isOtherSharingWhiteboard: () => Promise<boolean>;
    startShareWhiteboard: () => Promise<Errors>;
    stopShareWhiteboard: () => Promise<Errors>;
}

Properties

canStartShareWhiteboard: () => Promise<boolean>

Determines whether the current user can start whiteboard sharing. Only the host can start whiteboard sharing.

canStopShareWhiteboard: () => Promise<boolean>

Determines whether the current user can stop whiteboard sharing.

exportWhiteboard: (format: string) => Promise<Errors>

Exports the currently shared whiteboard.

- (format: string): Promise<Errors>
- Parameters
  - format: string
    The export format. Use "EXPORT_FORMAT_PDF" for PDF format.
  Returns Promise<Errors>

isOtherSharingWhiteboard: () => Promise<boolean>

Determines whether another user is currently sharing a whiteboard.

startShareWhiteboard: () => Promise<Errors>

Starts whiteboard sharing in the session.

stopShareWhiteboard: () => Promise<Errors>

Stops whiteboard sharing in the session.