MediaSFU React Native
    Preparing search index...

    Interface ChangeVidsParameters

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

    AudioCardParameters

    Telemetry & Participants:

    interface ChangeVidsParameters {
        socket: Socket;
        coHostResponsibility: CoHostResponsibility[];
        roomName: string;
        showAlert?: ShowAlert;
        coHost: string;
        updateAddAltGrid: (addAltGrid: boolean) => void;
        otherGridStreams: Element[][];
        updateOtherGridStreams: (otherGridStreams: Element[][]) => void;
        updateMiniCardsGrid: UpdateMiniCardsGridType;
        allVideoStreams: (Stream | Participant)[];
        p_activeNames: string[];
        activeNames: string[];
        dispActiveNames: string[];
        shareScreenStarted: boolean;
        shared: boolean;
        newLimitedStreams: (Stream | Participant)[];
        non_alVideoStreams: Participant[];
        ref_participants: Participant[];
        participants: Participant[];
        eventType: EventType;
        islevel: string;
        member: string;
        sortAudioLoudness: boolean;
        audioDecibels: AudioDecibels[];
        mixed_alVideoStreams: (Stream | Participant)[];
        non_alVideoStreams_muted: Participant[];
        remoteProducerId?: string;
        localStreamVideo: MediaStream;
        oldAllStreams: (Stream | Participant)[];
        screenPageLimit: number;
        meetingDisplayType: string;
        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;
        virtualStream: MediaStream;
        mainRoomsLength: number;
        memberRoom: number;
        updateP_activeNames: (names: string[]) => void;
        updateActiveNames: (names: string[]) => void;
        updateDispActiveNames: (names: string[]) => void;
        updateNewLimitedStreams: (streams: (Stream | Participant)[]) => 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;
        getUpdatedAllParams: () => ChangeVidsParameters;
        prevActiveNames: string[];
        updatePrevActiveNames: (prevActiveNames: string[]) => void;
        trigger: TriggerType;
        consumerTransports: Transport[];
        streamNames: Stream[];
        audStreamNames: Stream[];
        hostLabel: string;
        mainHeightWidth: number;
        prevMainHeightWidth: number;
        firstAll: boolean;
        shareEnded: boolean;
        updateMainWindow: boolean;
        p_dispActiveNames: string[];
        nForReadjustRecord: number;
        first_round: boolean;
        lock_screen: boolean;
        chatRefStreams: (Stream | Participant)[];
        keepBackground: boolean;
        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;
        fixedPageLimit: number;
        removeAltGrid: boolean;
        isMediumScreen: boolean;
        updateRemoveAltGrid: (value: boolean) => void;
        calculateRowsAndColumns: CalculateRowsAndColumnsType;
        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>;
        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;
        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;
        [key: string]: any;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: any
    Index

    Properties

    socket coHostResponsibility roomName showAlert? coHost updateAddAltGrid otherGridStreams updateOtherGridStreams updateMiniCardsGrid allVideoStreams p_activeNames activeNames dispActiveNames shareScreenStarted shared newLimitedStreams non_alVideoStreams ref_participants participants eventType islevel member sortAudioLoudness audioDecibels mixed_alVideoStreams non_alVideoStreams_muted remoteProducerId? localStreamVideo oldAllStreams screenPageLimit meetingDisplayType meetingVideoOptimized recordingVideoOptimized recordingDisplayType paginatedStreams itemPageLimit doPaginate prevDoPaginate currentUserPage breakoutRooms hostNewRoom breakOutRoomStarted breakOutRoomEnded virtualStream mainRoomsLength memberRoom updateP_activeNames updateActiveNames updateDispActiveNames updateNewLimitedStreams updateNon_alVideoStreams updateRef_participants updateSortAudioLoudness updateMixed_alVideoStreams updateNon_alVideoStreams_muted updatePaginatedStreams updateDoPaginate updatePrevDoPaginate updateCurrentUserPage updateNumberPages updateMainRoomsLength updateMemberRoom mixStreams dispStreams getUpdatedAllParams prevActiveNames updatePrevActiveNames trigger consumerTransports streamNames audStreamNames hostLabel mainHeightWidth prevMainHeightWidth firstAll shareEnded updateMainWindow p_dispActiveNames nForReadjustRecord first_round lock_screen chatRefStreams keepBackground updateLStreams updateChatRefStreams updateNForReadjustRecord updateUpdateMainWindow updateShowMiniView prepopulateUserMedia rePort processConsumerTransports resumePauseStreams readjust addVideosGrid getEstimate checkGrid resumePauseAudioStreams fixedPageLimit removeAltGrid isMediumScreen updateRemoveAltGrid calculateRowsAndColumns 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? sleep recordStarted recordStopped recordPaused recordResumed screenStates prevScreenStates updateScreenStates updatePrevScreenStates compareActiveNames compareScreenStates allAudioStreams limitedBreakRoom updateLimitedBreakRoom processConsumerTransportsAudio 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
    allVideoStreams: (Stream | Participant)[]
    p_activeNames: string[]
    activeNames: string[]
    dispActiveNames: string[]
    shareScreenStarted: boolean
    shared: boolean
    newLimitedStreams: (Stream | Participant)[]
    non_alVideoStreams: Participant[]
    ref_participants: Participant[]
    participants: Participant[]

    Current participant roster.

    Session Context:

    eventType: EventType

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

    Helpers:

    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
    oldAllStreams: (Stream | Participant)[]
    screenPageLimit: number
    meetingDisplayType: string
    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
    virtualStream: MediaStream
    mainRoomsLength: number
    memberRoom: number
    updateP_activeNames: (names: string[]) => void
    updateActiveNames: (names: string[]) => void
    updateDispActiveNames: (names: string[]) => void
    updateNewLimitedStreams: (streams: (Stream | Participant)[]) => 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
    getUpdatedAllParams: () => ChangeVidsParameters

    Refreshes parameters before invoking side effects.

    prevActiveNames: string[]
    updatePrevActiveNames: (prevActiveNames: string[]) => void
    trigger: TriggerType
    consumerTransports: Transport[]
    streamNames: Stream[]
    audStreamNames: Stream[]
    hostLabel: string
    mainHeightWidth: number
    prevMainHeightWidth: number
    firstAll: boolean
    shareEnded: boolean
    updateMainWindow: boolean
    p_dispActiveNames: string[]
    nForReadjustRecord: number
    first_round: boolean
    lock_screen: boolean
    chatRefStreams: (Stream | Participant)[]
    keepBackground: boolean
    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
    fixedPageLimit: number
    removeAltGrid: boolean
    isMediumScreen: boolean
    updateRemoveAltGrid: (value: boolean) => void
    calculateRowsAndColumns: CalculateRowsAndColumnsType
    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>
    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
    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