MediaSFU React Native
    Preparing search index...

    Interface ProducerMediaResumedParameters

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

    AudioCardParameters

    Telemetry & Participants:

    interface ProducerMediaResumedParameters {
        audioDecibels: AudioDecibels[];
        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[];
        activeNames: string[];
        dispActiveNames: string[];
        non_alVideoStreams: Participant[];
        ref_participants: Participant[];
        sortAudioLoudness: boolean;
        mixed_alVideoStreams: (Stream | Participant)[];
        non_alVideoStreams_muted: Participant[];
        remoteProducerId?: string;
        screenPageLimit: number;
        meetingVideoOptimized: boolean;
        recordingVideoOptimized: boolean;
        recordingDisplayType: "video" | "media" | "all";
        paginatedStreams: (Stream | Participant)[][];
        itemPageLimit: number;
        doPaginate: boolean;
        prevDoPaginate: boolean;
        currentUserPage: number;
        breakoutRooms: BreakoutParticipant[][];
        hostNewRoom: number;
        breakOutRoomStarted: boolean;
        breakOutRoomEnded: boolean;
        mainRoomsLength: number;
        memberRoom: number;
        updateP_activeNames: (names: string[]) => void;
        updateActiveNames: (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;
        prevActiveNames: string[];
        updatePrevActiveNames: (prevActiveNames: string[]) => void;
        trigger: TriggerType;
        consumerTransports: Transport[];
        streamNames: Stream[];
        audStreamNames: Stream[];
        prevMainHeightWidth: number;
        firstAll: boolean;
        shareEnded: boolean;
        p_dispActiveNames: string[];
        nForReadjustRecord: number;
        first_round: boolean;
        lock_screen: boolean;
        chatRefStreams: (Stream | Participant)[];
        updateLStreams: (streams: (Stream | Participant)[]) => void;
        updateChatRefStreams: (streams: (Stream | Participant)[]) => void;
        updateNForReadjustRecord: (n: number) => void;
        updateShowMiniView: (value: boolean) => void;
        rePort: RePortType;
        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;
        allVideoStreams: (Stream | Participant)[];
        islevel: string;
        member: string;
        eventType: EventType;
        screenId?: string;
        forceFullDisplay: boolean;
        updateMainWindow: boolean;
        adminOnMainScreen: boolean;
        mainScreenPerson: string;
        videoAlreadyOn: boolean;
        audioAlreadyOn: boolean;
        oldAllStreams: (Stream | Participant)[];
        checkOrientation: () => string;
        screenForceFullDisplay: boolean;
        localStreamScreen: MediaStream;
        remoteScreenStream: Stream[];
        localStreamVideo: MediaStream;
        mainHeightWidth: number;
        isWideScreen: boolean;
        localUIMode: boolean;
        whiteboardStarted: boolean;
        whiteboardEnded: boolean;
        virtualStream: MediaStream;
        keepBackground: boolean;
        annotateScreenStream: boolean;
        updateMainScreenPerson: (person: string) => void;
        updateMainScreenFilled: (filled: boolean) => void;
        updateAdminOnMainScreen: (admin: boolean) => void;
        updateMainHeightWidth: (heightWidth: number) => 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;
        newLimitedStreams: (Stream | Participant)[];
        newLimitedStreamsIDs: string[];
        activeSounds: string[];
        screenShareIDStream?: string;
        screenShareNameStream?: string;
        adminIDStream?: string;
        adminNameStream?: string;
        updateNewLimitedStreams: (streams: (Stream | Participant)[]) => void;
        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;
        allAudioStreams: (Stream | Participant)[];
        limitedBreakRoom: BreakoutParticipant[];
        updateLimitedBreakRoom: (limitedBreakRoom: BreakoutParticipant[]) => void;
        processConsumerTransportsAudio: ProcessConsumerTransportsAudioType;
        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;
        meetingDisplayType: string;
        participants: Participant[];
        shared: boolean;
        shareScreenStarted: boolean;
        mainScreenFilled: boolean;
        hostLabel: string;
        updateUpdateMainWindow: (updateMainWindow: boolean) => void;
        reorderStreams: ReorderStreamsType;
        prepopulateUserMedia: PrepopulateUserMediaType;
        getUpdatedAllParams: () => ProducerMediaResumedParameters;
        [key: string]: any;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: any
    Index

    Properties

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

    Properties

    audioDecibels: AudioDecibels[]

    Live loudness metrics per participant.

    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[]
    activeNames: string[]
    dispActiveNames: string[]
    non_alVideoStreams: Participant[]
    ref_participants: Participant[]
    sortAudioLoudness: boolean
    mixed_alVideoStreams: (Stream | Participant)[]
    non_alVideoStreams_muted: Participant[]
    remoteProducerId?: string
    screenPageLimit: number
    meetingVideoOptimized: boolean
    recordingVideoOptimized: boolean
    recordingDisplayType: "video" | "media" | "all"
    paginatedStreams: (Stream | Participant)[][]
    itemPageLimit: number
    doPaginate: boolean
    prevDoPaginate: boolean
    currentUserPage: number
    breakoutRooms: BreakoutParticipant[][]
    hostNewRoom: number
    breakOutRoomStarted: boolean
    breakOutRoomEnded: boolean
    mainRoomsLength: number
    memberRoom: number
    updateP_activeNames: (names: string[]) => void
    updateActiveNames: (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
    prevActiveNames: string[]
    updatePrevActiveNames: (prevActiveNames: string[]) => void
    trigger: TriggerType
    consumerTransports: Transport[]
    streamNames: Stream[]
    audStreamNames: Stream[]
    prevMainHeightWidth: number
    firstAll: boolean
    shareEnded: boolean
    p_dispActiveNames: string[]
    nForReadjustRecord: number
    first_round: boolean
    lock_screen: boolean
    chatRefStreams: (Stream | Participant)[]
    updateLStreams: (streams: (Stream | Participant)[]) => void
    updateChatRefStreams: (streams: (Stream | Participant)[]) => void
    updateNForReadjustRecord: (n: number) => void
    updateShowMiniView: (value: boolean) => void
    rePort: RePortType
    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
    allVideoStreams: (Stream | Participant)[]
    islevel: string

    Member privilege level.

    member: string

    Local member identifier.

    eventType: EventType

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

    Helpers:

    screenId?: string
    forceFullDisplay: boolean
    updateMainWindow: boolean
    adminOnMainScreen: boolean
    mainScreenPerson: string
    videoAlreadyOn: boolean
    audioAlreadyOn: boolean
    oldAllStreams: (Stream | Participant)[]
    checkOrientation: () => string
    screenForceFullDisplay: boolean
    localStreamScreen: MediaStream
    remoteScreenStream: Stream[]
    localStreamVideo: MediaStream
    mainHeightWidth: number
    isWideScreen: boolean
    localUIMode: boolean
    whiteboardStarted: boolean
    whiteboardEnded: boolean
    virtualStream: MediaStream
    keepBackground: boolean
    annotateScreenStream: boolean
    updateMainScreenPerson: (person: string) => void
    updateMainScreenFilled: (filled: boolean) => void
    updateAdminOnMainScreen: (admin: boolean) => void
    updateMainHeightWidth: (heightWidth: number) => 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
    newLimitedStreams: (Stream | Participant)[]
    newLimitedStreamsIDs: string[]
    activeSounds: string[]
    screenShareIDStream?: string
    screenShareNameStream?: string
    adminIDStream?: string
    adminNameStream?: string
    updateNewLimitedStreams: (streams: (Stream | Participant)[]) => void
    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
    allAudioStreams: (Stream | Participant)[]
    limitedBreakRoom: BreakoutParticipant[]
    updateLimitedBreakRoom: (limitedBreakRoom: BreakoutParticipant[]) => void
    processConsumerTransportsAudio: ProcessConsumerTransportsAudioType
    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
    meetingDisplayType: string
    participants: Participant[]

    Current participant roster.

    Session Context:

    shared: boolean
    shareScreenStarted: boolean
    mainScreenFilled: boolean
    hostLabel: string
    updateUpdateMainWindow: (updateMainWindow: boolean) => void
    reorderStreams: ReorderStreamsType
    prepopulateUserMedia: PrepopulateUserMediaType
    getUpdatedAllParams: () => ProducerMediaResumedParameters

    Refreshes parameters before invoking side effects.