Interface MediasfuUICustomOverrides

Main UI Overrides Map

Comprehensive interface covering all customizable MediaSFU surfaces:

Layout components (containers, grids, screens)
Control surfaces (buttons, timers, pagination)
Participant cards (video, audio, mini)
Modals (settings, messages, recording, etc.)
Entry flows (welcome, pre-join)
Helper functions (consumer resume, grid layout)

interface MediasfuUICustomOverrides {
    mainContainer?: CustomComponentOverride<MainContainerComponentProps>;
    mainAspect?: CustomComponentOverride<MainAspectComponentProps>;
    mainScreen?: CustomComponentOverride<MainScreenComponentProps>;
    mainGrid?: CustomComponentOverride<MainGridComponentProps>;
    subAspect?: CustomComponentOverride<SubAspectComponentProps>;
    otherGrid?: CustomComponentOverride<OtherGridComponentProps>;
    flexibleGrid?: CustomComponentOverride<FlexibleGridProps>;
    flexibleGridAlt?: CustomComponentOverride<FlexibleGridProps>;
    flexibleVideo?: CustomComponentOverride<FlexibleVideoProps>;
    audioGrid?: CustomComponentOverride<AudioGridProps>;
    pagination?: CustomComponentOverride<PaginationProps>;
    controlButtons?: CustomComponentOverride<ControlButtonsComponentProps>;
    controlButtonsAlt?: CustomComponentOverride<
        ControlButtonsAltComponentProps,
    >;
    controlButtonsTouch?: CustomComponentOverride<
        ControlButtonsComponentTouchProps,
    >;
    videoCard?: CustomComponentOverride<VideoCardProps>;
    audioCard?: CustomComponentOverride<AudioCardProps>;
    miniCard?: CustomComponentOverride<MiniCardProps>;
    miniAudio?: CustomComponentOverride<MiniAudioProps>;
    meetingProgressTimer?: CustomComponentOverride<MeetingProgressTimerProps>;
    miniAudioPlayer?: CustomComponentOverride<MiniAudioPlayerProps>;
    loadingModal?: CustomComponentOverride<LoadingModalProps>;
    alert?: CustomComponentOverride<AlertComponentProps>;
    menuModal?: CustomComponentOverride<MenuModalProps>;
    eventSettingsModal?: CustomComponentOverride<EventSettingsModalProps>;
    requestsModal?: CustomComponentOverride<RequestsModalProps>;
    waitingRoomModal?: CustomComponentOverride<WaitingRoomModalProps>;
    coHostModal?: CustomComponentOverride<CoHostModalProps>;
    mediaSettingsModal?: CustomComponentOverride<MediaSettingsModalProps>;
    participantsModal?: CustomComponentOverride<ParticipantsModalProps>;
    messagesModal?: CustomComponentOverride<MessagesModalProps>;
    displaySettingsModal?: CustomComponentOverride<DisplaySettingsModalProps>;
    confirmExitModal?: CustomComponentOverride<ConfirmExitModalProps>;
    confirmHereModal?: CustomComponentOverride<ConfirmHereModalProps>;
    shareEventModal?: CustomComponentOverride<ShareEventModalProps>;
    recordingModal?: CustomComponentOverride<RecordingModalProps>;
    pollModal?: CustomComponentOverride<PollModalProps>;
    backgroundModal?: CustomComponentOverride<BackgroundModalProps>;
    breakoutRoomsModal?: CustomComponentOverride<BreakoutRoomsModalOptions>;
    configureWhiteboardModal?: CustomComponentOverride<
        ConfigureWhiteboardModalProps,
    >;
    whiteboard?: CustomComponentOverride<WhiteboardProps>;
    screenboard?: CustomComponentOverride<ScreenboardProps>;
    screenboardModal?: CustomComponentOverride<ScreenboardModalProps>;
    welcomePage?: CustomComponentOverride<WelcomePageProps>;
    preJoinPage?: CustomComponentOverride<PreJoinPageProps>;
    customMenuButtonsRenderer?: CustomComponentOverride<
        ControlButtonsAltComponentProps,
    >;
    consumerResume?: CustomFunctionOverride<ConsumerResumeType>;
    addVideosGrid?: CustomFunctionOverride<AddVideosGridType>;
}

Properties

`Optional`mainContainer

mainContainer?: CustomComponentOverride<MainContainerComponentProps>

`Optional`mainAspect

mainAspect?: CustomComponentOverride<MainAspectComponentProps>

`Optional`mainScreen

mainScreen?: CustomComponentOverride<MainScreenComponentProps>

`Optional`mainGrid

mainGrid?: CustomComponentOverride<MainGridComponentProps>

`Optional`subAspect

subAspect?: CustomComponentOverride<SubAspectComponentProps>

`Optional`otherGrid

otherGrid?: CustomComponentOverride<OtherGridComponentProps>

`Optional`flexibleGrid

flexibleGrid?: CustomComponentOverride<FlexibleGridProps>

`Optional`flexibleGridAlt

flexibleGridAlt?: CustomComponentOverride<FlexibleGridProps>

`Optional`flexibleVideo

flexibleVideo?: CustomComponentOverride<FlexibleVideoProps>

`Optional`audioGrid

audioGrid?: CustomComponentOverride<AudioGridProps>

`Optional`pagination

pagination?: CustomComponentOverride<PaginationProps>

`Optional`controlButtons

controlButtons?: CustomComponentOverride<ControlButtonsComponentProps>

`Optional`controlButtonsAlt

controlButtonsAlt?: CustomComponentOverride<ControlButtonsAltComponentProps>

`Optional`controlButtonsTouch

controlButtonsTouch?: CustomComponentOverride<ControlButtonsComponentTouchProps>

`Optional`videoCard

videoCard?: CustomComponentOverride<VideoCardProps>

`Optional`audioCard

audioCard?: CustomComponentOverride<AudioCardProps>

`Optional`miniCard

miniCard?: CustomComponentOverride<MiniCardProps>

`Optional`miniAudio

miniAudio?: CustomComponentOverride<MiniAudioProps>

`Optional`meetingProgressTimer

meetingProgressTimer?: CustomComponentOverride<MeetingProgressTimerProps>

`Optional`miniAudioPlayer

miniAudioPlayer?: CustomComponentOverride<MiniAudioPlayerProps>

`Optional`loadingModal

loadingModal?: CustomComponentOverride<LoadingModalProps>

`Optional`alert

alert?: CustomComponentOverride<AlertComponentProps>

`Optional`menuModal

menuModal?: CustomComponentOverride<MenuModalProps>

`Optional`eventSettingsModal

eventSettingsModal?: CustomComponentOverride<EventSettingsModalProps>

`Optional`requestsModal

requestsModal?: CustomComponentOverride<RequestsModalProps>

`Optional`waitingRoomModal

waitingRoomModal?: CustomComponentOverride<WaitingRoomModalProps>

`Optional`coHostModal

coHostModal?: CustomComponentOverride<CoHostModalProps>

`Optional`mediaSettingsModal

mediaSettingsModal?: CustomComponentOverride<MediaSettingsModalProps>

`Optional`participantsModal

participantsModal?: CustomComponentOverride<ParticipantsModalProps>

`Optional`messagesModal

messagesModal?: CustomComponentOverride<MessagesModalProps>

`Optional`displaySettingsModal

displaySettingsModal?: CustomComponentOverride<DisplaySettingsModalProps>

`Optional`confirmExitModal

confirmExitModal?: CustomComponentOverride<ConfirmExitModalProps>

`Optional`confirmHereModal

confirmHereModal?: CustomComponentOverride<ConfirmHereModalProps>

`Optional`shareEventModal

shareEventModal?: CustomComponentOverride<ShareEventModalProps>

`Optional`recordingModal

recordingModal?: CustomComponentOverride<RecordingModalProps>

`Optional`pollModal

pollModal?: CustomComponentOverride<PollModalProps>

`Optional`backgroundModal

backgroundModal?: CustomComponentOverride<BackgroundModalProps>

`Optional`breakoutRoomsModal

breakoutRoomsModal?: CustomComponentOverride<BreakoutRoomsModalOptions>

`Optional`configureWhiteboardModal

configureWhiteboardModal?: CustomComponentOverride<
ConfigureWhiteboardModalProps,
>

`Optional`whiteboard

whiteboard?: CustomComponentOverride<WhiteboardProps>

`Optional`screenboard

screenboard?: CustomComponentOverride<ScreenboardProps>

`Optional`screenboardModal

screenboardModal?: CustomComponentOverride<ScreenboardModalProps>

`Optional`welcomePage

welcomePage?: CustomComponentOverride<WelcomePageProps>

`Optional`preJoinPage

preJoinPage?: CustomComponentOverride<PreJoinPageProps>

`Optional`customMenuButtonsRenderer

customMenuButtonsRenderer?: CustomComponentOverride<
ControlButtonsAltComponentProps,
>

`Optional`consumerResume

consumerResume?: CustomFunctionOverride<ConsumerResumeType>

`Optional`addVideosGrid

addVideosGrid?: CustomFunctionOverride<AddVideosGridType>