MediaSFU React Native
    Preparing search index...

    Interface ProducerClosedParameters

    Parameters consumed by AudioCard to reflect live meeting state and permissions.

    AudioCardParameters

    Telemetry & Participants:

    interface ProducerClosedParameters {
        socket: Socket;
        coHostResponsibility: CoHostResponsibility[];
        roomName: string;
        showAlert?: ShowAlert;
        coHost: string;
        updateAddAltGrid: (addAltGrid: boolean) => void;
        otherGridStreams: Element[][];
        updateOtherGridStreams: (otherGridStreams: Element[][]) => void;
        updateMiniCardsGrid: UpdateMiniCardsGridType;
        p_activeNames: string[];
        dispActiveNames: string[];
        non_alVideoStreams: Participant[];
        ref_participants: Participant[];
        islevel: string;
        member: string;
        sortAudioLoudness: boolean;
        audioDecibels: AudioDecibels[];
        mixed_alVideoStreams: (Stream | Participant)[];
        non_alVideoStreams_muted: Participant[];
        remoteProducerId?: string;
        localStreamVideo: MediaStream;
        screenPageLimit: number;
        meetingVideoOptimized: boolean;
        paginatedStreams: (Stream | Participant)[][];
        itemPageLimit: number;
        doPaginate: boolean;
        prevDoPaginate: boolean;
        currentUserPage: number;
        breakoutRooms: BreakoutParticipant[][];
        hostNewRoom: number;
        breakOutRoomStarted: boolean;
        breakOutRoomEnded: boolean;
        virtualStream: MediaStream;
        mainRoomsLength: number;
        memberRoom: number;
        updateP_activeNames: (names: string[]) => void;
        updateDispActiveNames: (names: string[]) => void;
        updateNon_alVideoStreams: (participants: Participant[]) => void;
        updateRef_participants: (participants: Participant[]) => void;
        updateSortAudioLoudness: (sort: boolean) => void;
        updateMixed_alVideoStreams: (streams: (Stream | Participant)[]) => void;
        updateNon_alVideoStreams_muted: (participants: Participant[]) => void;
        updatePaginatedStreams: (streams: (Stream | Participant)[][]) => void;
        updateDoPaginate: (paginate: boolean) => void;
        updatePrevDoPaginate: (paginate: boolean) => void;
        updateCurrentUserPage: (page: number) => void;
        updateNumberPages: (pages: number) => void;
        updateMainRoomsLength: (length: number) => void;
        updateMemberRoom: (room: number) => void;
        mixStreams: MixStreamsType;
        dispStreams: DispStreamsType;
        allAudioStreams: (Stream | Participant)[];
        allVideoStreams: (Stream | Participant)[];
        activeNames: string[];
        participants: Participant[];
        streamNames: Stream[];
        recordingDisplayType: "video" | "media" | "all";
        recordingVideoOptimized: boolean;
        adminIDStream?: string;
        newLimitedStreams: (Stream | Participant)[];
        newLimitedStreamsIDs: string[];
        oldAllStreams: (Stream | Participant)[];
        shareScreenStarted: boolean;
        shared: boolean;
        meetingDisplayType: string;
        defer_receive: boolean;
        lock_screen: boolean;
        firstAll: boolean;
        first_round: boolean;
        gotAllVids: boolean;
        eventType: EventType;
        hostLabel: string;
        shareEnded: boolean;
        updateMainWindow: boolean;
        updateActiveNames: (activeNames: string[]) => void;
        updateAllAudioStreams: (allAudioStreams: (Stream | Participant)[]) => void;
        updateShareScreenStarted: (shareScreenStarted: boolean) => void;
        updateUpdateMainWindow: (updateMainWindow: boolean) => void;
        updateNewLimitedStreams: (
            newLimitedStreams: (Stream | Participant)[],
        ) => void;
        updateOldAllStreams: (oldAllStreams: (Stream | Participant)[]) => void;
        updateDefer_receive: (defer_receive: boolean) => void;
        updateMainHeightWidth: (heightWidth: number) => void;
        updateShareEnded: (shareEnded: boolean) => void;
        updateLock_screen: (lock_screen: boolean) => void;
        updateFirstAll: (firstAll: boolean) => void;
        updateFirst_round: (first_round: boolean) => void;
        reorderStreams: ReorderStreamsType;
        prepopulateUserMedia: PrepopulateUserMediaType;
        getVideos: GetVideosType;
        rePort: RePortType;
        prevActiveNames: string[];
        updatePrevActiveNames: (prevActiveNames: string[]) => void;
        trigger: TriggerType;
        audStreamNames: Stream[];
        mainHeightWidth: number;
        prevMainHeightWidth: number;
        p_dispActiveNames: string[];
        nForReadjustRecord: number;
        chatRefStreams: (Stream | Participant)[];
        keepBackground: boolean;
        updateLStreams: (streams: (Stream | Participant)[]) => void;
        updateChatRefStreams: (streams: (Stream | Participant)[]) => void;
        updateNForReadjustRecord: (n: number) => void;
        updateShowMiniView: (value: boolean) => void;
        processConsumerTransports: ProcessConsumerTransportsType;
        resumePauseStreams: ResumePauseStreamsType;
        readjust: ReadjustType;
        addVideosGrid: AddVideosGridType;
        getEstimate: GetEstimateType;
        checkGrid: CheckGridType;
        resumePauseAudioStreams: ResumePauseAudioStreamsType;
        fixedPageLimit: number;
        removeAltGrid: boolean;
        isMediumScreen: boolean;
        updateRemoveAltGrid: (value: boolean) => void;
        calculateRowsAndColumns: CalculateRowsAndColumnsType;
        forceFullDisplay: boolean;
        mainScreenFilled: boolean;
        adminOnMainScreen: boolean;
        mainScreenPerson: string;
        videoAlreadyOn: boolean;
        audioAlreadyOn: boolean;
        checkOrientation: () => string;
        screenForceFullDisplay: boolean;
        localStreamScreen: MediaStream;
        remoteScreenStream: Stream[];
        isWideScreen: boolean;
        localUIMode: boolean;
        whiteboardStarted: boolean;
        whiteboardEnded: boolean;
        annotateScreenStream: boolean;
        updateMainScreenPerson: (person: string) => void;
        updateMainScreenFilled: (filled: boolean) => void;
        updateAdminOnMainScreen: (admin: boolean) => void;
        updateScreenForceFullDisplay: (force: boolean) => void;
        updateMainGridStream: (components: Element[]) => void;
        customVideoCard?: CustomVideoCardType;
        customAudioCard?: CustomAudioCardType;
        customMiniCard?: CustomMiniCardType;
        videoCardComponent?: ComponentType<VideoCardOptions>;
        audioCardComponent?: ComponentType<AudioCardOptions>;
        miniCardComponent?: ComponentType<MiniCardOptions>;
        sleep: SleepType;
        recordStarted: boolean;
        recordStopped: boolean;
        recordPaused: boolean;
        recordResumed: boolean;
        screenStates: ScreenState[];
        prevScreenStates: ScreenState[];
        updateScreenStates: (states: ScreenState[]) => void;
        updatePrevScreenStates: (states: ScreenState[]) => void;
        compareActiveNames: CompareActiveNamesType;
        compareScreenStates: CompareScreenStatesType;
        adminVidID?: string;
        activeSounds: string[];
        screenShareIDStream?: string;
        screenShareNameStream?: string;
        adminNameStream?: string;
        updateNewLimitedStreamsIDs: (ids: string[]) => void;
        updateActiveSounds: (sounds: string[]) => void;
        updateScreenShareIDStream: (id: string) => void;
        updateScreenShareNameStream: (name: string) => void;
        updateAdminIDStream: (id: string) => void;
        updateAdminNameStream: (name: string) => void;
        updateYouYouStream: (streams: (Stream | Participant)[]) => void;
        changeVids: ChangeVidsType;
        limitedBreakRoom: BreakoutParticipant[];
        updateLimitedBreakRoom: (limitedBreakRoom: BreakoutParticipant[]) => void;
        processConsumerTransportsAudio: ProcessConsumerTransportsAudioType;
        consumerTransports: Transport[];
        screenId?: string;
        updateConsumerTransports: (transports: Transport[]) => void;
        closeAndResize: CloseAndResizeType;
        getUpdatedAllParams: () => ProducerClosedParameters;
        localSocket?: Socket;
        updateDateState?: number;
        lastUpdate: number;
        nForReadjust: number;
        updateUpdateDateState: (timestamp: number) => void;
        updateLastUpdate: (lastUpdate: number) => void;
        updateNForReadjust: (nForReadjust: number) => void;
        autoAdjust: AutoAdjustType;
        updateGridRows: (rows: number) => void;
        updateGridCols: (cols: number) => void;
        updateAltGridRows: (rows: number) => void;
        updateAltGridCols: (cols: number) => void;
        updateGridSizes: (gridSizes: GridSizes) => void;
        gridSizes: GridSizes;
        paginationDirection: string;
        paginationHeightWidth: number;
        componentSizes: ComponentSizes;
        [key: string]: any;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: any
    Index

    Properties

    socket coHostResponsibility roomName showAlert? coHost updateAddAltGrid otherGridStreams updateOtherGridStreams updateMiniCardsGrid p_activeNames dispActiveNames non_alVideoStreams ref_participants islevel member sortAudioLoudness audioDecibels mixed_alVideoStreams non_alVideoStreams_muted remoteProducerId? localStreamVideo screenPageLimit meetingVideoOptimized paginatedStreams itemPageLimit doPaginate prevDoPaginate currentUserPage breakoutRooms hostNewRoom breakOutRoomStarted breakOutRoomEnded virtualStream mainRoomsLength memberRoom updateP_activeNames updateDispActiveNames updateNon_alVideoStreams updateRef_participants updateSortAudioLoudness updateMixed_alVideoStreams updateNon_alVideoStreams_muted updatePaginatedStreams updateDoPaginate updatePrevDoPaginate updateCurrentUserPage updateNumberPages updateMainRoomsLength updateMemberRoom mixStreams dispStreams allAudioStreams allVideoStreams activeNames participants streamNames recordingDisplayType recordingVideoOptimized adminIDStream? newLimitedStreams newLimitedStreamsIDs oldAllStreams shareScreenStarted shared meetingDisplayType defer_receive lock_screen firstAll first_round gotAllVids eventType hostLabel shareEnded updateMainWindow updateActiveNames updateAllAudioStreams updateShareScreenStarted updateUpdateMainWindow updateNewLimitedStreams updateOldAllStreams updateDefer_receive updateMainHeightWidth updateShareEnded updateLock_screen updateFirstAll updateFirst_round reorderStreams prepopulateUserMedia getVideos rePort prevActiveNames updatePrevActiveNames trigger audStreamNames mainHeightWidth prevMainHeightWidth p_dispActiveNames nForReadjustRecord chatRefStreams keepBackground updateLStreams updateChatRefStreams updateNForReadjustRecord updateShowMiniView processConsumerTransports resumePauseStreams readjust addVideosGrid getEstimate checkGrid resumePauseAudioStreams fixedPageLimit removeAltGrid isMediumScreen updateRemoveAltGrid calculateRowsAndColumns forceFullDisplay mainScreenFilled adminOnMainScreen mainScreenPerson videoAlreadyOn audioAlreadyOn checkOrientation screenForceFullDisplay localStreamScreen remoteScreenStream isWideScreen localUIMode whiteboardStarted whiteboardEnded annotateScreenStream updateMainScreenPerson updateMainScreenFilled updateAdminOnMainScreen updateScreenForceFullDisplay updateMainGridStream customVideoCard? customAudioCard? customMiniCard? videoCardComponent? audioCardComponent? miniCardComponent? sleep recordStarted recordStopped recordPaused recordResumed screenStates prevScreenStates updateScreenStates updatePrevScreenStates compareActiveNames compareScreenStates adminVidID? activeSounds screenShareIDStream? screenShareNameStream? adminNameStream? updateNewLimitedStreamsIDs updateActiveSounds updateScreenShareIDStream updateScreenShareNameStream updateAdminIDStream updateAdminNameStream updateYouYouStream changeVids limitedBreakRoom updateLimitedBreakRoom processConsumerTransportsAudio consumerTransports screenId? updateConsumerTransports closeAndResize getUpdatedAllParams localSocket? updateDateState? lastUpdate nForReadjust updateUpdateDateState updateLastUpdate updateNForReadjust autoAdjust updateGridRows updateGridCols updateAltGridRows updateAltGridCols updateGridSizes gridSizes paginationDirection paginationHeightWidth componentSizes

    Properties

    socket: Socket

    Socket instance for media control events.

    coHostResponsibility: CoHostResponsibility[]

    Active co-host capabilities.

    roomName: string

    Active room identifier.

    showAlert?: ShowAlert

    Optional alert helper.

    coHost: string

    Current co-host identifier.

    updateAddAltGrid: (addAltGrid: boolean) => void
    otherGridStreams: Element[][]
    updateOtherGridStreams: (otherGridStreams: Element[][]) => void
    updateMiniCardsGrid: UpdateMiniCardsGridType
    p_activeNames: string[]
    dispActiveNames: string[]
    non_alVideoStreams: Participant[]
    ref_participants: Participant[]
    islevel: string

    Member privilege level.

    member: string

    Local member identifier.

    sortAudioLoudness: boolean
    audioDecibels: AudioDecibels[]

    Live loudness metrics per participant.

    mixed_alVideoStreams: (Stream | Participant)[]
    non_alVideoStreams_muted: Participant[]
    remoteProducerId?: string
    localStreamVideo: MediaStream
    screenPageLimit: number
    meetingVideoOptimized: boolean
    paginatedStreams: (Stream | Participant)[][]
    itemPageLimit: number
    doPaginate: boolean
    prevDoPaginate: boolean
    currentUserPage: number
    breakoutRooms: BreakoutParticipant[][]
    hostNewRoom: number
    breakOutRoomStarted: boolean
    breakOutRoomEnded: boolean
    virtualStream: MediaStream
    mainRoomsLength: number
    memberRoom: number
    updateP_activeNames: (names: string[]) => void
    updateDispActiveNames: (names: string[]) => void
    updateNon_alVideoStreams: (participants: Participant[]) => void
    updateRef_participants: (participants: Participant[]) => void
    updateSortAudioLoudness: (sort: boolean) => void
    updateMixed_alVideoStreams: (streams: (Stream | Participant)[]) => void
    updateNon_alVideoStreams_muted: (participants: Participant[]) => void
    updatePaginatedStreams: (streams: (Stream | Participant)[][]) => void
    updateDoPaginate: (paginate: boolean) => void
    updatePrevDoPaginate: (paginate: boolean) => void
    updateCurrentUserPage: (page: number) => void
    updateNumberPages: (pages: number) => void
    updateMainRoomsLength: (length: number) => void
    updateMemberRoom: (room: number) => void
    mixStreams: MixStreamsType
    dispStreams: DispStreamsType
    allAudioStreams: (Stream | Participant)[]
    allVideoStreams: (Stream | Participant)[]
    activeNames: string[]
    participants: Participant[]

    Current participant roster.

    Session Context:

    streamNames: Stream[]
    recordingDisplayType: "video" | "media" | "all"
    recordingVideoOptimized: boolean
    adminIDStream?: string
    newLimitedStreams: (Stream | Participant)[]
    newLimitedStreamsIDs: string[]
    oldAllStreams: (Stream | Participant)[]
    shareScreenStarted: boolean
    shared: boolean
    meetingDisplayType: string
    defer_receive: boolean
    lock_screen: boolean
    firstAll: boolean
    first_round: boolean
    gotAllVids: boolean
    eventType: EventType

    Meeting event type (e.g., conference).

    Helpers:

    hostLabel: string
    shareEnded: boolean
    updateMainWindow: boolean
    updateActiveNames: (activeNames: string[]) => void
    updateAllAudioStreams: (allAudioStreams: (Stream | Participant)[]) => void
    updateShareScreenStarted: (shareScreenStarted: boolean) => void
    updateUpdateMainWindow: (updateMainWindow: boolean) => void
    updateNewLimitedStreams: (newLimitedStreams: (Stream | Participant)[]) => void
    updateOldAllStreams: (oldAllStreams: (Stream | Participant)[]) => void
    updateDefer_receive: (defer_receive: boolean) => void
    updateMainHeightWidth: (heightWidth: number) => void
    updateShareEnded: (shareEnded: boolean) => void
    updateLock_screen: (lock_screen: boolean) => void
    updateFirstAll: (firstAll: boolean) => void
    updateFirst_round: (first_round: boolean) => void
    reorderStreams: ReorderStreamsType
    prepopulateUserMedia: PrepopulateUserMediaType
    getVideos: GetVideosType
    rePort: RePortType
    prevActiveNames: string[]
    updatePrevActiveNames: (prevActiveNames: string[]) => void
    trigger: TriggerType
    audStreamNames: Stream[]
    mainHeightWidth: number
    prevMainHeightWidth: number
    p_dispActiveNames: string[]
    nForReadjustRecord: number
    chatRefStreams: (Stream | Participant)[]
    keepBackground: boolean
    updateLStreams: (streams: (Stream | Participant)[]) => void
    updateChatRefStreams: (streams: (Stream | Participant)[]) => void
    updateNForReadjustRecord: (n: number) => void
    updateShowMiniView: (value: boolean) => void
    processConsumerTransports: ProcessConsumerTransportsType
    resumePauseStreams: ResumePauseStreamsType
    readjust: ReadjustType
    addVideosGrid: AddVideosGridType
    getEstimate: GetEstimateType
    checkGrid: CheckGridType
    resumePauseAudioStreams: ResumePauseAudioStreamsType
    fixedPageLimit: number
    removeAltGrid: boolean
    isMediumScreen: boolean
    updateRemoveAltGrid: (value: boolean) => void
    calculateRowsAndColumns: CalculateRowsAndColumnsType
    forceFullDisplay: boolean
    mainScreenFilled: boolean
    adminOnMainScreen: boolean
    mainScreenPerson: string
    videoAlreadyOn: boolean
    audioAlreadyOn: boolean
    checkOrientation: () => string
    screenForceFullDisplay: boolean
    localStreamScreen: MediaStream
    remoteScreenStream: Stream[]
    isWideScreen: boolean
    localUIMode: boolean
    whiteboardStarted: boolean
    whiteboardEnded: boolean
    annotateScreenStream: boolean
    updateMainScreenPerson: (person: string) => void
    updateMainScreenFilled: (filled: boolean) => void
    updateAdminOnMainScreen: (admin: boolean) => void
    updateScreenForceFullDisplay: (force: boolean) => void
    updateMainGridStream: (components: Element[]) => void
    customVideoCard?: CustomVideoCardType
    customAudioCard?: CustomAudioCardType
    customMiniCard?: CustomMiniCardType
    videoCardComponent?: ComponentType<VideoCardOptions>
    audioCardComponent?: ComponentType<AudioCardOptions>
    miniCardComponent?: ComponentType<MiniCardOptions>
    sleep: SleepType
    recordStarted: boolean
    recordStopped: boolean
    recordPaused: boolean
    recordResumed: boolean
    screenStates: ScreenState[]
    prevScreenStates: ScreenState[]
    updateScreenStates: (states: ScreenState[]) => void
    updatePrevScreenStates: (states: ScreenState[]) => void
    compareActiveNames: CompareActiveNamesType
    compareScreenStates: CompareScreenStatesType
    adminVidID?: string
    activeSounds: string[]
    screenShareIDStream?: string
    screenShareNameStream?: string
    adminNameStream?: string
    updateNewLimitedStreamsIDs: (ids: string[]) => void
    updateActiveSounds: (sounds: string[]) => void
    updateScreenShareIDStream: (id: string) => void
    updateScreenShareNameStream: (name: string) => void
    updateAdminIDStream: (id: string) => void
    updateAdminNameStream: (name: string) => void
    updateYouYouStream: (streams: (Stream | Participant)[]) => void
    changeVids: ChangeVidsType
    limitedBreakRoom: BreakoutParticipant[]
    updateLimitedBreakRoom: (limitedBreakRoom: BreakoutParticipant[]) => void
    processConsumerTransportsAudio: ProcessConsumerTransportsAudioType
    consumerTransports: Transport[]
    screenId?: string
    updateConsumerTransports: (transports: Transport[]) => void
    closeAndResize: CloseAndResizeType
    getUpdatedAllParams: () => ProducerClosedParameters

    Refreshes parameters before invoking side effects.

    localSocket?: Socket
    updateDateState?: number
    lastUpdate: number
    nForReadjust: number
    updateUpdateDateState: (timestamp: number) => void
    updateLastUpdate: (lastUpdate: number) => void
    updateNForReadjust: (nForReadjust: number) => void
    autoAdjust: AutoAdjustType
    updateGridRows: (rows: number) => void
    updateGridCols: (cols: number) => void
    updateAltGridRows: (rows: number) => void
    updateAltGridCols: (cols: number) => void
    updateGridSizes: (gridSizes: GridSizes) => void
    gridSizes: GridSizes
    paginationDirection: string
    paginationHeightWidth: number
    componentSizes: ComponentSizes