MediaSFU Angular
    Preparing search index...

    Class ConfigureWhiteboardModal

    ConfigureWhiteboardModal - Modal for configuring collaborative whiteboard settings

    Allows host to configure whiteboard participants and settings before launching the whiteboard feature. Manages who can annotate and presenter selection.

    Supports three levels of customization:

    1. Basic Usage: Use default modal UI with participant list and whiteboard controls
    2. Style Customization: Override modal appearance with overlayStyle and contentStyle
    3. Full Override: Provide a custom template via customTemplate for complete control

    Key Features:

    • Select whiteboard participants
    • Set whiteboard presenter
    • Configure annotation permissions
    • Start/launch whiteboard
    • Canvas stream management

    app-configure-whiteboard-modal

    true

    CommonModule, FontAwesomeModule

    isConfigureWhiteboardModalVisible - Whether the modal is currently visible. Default: false

    onClose - Callback function to close the modal. Default: () => {}

    position - Modal position on screen ('topRight', 'center', etc.). Default: 'topRight'

    backgroundColor - Background color of the modal content. Default: '#83c0e9'

    parameters - Object containing whiteboard settings, participants, and update functions. Default: {}

    overlayStyle - Custom CSS styles for the modal overlay backdrop. Default: undefined

    contentStyle - Custom CSS styles for the modal content container. Default: undefined

    customTemplate - Custom TemplateRef to completely replace default modal template. Default: undefined

    getCombinedOverlayStyle - Merges default and custom overlay styles

    getCombinedContentStyle - Merges default and custom content styles

    Implements

    • OnInit
    • OnChanges
    Index

    Constructors

    Methods

    • Returns {
          position: string;
          top: number;
          left: number;
          width: string;
          height: string;
          backgroundColor: string;
          display: string;
          zIndex: number;
      }

    • Returns {
          position: string;
          backgroundColor: string;
          borderRadius: string;
          padding: string;
          width: string;
          maxWidth: string;
          maxHeight: string;
          overflowY: string;
          overflowX: string;
          top: string;
          bottom: string;
          left: string;
          right: string;
      }

    Properties

    isVisible: boolean = false
    backgroundColor: string = '#83c0e9'
    position: string = 'topRight'
    onConfigureWhiteboardClose: () => void
    overlayStyle?: Partial<CSSStyleDeclaration>
    contentStyle?: Partial<CSSStyleDeclaration>
    customTemplate?: any
    faTimes: IconDefinition = faTimes
    faCheck: IconDefinition = faCheck
    faSyncAlt: IconDefinition = faSyncAlt
    faPlay: IconDefinition = faPlay
    faSave: IconDefinition = faSave
    participantsCopy: Participant[] = []
    whiteboardLimit: number
    isEditing: boolean = false
    canStartWhiteboard: boolean = false
    assignedParticipants: any[] = []
    unassignedParticipants: any[] = []
    whiteboardStarted: boolean = false
    whiteboardEnded: boolean = false