MediaSFU React Native
    Preparing search index...

    Interface DispStreamsParameters

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

    AudioCardParameters

    Telemetry & Participants:

    interface DispStreamsParameters {
        audioDecibels: AudioDecibels[];
        socket: Socket;
        coHostResponsibility: CoHostResponsibility[];
        roomName: string;
        showAlert?: ShowAlert;
        coHost: string;
        updateAddAltGrid: (addAltGrid: boolean) => void;
        otherGridStreams: Element[][];
        updateOtherGridStreams: (otherGridStreams: Element[][]) => void;
        updateMiniCardsGrid: UpdateMiniCardsGridType;
        prevActiveNames: string[];
        updatePrevActiveNames: (prevActiveNames: string[]) => void;
        trigger: TriggerType;
        consumerTransports: Transport[];
        streamNames: Stream[];
        audStreamNames: Stream[];
        participants: Participant[];
        ref_participants: Participant[];
        recordingDisplayType: "video" | "media" | "all";
        recordingVideoOptimized: boolean;
        meetingDisplayType: string;
        meetingVideoOptimized: boolean;
        currentUserPage: number;
        hostLabel: string;
        mainHeightWidth: number;
        prevMainHeightWidth: number;
        prevDoPaginate: boolean;
        doPaginate: boolean;
        firstAll: boolean;
        shared: boolean;
        shareScreenStarted: boolean;
        shareEnded: boolean;
        oldAllStreams: (Stream | Participant)[];
        updateMainWindow: boolean;
        remoteProducerId?: string;
        activeNames: string[];
        dispActiveNames: string[];
        p_dispActiveNames: string[];
        nForReadjustRecord: number;
        first_round: boolean;
        lock_screen: boolean;
        chatRefStreams: (Stream | Participant)[];
        eventType: EventType;
        islevel: string;
        localStreamVideo: MediaStream;
        breakOutRoomStarted: boolean;
        breakOutRoomEnded: boolean;
        keepBackground: boolean;
        virtualStream: MediaStream;
        updateActiveNames: (names: string[]) => void;
        updateDispActiveNames: (names: string[]) => void;
        updateLStreams: (streams: (Stream | Participant)[]) => void;
        updateChatRefStreams: (streams: (Stream | Participant)[]) => void;
        updateNForReadjustRecord: (n: number) => void;
        updateUpdateMainWindow: (value: boolean) => void;
        updateShowMiniView: (value: boolean) => void;
        prepopulateUserMedia: PrepopulateUserMediaType;
        rePort: RePortType;
        processConsumerTransports: ProcessConsumerTransportsType;
        resumePauseStreams: ResumePauseStreamsType;
        readjust: ReadjustType;
        addVideosGrid: AddVideosGridType;
        getEstimate: GetEstimateType;
        checkGrid: CheckGridType;
        resumePauseAudioStreams: ResumePauseAudioStreamsType;
        getUpdatedAllParams: () => DispStreamsParameters;
        fixedPageLimit: number;
        screenPageLimit: number;
        removeAltGrid: boolean;
        isMediumScreen: boolean;
        updateRemoveAltGrid: (value: boolean) => void;
        calculateRowsAndColumns: CalculateRowsAndColumnsType;
        allVideoStreams: (Stream | Participant)[];
        member: string;
        screenId?: string;
        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;
        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>;
        newLimitedStreams: (Stream | Participant)[];
        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;
        breakoutRooms: BreakoutParticipant[][];
        allAudioStreams: (Stream | Participant)[];
        limitedBreakRoom: BreakoutParticipant[];
        hostNewRoom: number;
        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;
        [key: string]: any;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: any
    Index

    Properties

    audioDecibels socket coHostResponsibility roomName showAlert? coHost updateAddAltGrid otherGridStreams updateOtherGridStreams updateMiniCardsGrid prevActiveNames updatePrevActiveNames trigger consumerTransports streamNames audStreamNames participants ref_participants recordingDisplayType recordingVideoOptimized meetingDisplayType meetingVideoOptimized currentUserPage hostLabel mainHeightWidth prevMainHeightWidth prevDoPaginate doPaginate firstAll shared shareScreenStarted shareEnded oldAllStreams updateMainWindow remoteProducerId? activeNames dispActiveNames p_dispActiveNames nForReadjustRecord first_round lock_screen chatRefStreams eventType islevel localStreamVideo breakOutRoomStarted breakOutRoomEnded keepBackground virtualStream updateActiveNames updateDispActiveNames updateLStreams updateChatRefStreams updateNForReadjustRecord updateUpdateMainWindow updateShowMiniView prepopulateUserMedia rePort processConsumerTransports resumePauseStreams readjust addVideosGrid getEstimate checkGrid resumePauseAudioStreams getUpdatedAllParams fixedPageLimit screenPageLimit removeAltGrid isMediumScreen updateRemoveAltGrid calculateRowsAndColumns allVideoStreams member screenId? forceFullDisplay mainScreenFilled adminOnMainScreen mainScreenPerson videoAlreadyOn audioAlreadyOn checkOrientation screenForceFullDisplay localStreamScreen remoteScreenStream isWideScreen localUIMode whiteboardStarted whiteboardEnded annotateScreenStream updateMainScreenPerson updateMainScreenFilled updateAdminOnMainScreen updateMainHeightWidth updateScreenForceFullDisplay updateMainGridStream customVideoCard? customAudioCard? customMiniCard? videoCardComponent? audioCardComponent? miniCardComponent? newLimitedStreams sleep recordStarted recordStopped recordPaused recordResumed screenStates prevScreenStates updateScreenStates updatePrevScreenStates compareActiveNames compareScreenStates breakoutRooms allAudioStreams limitedBreakRoom hostNewRoom updateLimitedBreakRoom processConsumerTransportsAudio localSocket? updateDateState? lastUpdate nForReadjust updateUpdateDateState updateLastUpdate updateNForReadjust autoAdjust updateGridRows updateGridCols updateAltGridRows updateAltGridCols updateGridSizes gridSizes paginationDirection paginationHeightWidth componentSizes

    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
    prevActiveNames: string[]
    updatePrevActiveNames: (prevActiveNames: string[]) => void
    trigger: TriggerType
    consumerTransports: Transport[]
    streamNames: Stream[]
    audStreamNames: Stream[]
    participants: Participant[]

    Current participant roster.

    Session Context:

    ref_participants: Participant[]
    recordingDisplayType: "video" | "media" | "all"
    recordingVideoOptimized: boolean
    meetingDisplayType: string
    meetingVideoOptimized: boolean
    currentUserPage: number
    hostLabel: string
    mainHeightWidth: number
    prevMainHeightWidth: number
    prevDoPaginate: boolean
    doPaginate: boolean
    firstAll: boolean
    shared: boolean
    shareScreenStarted: boolean
    shareEnded: boolean
    oldAllStreams: (Stream | Participant)[]
    updateMainWindow: boolean
    remoteProducerId?: string
    activeNames: string[]
    dispActiveNames: string[]
    p_dispActiveNames: string[]
    nForReadjustRecord: number
    first_round: boolean
    lock_screen: boolean
    chatRefStreams: (Stream | Participant)[]
    eventType: EventType

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

    Helpers:

    islevel: string

    Member privilege level.

    localStreamVideo: MediaStream
    breakOutRoomStarted: boolean
    breakOutRoomEnded: boolean
    keepBackground: boolean
    virtualStream: MediaStream
    updateActiveNames: (names: string[]) => void
    updateDispActiveNames: (names: string[]) => void
    updateLStreams: (streams: (Stream | Participant)[]) => void
    updateChatRefStreams: (streams: (Stream | Participant)[]) => void
    updateNForReadjustRecord: (n: number) => void
    updateUpdateMainWindow: (value: boolean) => void
    updateShowMiniView: (value: boolean) => void
    prepopulateUserMedia: PrepopulateUserMediaType
    rePort: RePortType
    processConsumerTransports: ProcessConsumerTransportsType
    resumePauseStreams: ResumePauseStreamsType
    readjust: ReadjustType
    addVideosGrid: AddVideosGridType
    getEstimate: GetEstimateType
    checkGrid: CheckGridType
    resumePauseAudioStreams: ResumePauseAudioStreamsType
    getUpdatedAllParams: () => DispStreamsParameters

    Refreshes parameters before invoking side effects.

    fixedPageLimit: number
    screenPageLimit: number
    removeAltGrid: boolean
    isMediumScreen: boolean
    updateRemoveAltGrid: (value: boolean) => void
    calculateRowsAndColumns: CalculateRowsAndColumnsType
    allVideoStreams: (Stream | Participant)[]
    member: string

    Local member identifier.

    screenId?: string
    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
    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>
    newLimitedStreams: (Stream | Participant)[]
    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
    breakoutRooms: BreakoutParticipant[][]
    allAudioStreams: (Stream | Participant)[]
    limitedBreakRoom: BreakoutParticipant[]
    hostNewRoom: number
    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