Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AnnotationControllerType

Annotation controller type

Hierarchy

  • AnnotationControllerType

Index

Methods

Methods

clear

  • Clear the annotation on the shared content. The viewer can clear their content with Mine = 0. The host can clear their content with Mine = 0, or all content with All = 2. The presenter can clear their content with Mine = 0, viewer content with Viewer = 1, or all content with All = 2.

    Parameters

    Returns ExecutedResult

getToolColor

  • getToolColor(): number

  • Get the annotation tool color.

    Returns number

getToolType

getToolWidth

  • getToolWidth(): number

  • Get the annotation tool width.

    Returns number

getVanishingToolTimer

  • getVanishingToolTimer(): { displayTime: number; vanishingTime: number }

  • Get the vanishing tool displayTime and vanishingTime.

    Returns { displayTime: number; vanishingTime: number }

    • displayTime: number
    • vanishingTime: number

redo

  • Redo the annotation operation. Listen to the 'annotation-redo-status' event to check if the redo operation is available.

    Returns ExecutedResult

setToolColor

  • Set the annotation tool color. Default is black (0xff000000).

    Parameters

    • color: number

      number, RGBA color in 8-digit hexadecimal format. Example: white: 0xffffffff.

    Returns ExecutedResult

setToolType

setToolWidth

  • Set the annotation tool width. Default is 8px.

    Parameters

    • width: number

      number

    Returns ExecutedResult

setVanishingToolTimer

  • setVanishingToolTimer(vanishingToolTimer: { displayTime?: number; vanishingTime?: number }): ExecutedResult

  • Set the display time and vanishing time for the vanishing tool types. It only work for the screen share sender. After the value is set, the screen share sender and receiver annotation will follow the same timer.

    Parameters

    • vanishingToolTimer: { displayTime?: number; vanishingTime?: number }

      displayTime in milliseconds (default is 0), vanishingTime in milliseconds (default is 2000).

      • Optional displayTime?: number
      • Optional vanishingTime?: number

    Returns ExecutedResult

undo

  • Undo the annotation operation. Listen to the 'annotation-undo-status' event to check if the undo operation is available.

    Returns ExecutedResult