MediaSFU Vue
    Preparing search index...

    MediaSFU Vue - v1.0.1

    Functions

    useBackgroundModal
    useMediasfu
    useMediasfuDemo
    useMenuModal
    useUIOverrides
    addVideosGrid
    prepopulateUserMedia
    createLiveSubtitle
    createLiveSubtitleService

    Interfaces

    AddPanelistOptions
    BreakoutRoomUpdatedOptions
    BreakoutRoomUpdatedParameters
    CheckPauseStateOptions
    CheckResumeStateOptions
    ConfirmRecordingOptions
    FocusPanelistsOptions
    LanguageEntry
    LanguageMetadata
    LanguageOption
    LaunchBreakoutRoomsOptions
    LaunchCoHostOptions
    LaunchConfigureWhiteboardOptions
    LaunchConfirmExitOptions
    LaunchDisplaySettingsOptions
    LaunchMediaSettingsOptions
    LaunchMessagesOptions
    LaunchPanelistsOptions
    LaunchParticipantsOptions
    LaunchPermissionsOptions
    LaunchPollOptions
    LaunchRecordingOptions
    LaunchRequestsOptions
    LaunchSettingsOptions
    LaunchWaitingOptions
    LiveSubtitle
    PermissionCapabilities
    PermissionConfig
    RecordPauseTimerOptions
    RecordResumeTimerOptions
    RecordStartTimerOptions
    RecordUpdateTimerOptions
    RemovePanelistOptions
    StartRecordingOptions
    StopRecordingOptions
    TranslationChannelsAvailableData
    TranslationConfigUpdatedData
    TranslationErrorData
    TranslationLanguageEntry
    TranslationLanguageSetData
    TranslationMemberStateData
    TranslationProducerClosedData
    TranslationProducerMap
    TranslationProducerReadyData
    TranslationRoomConfig
    TranslationSubscribedData
    TranslationTranscriptData
    TranslationUnsubscribedData
    TranslationVoiceConfig
    UnfocusPanelistsOptions
    UpdatePanelistsOptions
    UpdateParticipantPermissionOptions
    UpdatePermissionConfigOptions
    UpdateRecordingOptions
    VoiceOption
    VoiceSelectionPreference
    TriggerParameters
    TriggerOptions
    ChangeVidsParameters
    ChangeVidsOptions
    ReorderStreamsParameters
    ReorderStreamsOptions
    CompareScreenStatesParameters
    CompareScreenStatesOptions
    CompareActiveNamesParameters
    CompareActiveNamesOptions
    RePortParameters
    RePortOptions
    OnScreenChangesParameters
    OnScreenChangesOptions
    Participant
    Stream
    Request
    RequestResponse
    Transport
    ScreenState
    GridSizes
    ComponentSizes
    AudioDecibels
    CoHostResponsibility
    VidCons
    Message
    UserRecordingParams
    Poll
    WaitingRoomParticipant
    ModalPositionStyle
    OverlayPositionStyle
    PollUpdatedData
    BreakoutParticipant
    BreakoutRoomUpdatedData
    ConsumeSocket
    WhiteboardUser
    ShapePayload
    Shapes
    WhiteboardData
    MeetingRoomParams
    RecordingParams
    RecordParams
    CreateRoomOptions
    CreateMediaSFURoomOptions
    JoinMediaSFURoomOptions
    ResponseJoinLocalRoom
    ResponseJoinRoom
    AllMembersData
    AllMembersRestData
    UserWaitingData
    AllWaitingRoomMembersData
    BanData
    UpdatedCoHostData
    ParticipantRequestedData
    ScreenProducerIdData
    UpdateMediaSettingsData
    ProducerMediaPausedData
    ProducerMediaResumedData
    ProducerMediaClosedData
    ControlMediaHostData
    ReceiveMessageData
    MeetingTimeRemainingData
    MeetingStillThereData
    UpdateConsumingDomainsData
    RecordingNoticeData
    TimeLeftRecordingData
    StoppedRecordingData
    HostRequestResponseData
    SafeRoomNoticeData
    UnSafeData
    UnsafeAlertData
    DataBufferNotice
    AudioData
    RecordingImageData
    CustomVideoCardOptions
    CustomAudioCardOptions
    CustomMiniCardOptions
    CustomPreJoinPageOptions
    ButtonTouch
    CustomButton
    CustomButtonsOptions
    WhiteboardUpdatedData
    WhiteboardActionData
    PreJoinPageParameters
    CreateJoinRoomResponse
    CreateJoinRoomError
    CreateJoinRoomResult
    WelcomePageParameters
    PreJoinPageOptions
    ResponseLocalConnection
    ResponseLocalConnectionData
    UpdateMiniCardsGridParameters
    AddVideosGridParameters
    AddVideosGridOptions
    ConsumerResumeParameters
    ConsumerResumeOptions
    PrepopulateUserMediaParameters
    PrepopulateUserMediaOptions
    LiveSubtitleService
    Credentials
    MediasfuGenericProps
    MediaAlert
    MediaSessionState
    MediaSessionApi
    RenderableComponent
    CustomComponentOverride
    CustomFunctionOverride
    MediasfuUICustomOverrides

    References

    BreakoutRoomsModal → BackgroundModal
    RoomList → BackgroundModal
    EditRoomModal → BackgroundModal
    CoHostModal → BackgroundModal
    AlertComponent → BackgroundModal
    LoadingModal → BackgroundModal
    MeetingProgressTimer → BackgroundModal
    MiniCard → BackgroundModal
    MiniCardAudio → BackgroundModal
    MiniAudio → BackgroundModal
    Pagination → BackgroundModal
    AudioCard → BackgroundModal
    VideoCard → BackgroundModal
    CardVideoDisplay → BackgroundModal
    AudioGrid → BackgroundModal
    FlexibleGrid → BackgroundModal
    FlexibleVideo → BackgroundModal
    MainAspectComponent → BackgroundModal
    SubAspectComponent → BackgroundModal
    MainContainerComponent → BackgroundModal
    MainGridComponent → BackgroundModal
    MainScreenComponent → BackgroundModal
    OtherGridComponent → BackgroundModal
    ControlButtonsComponent → BackgroundModal
    ControlButtonsComponentTouch → BackgroundModal
    ControlButtonsAltComponent → BackgroundModal
    AlertComponentProps → BackgroundModal
    LoadingModalProps → BackgroundModal
    MeetingProgressTimerProps → BackgroundModal
    MiniCardProps → BackgroundModal
    MiniCardAudioProps → BackgroundModal
    MiniAudioProps → BackgroundModal
    PaginationProps → BackgroundModal
    PaginationParameters → BackgroundModal
    AudioCardProps → BackgroundModal
    AudioCardParameters → BackgroundModal
    VideoCardProps → BackgroundModal
    VideoCardParameters → BackgroundModal
    CardVideoDisplayProps → BackgroundModal
    AudioGridProps → BackgroundModal
    FlexibleGridProps → BackgroundModal
    FlexibleVideoProps → BackgroundModal
    MainAspectComponentProps → BackgroundModal
    SubAspectComponentProps → BackgroundModal
    MainContainerComponentProps → BackgroundModal
    MainGridComponentProps → BackgroundModal
    MainScreenComponentProps → BackgroundModal
    OtherGridComponentProps → BackgroundModal
    ControlButtonsComponentProps → BackgroundModal
    Button → BackgroundModal
    ControlButtonsComponentTouchProps → BackgroundModal
    ControlButtonsAltComponentProps → BackgroundModal
    AltButton → BackgroundModal
    DisplaySettingsModal → BackgroundModal
    DisplaySettingsModalParameters → BackgroundModal
    DisplaySettingsModalProps → BackgroundModal
    EventSettingsModal → BackgroundModal
    EventSettingsModalProps → BackgroundModal
    ConfirmExitModal → BackgroundModal
    ConfirmExitModalProps → BackgroundModal
    MediaSettingsModal → BackgroundModal
    MediaSettingsModalParameters → BackgroundModal
    MediaSettingsModalProps → BackgroundModal
    MediasfuGeneric → BackgroundModal
    MediasfuBroadcast → BackgroundModal
    MediasfuChat → BackgroundModal
    MediasfuConference → BackgroundModal
    MediasfuWebinar → BackgroundModal
    MeetingIDComponent → BackgroundModal
    MeetingPasscodeComponent → BackgroundModal
    ShareButtonsComponent → BackgroundModal
    CustomButtons → BackgroundModal
    MeetingIdComponentProps → BackgroundModal
    MeetingPasscodeComponentProps → BackgroundModal
    ShareButtonsComponentProps → BackgroundModal
    ShareButton → BackgroundModal
    CustomButtonsProps → BackgroundModal
    MessagePanel → BackgroundModal
    MessagesModal → BackgroundModal
    ShareEventModal → BackgroundModal
    ConfirmHereModal → BackgroundModal
    PreJoinPage → BackgroundModal
    WelcomePage → BackgroundModal
    ShareEventModalProps → BackgroundModal
    ConfirmHereModalProps → BackgroundModal
    PreJoinPageProps → BackgroundModal
    WelcomePageProps → BackgroundModal
    ParticipantList → BackgroundModal
    ParticipantListItem → BackgroundModal
    ParticipantListOthers → BackgroundModal
    ParticipantListOthersItem → BackgroundModal
    ParticipantsModal → BackgroundModal
    PollModal → BackgroundModal
    RecordingModal → BackgroundModal
    StandardPanelComponent → BackgroundModal
    AdvancedPanelComponent → BackgroundModal
    RecordingModalParameters → BackgroundModal
    RecordingModalProps → BackgroundModal
    StandardPanelParameters → BackgroundModal
    StandardPanelProps → BackgroundModal
    AdvancedPanelParameters → BackgroundModal
    AdvancedPanelProps → BackgroundModal
    RenderRequestComponent → BackgroundModal
    RequestsModal → BackgroundModal
    Screenboard → BackgroundModal
    ScreenboardModal → BackgroundModal
    ScreenboardProps → BackgroundModal
    ScreenboardParameters → BackgroundModal
    ScreenboardModalProps → BackgroundModal
    ScreenboardModalParameters → BackgroundModal
    WaitingModal → BackgroundModal
    ConfigureWhiteboardModal → BackgroundModal

    Type Aliases

    AddPanelistType
    BreakoutRoomUpdatedType
    CheckPauseStateType
    CheckResumeStateType
    ConfirmRecordingType
    FocusPanelistsType
    LanguageMode
    LanguageRegion
    LaunchBreakoutRoomsType
    LaunchCoHostType
    LaunchConfigureWhiteboardType
    LaunchConfirmExitType
    LaunchDisplaySettingsType
    LaunchMediaSettingsType
    LaunchMessagesType
    LaunchPanelistsType
    LaunchParticipantsType
    LaunchPermissionsType
    LaunchPollType
    LaunchRecordingType
    LaunchRequestsType
    LaunchSettingsType
    LaunchWaitingType
    PermissionLevel
    RecordPauseTimerType
    RecordResumeTimerType
    RecordStartTimerType
    RecordUpdateTimerType
    RemovePanelistType
    StartRecordingType
    StopRecordingType
    TTSSupport
    UnfocusPanelistsType
    UpdatePanelistsType
    UpdateRecordingType
    VoiceGender
    TriggerType
    ChangeVidsType
    ReorderStreamsType
    CompareScreenStatesType
    CompareActiveNamesType
    RePortType
    OnScreenChangesType
    ShowAlert
    Settings
    MainSpecs
    DispSpecs
    TextSpecs
    AltDomains
    RequestPermissionAudioType
    RequestPermissionCameraType
    ControlsPosition
    InfoPosition
    EventType
    SeedData
    AParamsType
    HParamsType
    VParamsType
    ScreenParamsType
    StyleDictionary
    CustomRenderer
    Shape
    CreateWebRTCTransportResponse
    CreateJoinRoomType
    CreateRoomOnMediaSFUType
    JoinRoomOnMediaSFUType
    SleepType
    MuteParticipantsType
    MessageParticipantsType
    RemoveParticipantsType
    AddVideosGridType
    ConsumerResumeType
    PrepopulateUserMediaType
    CustomComponent
    CustomVideoCardComponent
    CustomAudioCardComponent
    CustomMiniCardComponent
    CustomPreJoinPageComponent
    MediaSFUSocket
    OverrideComponentProps
    TypedOverride

    Variables

    addPanelist
    breakoutRoomUpdated
    checkPauseState
    checkResumeState
    confirmRecording
    focusPanelists
    getLanguageMetadata
    getLanguageName
    getLanguageNativeName
    getSupportedLanguages
    isLanguageSupported
    isSubtitleExpired
    launchBreakoutRooms
    launchCoHost
    launchConfigureWhiteboard
    launchConfirmExit
    launchDisplaySettings
    launchMediaSettings
    launchMessages
    launchPanelists
    launchParticipants
    launchPermissions
    launchPoll
    launchRecording
    launchRequests
    launchSettings
    launchWaiting
    normalizeLanguageCode
    pruneExpiredSubtitles
    recordPauseTimer
    recordResumeTimer
    recordStartTimer
    recordUpdateTimer
    removePanelist
    startRecording
    stopRecording
    SUPPORTED_LANGUAGE_CODES
    translationChannelsAvailable
    translationConfigUpdated
    translationError
    translationLanguageSet
    translationMemberState
    translationProducerClosed
    translationProducerReady
    translationRoomConfig
    translationSpeakerOutputChanged
    translationSubscribed
    translationTranscript
    translationUnsubscribed
    unfocusPanelists
    updateLiveSubtitlesFromTranscript
    updatePanelists
    updateParticipantPermission
    updatePermissionConfig
    updateRecording
    BackgroundModal
    consumerResume
    liveSubtitleService
    createRoomOnMediaSFU
    joinRoomOnMediaSFU

    Settings

    Member Visibility

    On This Page

    Functions
    Interfaces
    AddPanelistOptionsBreakoutRoomUpdatedOptionsBreakoutRoomUpdatedParametersCheckPauseStateOptionsCheckResumeStateOptionsConfirmRecordingOptionsFocusPanelistsOptionsLanguageEntryLanguageMetadataLanguageOptionLaunchBreakoutRoomsOptionsLaunchCoHostOptionsLaunchConfigureWhiteboardOptionsLaunchConfirmExitOptionsLaunchDisplaySettingsOptionsLaunchMediaSettingsOptionsLaunchMessagesOptionsLaunchPanelistsOptionsLaunchParticipantsOptionsLaunchPermissionsOptionsLaunchPollOptionsLaunchRecordingOptionsLaunchRequestsOptionsLaunchSettingsOptionsLaunchWaitingOptionsLiveSubtitlePermissionCapabilitiesPermissionConfigRecordPauseTimerOptionsRecordResumeTimerOptionsRecordStartTimerOptionsRecordUpdateTimerOptionsRemovePanelistOptionsStartRecordingOptionsStopRecordingOptionsTranslationChannelsAvailableDataTranslationConfigUpdatedDataTranslationErrorDataTranslationLanguageEntryTranslationLanguageSetDataTranslationMemberStateDataTranslationProducerClosedDataTranslationProducerMapTranslationProducerReadyDataTranslationRoomConfigTranslationSubscribedDataTranslationTranscriptDataTranslationUnsubscribedDataTranslationVoiceConfigUnfocusPanelistsOptionsUpdatePanelistsOptionsUpdateParticipantPermissionOptionsUpdatePermissionConfigOptionsUpdateRecordingOptionsVoiceOptionVoiceSelectionPreferenceTriggerParametersTriggerOptionsChangeVidsParametersChangeVidsOptionsReorderStreamsParametersReorderStreamsOptionsCompareScreenStatesParametersCompareScreenStatesOptionsCompareActiveNamesParametersCompareActiveNamesOptionsRePortParametersRePortOptionsOnScreenChangesParametersOnScreenChangesOptionsParticipantStreamRequestRequestResponseTransportScreenStateGridSizesComponentSizesAudioDecibelsCoHostResponsibilityVidConsMessageUserRecordingParamsPollWaitingRoomParticipantModalPositionStyleOverlayPositionStylePollUpdatedDataBreakoutParticipantBreakoutRoomUpdatedDataConsumeSocketWhiteboardUserShapePayloadShapesWhiteboardDataMeetingRoomParamsRecordingParamsRecordParamsCreateRoomOptionsCreateMediaSFURoomOptionsJoinMediaSFURoomOptionsResponseJoinLocalRoomResponseJoinRoomAllMembersDataAllMembersRestDataUserWaitingDataAllWaitingRoomMembersDataBanDataUpdatedCoHostDataParticipantRequestedDataScreenProducerIdDataUpdateMediaSettingsDataProducerMediaPausedDataProducerMediaResumedDataProducerMediaClosedDataControlMediaHostDataReceiveMessageDataMeetingTimeRemainingDataMeetingStillThereDataUpdateConsumingDomainsDataRecordingNoticeDataTimeLeftRecordingDataStoppedRecordingDataHostRequestResponseDataSafeRoomNoticeDataUnSafeDataUnsafeAlertDataDataBufferNoticeAudioDataRecordingImageDataCustomVideoCardOptionsCustomAudioCardOptionsCustomMiniCardOptionsCustomPreJoinPageOptionsButtonTouchCustomButtonCustomButtonsOptionsWhiteboardUpdatedDataWhiteboardActionDataPreJoinPageParametersCreateJoinRoomResponseCreateJoinRoomErrorCreateJoinRoomResultWelcomePageParametersPreJoinPageOptionsResponseLocalConnectionResponseLocalConnectionDataUpdateMiniCardsGridParametersAddVideosGridParametersAddVideosGridOptionsConsumerResumeParametersConsumerResumeOptionsPrepopulateUserMediaParametersPrepopulateUserMediaOptionsLiveSubtitleServiceCredentialsMediasfuGenericPropsMediaAlertMediaSessionStateMediaSessionApiRenderableComponentCustomComponentOverrideCustomFunctionOverrideMediasfuUICustomOverrides
    References
    BreakoutRoomsModalRoomListEditRoomModalCoHostModalAlertComponentLoadingModalMeetingProgressTimerMiniCardMiniCardAudioMiniAudioPaginationAudioCardVideoCardCardVideoDisplayAudioGridFlexibleGridFlexibleVideoMainAspectComponentSubAspectComponentMainContainerComponentMainGridComponentMainScreenComponentOtherGridComponentControlButtonsComponentControlButtonsComponentTouchControlButtonsAltComponentAlertComponentPropsLoadingModalPropsMeetingProgressTimerPropsMiniCardPropsMiniCardAudioPropsMiniAudioPropsPaginationPropsPaginationParametersAudioCardPropsAudioCardParametersVideoCardPropsVideoCardParametersCardVideoDisplayPropsAudioGridPropsFlexibleGridPropsFlexibleVideoPropsMainAspectComponentPropsSubAspectComponentPropsMainContainerComponentPropsMainGridComponentPropsMainScreenComponentPropsOtherGridComponentPropsControlButtonsComponentPropsButtonControlButtonsComponentTouchPropsControlButtonsAltComponentPropsAltButtonDisplaySettingsModalDisplaySettingsModalParametersDisplaySettingsModalPropsEventSettingsModalEventSettingsModalPropsConfirmExitModalConfirmExitModalPropsMediaSettingsModalMediaSettingsModalParametersMediaSettingsModalPropsMediasfuGenericMediasfuBroadcastMediasfuChatMediasfuConferenceMediasfuWebinarMeetingIDComponentMeetingPasscodeComponentShareButtonsComponentMenuModalMenuItemComponentCustomButtonsMeetingIdComponentPropsMeetingPasscodeComponentPropsShareButtonsComponentPropsShareButtonMenuItemComponentPropsCustomButtonsPropsMessagePanelMessagesModalShareEventModalConfirmHereModalPreJoinPageWelcomePageShareEventModalPropsConfirmHereModalPropsPreJoinPagePropsWelcomePagePropsParticipantListParticipantListItemParticipantListOthersParticipantListOthersItemParticipantsModalPollModalRecordingModalStandardPanelComponentAdvancedPanelComponentRecordingModalParametersRecordingModalPropsStandardPanelParametersStandardPanelPropsAdvancedPanelParametersAdvancedPanelPropsRenderRequestComponentRequestsModalScreenboardScreenboardModalScreenboardPropsScreenboardParametersScreenboardModalPropsScreenboardModalParametersWaitingModalConfigureWhiteboardModal
    Type Aliases
    AddPanelistTypeBreakoutRoomUpdatedTypeCheckPauseStateTypeCheckResumeStateTypeConfirmRecordingTypeFocusPanelistsTypeLanguageModeLanguageRegionLaunchBreakoutRoomsTypeLaunchCoHostTypeLaunchConfigureWhiteboardTypeLaunchConfirmExitTypeLaunchDisplaySettingsTypeLaunchMediaSettingsTypeLaunchMessagesTypeLaunchPanelistsTypeLaunchParticipantsTypeLaunchPermissionsTypeLaunchPollTypeLaunchRecordingTypeLaunchRequestsTypeLaunchSettingsTypeLaunchWaitingTypePermissionLevelRecordPauseTimerTypeRecordResumeTimerTypeRecordStartTimerTypeRecordUpdateTimerTypeRemovePanelistTypeStartRecordingTypeStopRecordingTypeTTSSupportUnfocusPanelistsTypeUpdatePanelistsTypeUpdateRecordingTypeVoiceGenderTriggerTypeChangeVidsTypeReorderStreamsTypeCompareScreenStatesTypeCompareActiveNamesTypeRePortTypeOnScreenChangesTypeShowAlertSettingsMainSpecsDispSpecsTextSpecsAltDomainsRequestPermissionAudioTypeRequestPermissionCameraTypeControlsPositionInfoPositionEventTypeSeedDataAParamsTypeHParamsTypeVParamsTypeScreenParamsTypeStyleDictionaryCustomRendererShapeCreateWebRTCTransportResponseCreateJoinRoomTypeCreateRoomOnMediaSFUTypeJoinRoomOnMediaSFUTypeSleepTypeMuteParticipantsTypeMessageParticipantsTypeRemoveParticipantsTypeAddVideosGridTypeConsumerResumeTypePrepopulateUserMediaTypeCustomComponentCustomVideoCardComponentCustomAudioCardComponentCustomMiniCardComponentCustomPreJoinPageComponentMediaSFUSocketOverrideComponentPropsTypedOverride
    Variables
    addPanelistbreakoutRoomUpdatedcheckPauseStatecheckResumeStateconfirmRecordingfocusPanelistsgetLanguageMetadatagetLanguageNamegetLanguageNativeNamegetSupportedLanguagesisLanguageSupportedisSubtitleExpiredlaunchBreakoutRoomslaunchCoHostlaunchConfigureWhiteboardlaunchConfirmExitlaunchDisplaySettingslaunchMediaSettingslaunchMessageslaunchPanelistslaunchParticipantslaunchPermissionslaunchPolllaunchRecordinglaunchRequestslaunchSettingslaunchWaitingnormalizeLanguageCodepruneExpiredSubtitlesrecordPauseTimerrecordResumeTimerrecordStartTimerrecordUpdateTimerremovePaneliststartRecordingstopRecordingSUPPORTED_LANGUAGE_CODEStranslationChannelsAvailabletranslationConfigUpdatedtranslationErrortranslationLanguageSettranslationMemberStatetranslationProducerClosedtranslationProducerReadytranslationRoomConfigtranslationSpeakerOutputChangedtranslationSubscribedtranslationTranscripttranslationUnsubscribedunfocusPanelistsupdateLiveSubtitlesFromTranscriptupdatePanelistsupdateParticipantPermissionupdatePermissionConfigupdateRecordingBackgroundModalconsumerResumeliveSubtitleServicecreateRoomOnMediaSFUjoinRoomOnMediaSFU