MediaSFU Angular
    Preparing search index...

    Interface MediasfuUICustomOverrides

    Main UI Overrides interface Contains all customizable components and functions in MediaSFU

    interface MediasfuUICustomOverrides {
        mainContainer?: CustomComponentOverride<any, any>;
        mainAspect?: CustomComponentOverride<any, any>;
        mainScreen?: CustomComponentOverride<any, any>;
        mainGrid?: CustomComponentOverride<any, any>;
        subAspect?: CustomComponentOverride<any, any>;
        otherGrid?: CustomComponentOverride<any, any>;
        flexibleGrid?: CustomComponentOverride<any, any>;
        flexibleGridAlt?: CustomComponentOverride<any, any>;
        flexibleVideo?: CustomComponentOverride<any, any>;
        audioGrid?: CustomComponentOverride<any, any>;
        pagination?: CustomComponentOverride<any, any>;
        controlButtons?: CustomComponentOverride<any, any>;
        controlButtonsAlt?: CustomComponentOverride<any, any>;
        controlButtonsTouch?: CustomComponentOverride<any, any>;
        videoCard?: CustomComponentOverride<any, any>;
        audioCard?: CustomComponentOverride<any, any>;
        miniCard?: CustomComponentOverride<any, any>;
        miniAudio?: CustomComponentOverride<any, any>;
        meetingProgressTimer?: CustomComponentOverride<any, any>;
        miniAudioPlayer?: CustomComponentOverride<any, any>;
        loadingModal?: CustomComponentOverride<any, any>;
        alert?: CustomComponentOverride<any, any>;
        menuModal?: CustomComponentOverride<any, any>;
        eventSettingsModal?: CustomComponentOverride<any, any>;
        requestsModal?: CustomComponentOverride<any, any>;
        waitingRoomModal?: CustomComponentOverride<any, any>;
        coHostModal?: CustomComponentOverride<any, any>;
        mediaSettingsModal?: CustomComponentOverride<any, any>;
        participantsModal?: CustomComponentOverride<any, any>;
        messagesModal?: CustomComponentOverride<any, any>;
        displaySettingsModal?: CustomComponentOverride<any, any>;
        translationSettingsModal?: CustomComponentOverride<any, any>;
        confirmExitModal?: CustomComponentOverride<any, any>;
        confirmHereModal?: CustomComponentOverride<any, any>;
        shareEventModal?: CustomComponentOverride<any, any>;
        recordingModal?: CustomComponentOverride<any, any>;
        pollModal?: CustomComponentOverride<any, any>;
        backgroundModal?: CustomComponentOverride<any, any>;
        breakoutRoomsModal?: CustomComponentOverride<any, any>;
        configureWhiteboardModal?: CustomComponentOverride<any, any>;
        whiteboard?: CustomComponentOverride<any, any>;
        screenboard?: CustomComponentOverride<any, any>;
        screenboardModal?: CustomComponentOverride<any, any>;
        welcomePage?: CustomComponentOverride<any, any>;
        preJoinPage?: CustomComponentOverride<any, any>;
        customMenuButtonsRenderer?: CustomComponentOverride<any, any>;
        consumerResume?: CustomFunctionOverride<(params: any) => Promise<void>>;
        addVideosGrid?: CustomFunctionOverride<(params: any) => Promise<void>>;
        prepopulateUserMedia?: CustomFunctionOverride<
            (params: any) => Promise<any>,
        >;
    }
    Index

    Properties

    mainContainer? mainAspect? mainScreen? mainGrid? subAspect? otherGrid? flexibleGrid? flexibleGridAlt? flexibleVideo? audioGrid? pagination? controlButtons? controlButtonsAlt? controlButtonsTouch? videoCard? audioCard? miniCard? miniAudio? meetingProgressTimer? miniAudioPlayer? loadingModal? alert? menuModal? eventSettingsModal? requestsModal? waitingRoomModal? coHostModal? mediaSettingsModal? participantsModal? messagesModal? displaySettingsModal? translationSettingsModal? confirmExitModal? confirmHereModal? shareEventModal? recordingModal? pollModal? backgroundModal? breakoutRoomsModal? configureWhiteboardModal? whiteboard? screenboard? screenboardModal? welcomePage? preJoinPage? customMenuButtonsRenderer? consumerResume? addVideosGrid? prepopulateUserMedia?

    Properties

    mainContainer?: CustomComponentOverride<any, any>

    Main container component - Root wrapper for the entire UI

    mainAspect?: CustomComponentOverride<any, any>

    Main aspect component - Controls aspect ratio and layout

    mainScreen?: CustomComponentOverride<any, any>

    Main screen component - Primary video/content display area

    mainGrid?: CustomComponentOverride<any, any>

    Main grid component - Grid layout for participants

    subAspect?: CustomComponentOverride<any, any>

    Sub aspect component - Secondary layout container

    otherGrid?: CustomComponentOverride<any, any>

    Other grid component - Additional participant grid

    flexibleGrid?: CustomComponentOverride<any, any>

    Flexible grid component - Dynamic participant grid

    flexibleGridAlt?: CustomComponentOverride<any, any>

    Alternative flexible grid component

    flexibleVideo?: CustomComponentOverride<any, any>

    Flexible video component - Individual video display

    audioGrid?: CustomComponentOverride<any, any>

    Audio grid component - Grid for audio-only participants

    pagination?: CustomComponentOverride<any, any>

    Pagination component - Page navigation controls

    controlButtons?: CustomComponentOverride<any, any>

    Primary control buttons component

    controlButtonsAlt?: CustomComponentOverride<any, any>

    Alternative control buttons component

    controlButtonsTouch?: CustomComponentOverride<any, any>

    Touch-optimized control buttons component

    videoCard?: CustomComponentOverride<any, any>

    Video card component - Individual video participant display

    audioCard?: CustomComponentOverride<any, any>

    Audio card component - Individual audio-only participant display

    miniCard?: CustomComponentOverride<any, any>

    Mini card component - Minimized participant display

    miniAudio?: CustomComponentOverride<any, any>

    Mini audio component - Minimized audio indicator

    meetingProgressTimer?: CustomComponentOverride<any, any>

    Meeting progress timer widget

    miniAudioPlayer?: CustomComponentOverride<any, any>

    Mini audio player widget

    loadingModal?: CustomComponentOverride<any, any>

    Loading modal - Displayed during connection/loading

    alert?: CustomComponentOverride<any, any>

    Alert component - System notifications and alerts

    menuModal?: CustomComponentOverride<any, any>

    Menu modal - Quick actions menu

    eventSettingsModal?: CustomComponentOverride<any, any>

    Event settings modal - Host controls and settings

    requestsModal?: CustomComponentOverride<any, any>

    Requests modal - Media access requests

    waitingRoomModal?: CustomComponentOverride<any, any>

    Waiting room modal - Participant admission queue

    coHostModal?: CustomComponentOverride<any, any>

    Co-host modal - Co-host management

    mediaSettingsModal?: CustomComponentOverride<any, any>

    Media settings modal - Camera/microphone settings

    participantsModal?: CustomComponentOverride<any, any>

    Participants modal - Participant list and management

    messagesModal?: CustomComponentOverride<any, any>

    Messages modal - Chat interface

    displaySettingsModal?: CustomComponentOverride<any, any>

    Display settings modal - Layout and display preferences

    translationSettingsModal?: CustomComponentOverride<any, any>

    Translation settings modal - Spoken/listening translation controls

    confirmExitModal?: CustomComponentOverride<any, any>

    Confirm exit modal - Exit confirmation dialog

    confirmHereModal?: CustomComponentOverride<any, any>

    Confirm here modal - Attendance confirmation

    shareEventModal?: CustomComponentOverride<any, any>

    Share event modal - Event sharing interface

    recordingModal?: CustomComponentOverride<any, any>

    Recording modal - Recording controls

    pollModal?: CustomComponentOverride<any, any>

    Poll modal - Polling interface

    backgroundModal?: CustomComponentOverride<any, any>

    Background modal - Virtual background settings

    breakoutRoomsModal?: CustomComponentOverride<any, any>

    Breakout rooms modal - Breakout room management

    configureWhiteboardModal?: CustomComponentOverride<any, any>

    Configure whiteboard modal - Whiteboard settings

    whiteboard?: CustomComponentOverride<any, any>

    Whiteboard component - Collaborative whiteboard

    screenboard?: CustomComponentOverride<any, any>

    Screenboard component - Screen annotation layer

    screenboardModal?: CustomComponentOverride<any, any>

    Screenboard modal - Screen sharing annotation controls

    welcomePage?: CustomComponentOverride<any, any>

    Welcome page - Pre-join welcome/marketing page

    preJoinPage?: CustomComponentOverride<any, any>

    Pre-join page - Room entry wizard

    customMenuButtonsRenderer?: CustomComponentOverride<any, any>

    Custom menu buttons renderer - Custom button group renderer

    consumerResume?: CustomFunctionOverride<(params: any) => Promise<void>>

    Consumer resume function - Handles resuming paused media consumers

    addVideosGrid?: CustomFunctionOverride<(params: any) => Promise<void>>

    Add videos grid function - Handles adding videos to the grid layout

    prepopulateUserMedia?: CustomFunctionOverride<(params: any) => Promise<any>>

    Prepopulate user media function - Handles initial setup of user media streams

    Settings

    Member Visibility

    On This Page

    Properties