Interface ChangeVidsParameters

Interface defining the parameters required by the AudioCard component.

These parameters provide the context and state needed for audio display, participant management, and media controls.

AudioCardParameters

interface ChangeVidsParameters {
    socket: Socket<DefaultEventsMap, DefaultEventsMap>;
    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<DefaultEventsMap, DefaultEventsMap>;
    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 full)

Indexable

  • [key: string]: any

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<DefaultEventsMap, DefaultEventsMap>

Socket.io client instance for real-time communication

coHostResponsibility

coHostResponsibility: CoHostResponsibility[]

Array of responsibilities assigned to co-hosts

roomName

roomName: string

Name/ID of the current room session

OptionalshowAlert

showAlert?: ShowAlert

Optional function to display alerts/notifications

coHost

coHost: string

User ID of the co-host

updateAddAltGrid

updateAddAltGrid: ((addAltGrid: boolean) => void)

otherGridStreams

otherGridStreams: Element[][]

updateOtherGridStreams

updateOtherGridStreams: ((otherGridStreams: Element[][]) => void)

updateMiniCardsGrid

updateMiniCardsGrid: UpdateMiniCardsGridType

allVideoStreams

allVideoStreams: (Stream | Participant)[]

p_activeNames

p_activeNames: string[]

activeNames

activeNames: string[]

dispActiveNames

dispActiveNames: string[]

shareScreenStarted

shareScreenStarted: boolean

shared

shared: boolean

newLimitedStreams

newLimitedStreams: (Stream | Participant)[]

non_alVideoStreams

non_alVideoStreams: Participant[]

ref_participants

ref_participants: Participant[]

participants

participants: Participant[]

Array of all participants in the session

eventType

eventType: EventType

Type of event ('conference', 'webinar', 'broadcast', etc.)

islevel

islevel: string

Current user's level/role (e.g., '0', '1', '2')

member

member: string

Current user's member ID

sortAudioLoudness

sortAudioLoudness: boolean

audioDecibels

audioDecibels: AudioDecibels[]

Array of audio level data for all participants (used for waveform visualization)

mixed_alVideoStreams

mixed_alVideoStreams: (Stream | Participant)[]

non_alVideoStreams_muted

non_alVideoStreams_muted: Participant[]

OptionalremoteProducerId

remoteProducerId?: string

localStreamVideo

localStreamVideo: MediaStream

oldAllStreams

oldAllStreams: (Stream | Participant)[]

screenPageLimit

screenPageLimit: number

meetingDisplayType

meetingDisplayType: string

meetingVideoOptimized

meetingVideoOptimized: boolean

recordingVideoOptimized

recordingVideoOptimized: boolean

recordingDisplayType

recordingDisplayType: "video" | "media" | "all"

paginatedStreams

paginatedStreams: (Stream | Participant)[][]

itemPageLimit

itemPageLimit: number

doPaginate

doPaginate: boolean

prevDoPaginate

prevDoPaginate: boolean

currentUserPage

currentUserPage: number

breakoutRooms

breakoutRooms: BreakoutParticipant[][]

hostNewRoom

hostNewRoom: number

breakOutRoomStarted

breakOutRoomStarted: boolean

breakOutRoomEnded

breakOutRoomEnded: boolean

virtualStream

virtualStream: MediaStream

mainRoomsLength

mainRoomsLength: number

memberRoom

memberRoom: number

updateP_activeNames

updateP_activeNames: ((names: string[]) => void)

updateActiveNames

updateActiveNames: ((names: string[]) => void)

updateDispActiveNames

updateDispActiveNames: ((names: string[]) => void)

updateNewLimitedStreams

updateNewLimitedStreams: ((streams: (Stream | Participant)[]) => void)

updateNon_alVideoStreams

updateNon_alVideoStreams: ((participants: Participant[]) => void)

updateRef_participants

updateRef_participants: ((participants: Participant[]) => void)

updateSortAudioLoudness

updateSortAudioLoudness: ((sort: boolean) => void)

updateMixed_alVideoStreams

updateMixed_alVideoStreams: ((streams: (Stream | Participant)[]) => void)

updateNon_alVideoStreams_muted

updateNon_alVideoStreams_muted: ((participants: Participant[]) => void)

updatePaginatedStreams

updatePaginatedStreams: ((streams: (Stream | Participant)[][]) => void)

updateDoPaginate

updateDoPaginate: ((paginate: boolean) => void)

updatePrevDoPaginate

updatePrevDoPaginate: ((paginate: boolean) => void)

updateCurrentUserPage

updateCurrentUserPage: ((page: number) => void)

updateNumberPages

updateNumberPages: ((pages: number) => void)

updateMainRoomsLength

updateMainRoomsLength: ((length: number) => void)

updateMemberRoom

updateMemberRoom: ((room: number) => void)

mixStreams

mixStreams: MixStreamsType

dispStreams

dispStreams: DispStreamsType

getUpdatedAllParams

getUpdatedAllParams: (() => ChangeVidsParameters)

Function to retrieve latest parameter state

prevActiveNames

prevActiveNames: string[]

updatePrevActiveNames

updatePrevActiveNames: ((prevActiveNames: string[]) => void)

trigger

trigger: TriggerType

consumerTransports

consumerTransports: Transport[]

streamNames

streamNames: Stream[]

audStreamNames

audStreamNames: Stream[]

hostLabel

hostLabel: string

mainHeightWidth

mainHeightWidth: number

prevMainHeightWidth

prevMainHeightWidth: number

firstAll

firstAll: boolean

shareEnded

shareEnded: boolean

updateMainWindow

updateMainWindow: boolean

p_dispActiveNames

p_dispActiveNames: string[]

nForReadjustRecord

nForReadjustRecord: number

first_round

first_round: boolean

lock_screen

lock_screen: boolean

chatRefStreams

chatRefStreams: (Stream | Participant)[]

keepBackground

keepBackground: boolean

updateLStreams

updateLStreams: ((streams: (Stream | Participant)[]) => void)

updateChatRefStreams

updateChatRefStreams: ((streams: (Stream | Participant)[]) => void)

updateNForReadjustRecord

updateNForReadjustRecord: ((n: number) => void)

updateUpdateMainWindow

updateUpdateMainWindow: ((value: boolean) => void)

updateShowMiniView

updateShowMiniView: ((value: boolean) => void)

prepopulateUserMedia

prepopulateUserMedia: PrepopulateUserMediaType

rePort

rePort: RePortType

processConsumerTransports

processConsumerTransports: ProcessConsumerTransportsType

resumePauseStreams

resumePauseStreams: ResumePauseStreamsType

readjust

readjust: ReadjustType

addVideosGrid

addVideosGrid: AddVideosGridType

getEstimate

getEstimate: GetEstimateType

checkGrid

checkGrid: CheckGridType

resumePauseAudioStreams

resumePauseAudioStreams: ResumePauseAudioStreamsType

fixedPageLimit

fixedPageLimit: number

removeAltGrid

removeAltGrid: boolean

isMediumScreen

isMediumScreen: boolean

updateRemoveAltGrid

updateRemoveAltGrid: ((value: boolean) => void)

calculateRowsAndColumns

calculateRowsAndColumns: CalculateRowsAndColumnsType

OptionalscreenId

screenId?: string

forceFullDisplay

forceFullDisplay: boolean

mainScreenFilled

mainScreenFilled: boolean

adminOnMainScreen

adminOnMainScreen: boolean

mainScreenPerson

mainScreenPerson: string

videoAlreadyOn

videoAlreadyOn: boolean

audioAlreadyOn

audioAlreadyOn: boolean

checkOrientation

checkOrientation: (() => string)

screenForceFullDisplay

screenForceFullDisplay: boolean

localStreamScreen

localStreamScreen: MediaStream

remoteScreenStream

remoteScreenStream: Stream[]

isWideScreen

isWideScreen: boolean

localUIMode

localUIMode: boolean

whiteboardStarted

whiteboardStarted: boolean

whiteboardEnded

whiteboardEnded: boolean

annotateScreenStream

annotateScreenStream: boolean

updateMainScreenPerson

updateMainScreenPerson: ((person: string) => void)

updateMainScreenFilled

updateMainScreenFilled: ((filled: boolean) => void)

updateAdminOnMainScreen

updateAdminOnMainScreen: ((admin: boolean) => void)

updateMainHeightWidth

updateMainHeightWidth: ((heightWidth: number) => void)

updateScreenForceFullDisplay

updateScreenForceFullDisplay: ((force: boolean) => void)

updateMainGridStream

updateMainGridStream: ((components: Element[]) => void)

OptionalcustomVideoCard

customVideoCard?: CustomVideoCardType

OptionalcustomAudioCard

customAudioCard?: CustomAudioCardType

OptionalcustomMiniCard

customMiniCard?: CustomMiniCardType

OptionalvideoCardComponent

videoCardComponent?: ComponentType<VideoCardOptions>

OptionalaudioCardComponent

audioCardComponent?: ComponentType<AudioCardOptions>

OptionalminiCardComponent

miniCardComponent?: ComponentType<MiniCardOptions>

sleep

sleep: SleepType

recordStarted

recordStarted: boolean

recordStopped

recordStopped: boolean

recordPaused

recordPaused: boolean

recordResumed

recordResumed: boolean

screenStates

screenStates: ScreenState[]

prevScreenStates

prevScreenStates: ScreenState[]

updateScreenStates

updateScreenStates: ((states: ScreenState[]) => void)

updatePrevScreenStates

updatePrevScreenStates: ((states: ScreenState[]) => void)

compareActiveNames

compareActiveNames: CompareActiveNamesType

compareScreenStates

compareScreenStates: CompareScreenStatesType

allAudioStreams

allAudioStreams: (Stream | Participant)[]

limitedBreakRoom

limitedBreakRoom: BreakoutParticipant[]

updateLimitedBreakRoom

updateLimitedBreakRoom: ((limitedBreakRoom: BreakoutParticipant[]) => void)

processConsumerTransportsAudio

processConsumerTransportsAudio: ProcessConsumerTransportsAudioType

OptionallocalSocket

localSocket?: Socket<DefaultEventsMap, DefaultEventsMap>

OptionalupdateDateState

updateDateState?: number

lastUpdate

lastUpdate: number

nForReadjust

nForReadjust: number

updateUpdateDateState

updateUpdateDateState: ((timestamp: number) => void)

updateLastUpdate

updateLastUpdate: ((lastUpdate: number) => void)

updateNForReadjust

updateNForReadjust: ((nForReadjust: number) => void)

autoAdjust

autoAdjust: AutoAdjustType

updateGridRows

updateGridRows: ((rows: number) => void)

updateGridCols

updateGridCols: ((cols: number) => void)

updateAltGridRows

updateAltGridRows: ((rows: number) => void)

updateAltGridCols

updateAltGridCols: ((cols: number) => void)

updateGridSizes

updateGridSizes: ((gridSizes: GridSizes) => void)

gridSizes

gridSizes: GridSizes

paginationDirection

paginationDirection: string

paginationHeightWidth

paginationHeightWidth: number

componentSizes

componentSizes: ComponentSizes

Settings

Member Visibility

On This Page

Properties
socketcoHostResponsibilityroomNameshowAlertcoHostupdateAddAltGridotherGridStreamsupdateOtherGridStreamsupdateMiniCardsGridallVideoStreamsp_activeNamesactiveNamesdispActiveNamesshareScreenStartedsharednewLimitedStreamsnon_alVideoStreamsref_participantsparticipantseventTypeislevelmembersortAudioLoudnessaudioDecibelsmixed_alVideoStreamsnon_alVideoStreams_mutedremoteProducerIdlocalStreamVideooldAllStreamsscreenPageLimitmeetingDisplayTypemeetingVideoOptimizedrecordingVideoOptimizedrecordingDisplayTypepaginatedStreamsitemPageLimitdoPaginateprevDoPaginatecurrentUserPagebreakoutRoomshostNewRoombreakOutRoomStartedbreakOutRoomEndedvirtualStreammainRoomsLengthmemberRoomupdateP_activeNamesupdateActiveNamesupdateDispActiveNamesupdateNewLimitedStreamsupdateNon_alVideoStreamsupdateRef_participantsupdateSortAudioLoudnessupdateMixed_alVideoStreamsupdateNon_alVideoStreams_mutedupdatePaginatedStreamsupdateDoPaginateupdatePrevDoPaginateupdateCurrentUserPageupdateNumberPagesupdateMainRoomsLengthupdateMemberRoommixStreamsdispStreamsgetUpdatedAllParamsprevActiveNamesupdatePrevActiveNamestriggerconsumerTransportsstreamNamesaudStreamNameshostLabelmainHeightWidthprevMainHeightWidthfirstAllshareEndedupdateMainWindowp_dispActiveNamesnForReadjustRecordfirst_roundlock_screenchatRefStreamskeepBackgroundupdateLStreamsupdateChatRefStreamsupdateNForReadjustRecordupdateUpdateMainWindowupdateShowMiniViewprepopulateUserMediarePortprocessConsumerTransportsresumePauseStreamsreadjustaddVideosGridgetEstimatecheckGridresumePauseAudioStreamsfixedPageLimitremoveAltGridisMediumScreenupdateRemoveAltGridcalculateRowsAndColumnsscreenIdforceFullDisplaymainScreenFilledadminOnMainScreenmainScreenPersonvideoAlreadyOnaudioAlreadyOncheckOrientationscreenForceFullDisplaylocalStreamScreenremoteScreenStreamisWideScreenlocalUIModewhiteboardStartedwhiteboardEndedannotateScreenStreamupdateMainScreenPersonupdateMainScreenFilledupdateAdminOnMainScreenupdateMainHeightWidthupdateScreenForceFullDisplayupdateMainGridStreamcustomVideoCardcustomAudioCardcustomMiniCardvideoCardComponentaudioCardComponentminiCardComponentsleeprecordStartedrecordStoppedrecordPausedrecordResumedscreenStatesprevScreenStatesupdateScreenStatesupdatePrevScreenStatescompareActiveNamescompareScreenStatesallAudioStreamslimitedBreakRoomupdateLimitedBreakRoomprocessConsumerTransportsAudiolocalSocketupdateDateStatelastUpdatenForReadjustupdateUpdateDateStateupdateLastUpdateupdateNForReadjustautoAdjustupdateGridRowsupdateGridColsupdateAltGridRowsupdateAltGridColsupdateGridSizesgridSizespaginationDirectionpaginationHeightWidthcomponentSizes