Interface AllMembersParameters

Handles participant management and UI updates for all members.

Param: params

The parameters for the allMembers method.

Param: params.members

The array of participant members.

Param: params.requestss

The array of requests.

Param: params.coHoste

The co-host identifier.

Param: params.coHostRes

The co-host responsibilities.

Param: params.parameters

The parameters object for allMembers handling.

Param: params.consume_sockets

The array of consume sockets.

Param: params.apiUserName

The API username.

Param: params.apiKey

The API key.

Param: params.apiToken

The API token.

Returns

A promise that resolves when all participant management actions are completed.

Example

await allMembers({
  members: participantList,
  requestss: requestList,
  coHoste: 'coHostName',
  coHostRes: [{ type: 'moderate', allowed: true }],
  parameters: allMembersParams,
  consume_sockets: [socket1, socket2],
  apiUserName: 'userAPI',
  apiKey: 'apiKey123',
  apiToken: 'tokenXYZ'
});

interface AllMembersParameters {
    roomName: string;
    showAlert?: ShowAlert;
    updateAddAltGrid: ((addAltGrid: boolean) => void);
    otherGridStreams: Element[][];
    updateOtherGridStreams: ((otherGridStreams: Element[][]) => void);
    updateMiniCardsGrid: UpdateMiniCardsGridType;
    p_activeNames: string[];
    activeNames: string[];
    shared: boolean;
    non_alVideoStreams: Participant[];
    ref_participants: Participant[];
    eventType: EventType;
    member: string;
    sortAudioLoudness: boolean;
    audioDecibels: AudioDecibels[];
    mixed_alVideoStreams: (Stream | Participant)[];
    non_alVideoStreams_muted: Participant[];
    remoteProducerId?: string;
    localStreamVideo: MediaStream;
    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;
    virtualStream: MediaStream;
    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;
    updateShareEnded: ((shareEnded: boolean) => void);
    updateFirst_round: ((first_round: boolean) => void);
    getVideos: GetVideosType;
    prevActiveNames: string[];
    updatePrevActiveNames: ((prevActiveNames: string[]) => void);
    trigger: TriggerType;
    device: Device;
    updateConsumerTransports: ((transports: Transport[]) => void);
    consumerResume: ConsumerResumeType;
    nStream: MediaStream;
    audioOnlyStreams: Element[];
    gotAllVids: boolean;
    defer_receive: boolean;
    miniAudioComponent?: ComponentType<MiniAudioOptions>;
    miniAudioPlayerComponent?: ComponentType<MiniAudioPlayerOptions>;
    updateAllAudioStreams: ((value: (Stream | Participant)[]) => void);
    updateAllVideoStreams: ((value: (Stream | Participant)[]) => void);
    updateStreamNames: ((value: Stream[]) => void);
    updateAudStreamNames: ((value: Stream[]) => void);
    updateNStream: ((value: MediaStream) => void);
    updateLock_screen: ((value: boolean) => void);
    updateRemoteScreenStream: ((value: Stream[]) => void);
    updateOldAllStreams: ((value: (Stream | Participant)[]) => void);
    updateAudioOnlyStreams: ((value: Element[]) => void);
    updateGotAllVids: ((value: boolean) => void);
    updateScreenId: ((value: string) => void);
    updateDefer_receive: ((value: boolean) => void);
    consumerTransports: Transport[];
    streamNames: Stream[];
    audStreamNames: Stream[];
    hostLabel: string;
    mainHeightWidth: number;
    prevMainHeightWidth: number;
    shareEnded: boolean;
    updateMainWindow: boolean;
    p_dispActiveNames: string[];
    nForReadjustRecord: number;
    first_round: 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;
    signalNewConsumerTransport: SignalNewConsumerTransportType;
    addForBasic: boolean;
    updateAddForBasic: ((value: boolean) => void);
    updateItemPageLimit: ((value: number) => void);
    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>;
    recordStarted: boolean;
    recordStopped: boolean;
    recordPaused: boolean;
    recordResumed: boolean;
    screenStates: ScreenState[];
    prevScreenStates: ScreenState[];
    updateScreenStates: ((states: ScreenState[]) => void);
    updatePrevScreenStates: ((states: ScreenState[]) => void);
    compareActiveNames: CompareActiveNamesType;
    compareScreenStates: CompareScreenStatesType;
    reorderInterval: number;
    fastReorderInterval: number;
    lastReorderTime: number;
    oldSoundIds: string[];
    updateLastReorderTime: ((value: number) => void);
    updateOldSoundIds: ((ids: string[]) => void);
    getPipedProducersAlt: GetPipedProducersAltType;
    allVideoStreams: (Stream | Participant)[];
    oldAllStreams: (Stream | Participant)[];
    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;
    consumingTransports: string[];
    updateConsumingTransports: ((transports: string[]) => void);
    connectRecvTransport: ConnectRecvTransportType;
    updateDevice: ((device: Device) => void);
    receiveAllPipedTransports: ReceiveAllPipedTransportsType;
    createDeviceClient: CreateDeviceClientType;
    landScaped: boolean;
    updateLandScaped: ((landScaped: boolean) => void);
    closeAndResize: CloseAndResizeType;
    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;
    reUpdateInter: ReUpdateInterType;
    updateParticipantAudioDecibels: UpdateParticipantAudioDecibelsType;
    participantsAll: Participant[];
    participants: Participant[];
    dispActiveNames: string[];
    requestList: Request[];
    coHost: string;
    coHostResponsibility: CoHostResponsibility[];
    lock_screen: boolean;
    firstAll: boolean;
    membersReceived: boolean;
    roomRecvIPs: string[];
    deferScreenReceived: boolean;
    screenId?: string;
    shareScreenStarted: boolean;
    meetingDisplayType: string;
    hostFirstSwitch: boolean;
    waitingRoomList: WaitingRoomParticipant[];
    islevel: string;
    socket: Socket<DefaultEventsMap, DefaultEventsMap>;
    updateParticipantsAll: ((participantsAll: Participant[]) => void);
    updateParticipants: ((participants: Participant[]) => void);
    updateRequestList: ((requestList: Request[]) => void);
    updateCoHost: ((coHost: string) => void);
    updateCoHostResponsibility: ((coHostRes: CoHostResponsibility[]) => void);
    updateFirstAll: ((firstAll: boolean) => void);
    updateMembersReceived: ((membersReceived: boolean) => void);
    updateDeferScreenReceived: ((deferScreenReceived: boolean) => void);
    updateShareScreenStarted: ((shareScreenStarted: boolean) => void);
    updateHostFirstSwitch: ((hostFirstSwitch: boolean) => void);
    updateConsume_sockets: ((sockets: ConsumeSocket[]) => void);
    updateRoomRecvIPs: ((ips: string[]) => void);
    updateIsLoadingModalVisible: ((visible: boolean) => void);
    updateTotalReqWait: ((total: number) => void);
    onScreenChanges: OnScreenChangesType;
    connectIps: ConnectIpsType;
    connectLocalIps?: ConnectLocalIpsType;
    sleep: SleepType;
    reorderStreams: ReorderStreamsType;
    getUpdatedAllParams: (() => AllMembersParameters);
    [key: string]: any;
}

Hierarchy (view full)

ReorderStreamsParameters
ConnectIpsParameters
OnScreenChangesParameters
ConnectLocalIpsParameters
- AllMembersParameters

Indexable

[key: string]: any

Index

Properties

roomName showAlert? updateAddAltGrid otherGridStreams updateOtherGridStreams updateMiniCardsGrid p_activeNames activeNames shared non_alVideoStreams ref_participants eventType member sortAudioLoudness audioDecibels mixed_alVideoStreams non_alVideoStreams_muted remoteProducerId? localStreamVideo screenPageLimit meetingVideoOptimized recordingVideoOptimized recordingDisplayType paginatedStreams itemPageLimit doPaginate prevDoPaginate currentUserPage breakoutRooms hostNewRoom breakOutRoomStarted breakOutRoomEnded virtualStream 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 updateShareEnded updateFirst_round getVideos prevActiveNames updatePrevActiveNames trigger device updateConsumerTransports consumerResume nStream audioOnlyStreams gotAllVids defer_receive miniAudioComponent? miniAudioPlayerComponent? updateAllAudioStreams updateAllVideoStreams updateStreamNames updateAudStreamNames updateNStream updateLock_screen updateRemoteScreenStream updateOldAllStreams updateAudioOnlyStreams updateGotAllVids updateScreenId updateDefer_receive consumerTransports streamNames audStreamNames hostLabel mainHeightWidth prevMainHeightWidth shareEnded updateMainWindow p_dispActiveNames nForReadjustRecord first_round chatRefStreams keepBackground updateLStreams updateChatRefStreams updateNForReadjustRecord updateUpdateMainWindow updateShowMiniView prepopulateUserMedia rePort processConsumerTransports resumePauseStreams readjust addVideosGrid getEstimate checkGrid resumePauseAudioStreams fixedPageLimit removeAltGrid isMediumScreen updateRemoveAltGrid calculateRowsAndColumns signalNewConsumerTransport addForBasic updateAddForBasic updateItemPageLimit 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? recordStarted recordStopped recordPaused recordResumed screenStates prevScreenStates updateScreenStates updatePrevScreenStates compareActiveNames compareScreenStates reorderInterval fastReorderInterval lastReorderTime oldSoundIds updateLastReorderTime updateOldSoundIds getPipedProducersAlt allVideoStreams oldAllStreams adminVidID? newLimitedStreams newLimitedStreamsIDs activeSounds screenShareIDStream? screenShareNameStream? adminIDStream? adminNameStream? updateNewLimitedStreams updateNewLimitedStreamsIDs updateActiveSounds updateScreenShareIDStream updateScreenShareNameStream updateAdminIDStream updateAdminNameStream updateYouYouStream changeVids allAudioStreams limitedBreakRoom updateLimitedBreakRoom processConsumerTransportsAudio consumingTransports updateConsumingTransports connectRecvTransport updateDevice receiveAllPipedTransports createDeviceClient landScaped updateLandScaped closeAndResize localSocket? updateDateState? lastUpdate nForReadjust updateUpdateDateState updateLastUpdate updateNForReadjust autoAdjust updateGridRows updateGridCols updateAltGridRows updateAltGridCols updateGridSizes gridSizes paginationDirection paginationHeightWidth componentSizes reUpdateInter updateParticipantAudioDecibels participantsAll participants dispActiveNames requestList coHost coHostResponsibility lock_screen firstAll membersReceived roomRecvIPs deferScreenReceived screenId? shareScreenStarted meetingDisplayType hostFirstSwitch waitingRoomList islevel socket updateParticipantsAll updateParticipants updateRequestList updateCoHost updateCoHostResponsibility updateFirstAll updateMembersReceived updateDeferScreenReceived updateShareScreenStarted updateHostFirstSwitch updateConsume_sockets updateRoomRecvIPs updateIsLoadingModalVisible updateTotalReqWait onScreenChanges connectIps connectLocalIps? sleep reorderStreams getUpdatedAllParams

Properties

roomName

roomName: string

Name/ID of the current room session

`Optional`showAlert

showAlert?: ShowAlert

Optional function to display alerts/notifications

updateAddAltGrid

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

otherGridStreams

otherGridStreams: Element[][]

updateOtherGridStreams

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

updateMiniCardsGrid

updateMiniCardsGrid: UpdateMiniCardsGridType

p_activeNames

p_activeNames: string[]

activeNames

activeNames: string[]

shared

shared: boolean

non_alVideoStreams

non_alVideoStreams: Participant[]

ref_participants

ref_participants: Participant[]

eventType

eventType: EventType

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

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[]

`Optional`remoteProducerId

remoteProducerId?: string

localStreamVideo

localStreamVideo: MediaStream

screenPageLimit

screenPageLimit: number

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)

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

updateShareEnded

updateShareEnded: ((shareEnded: boolean) => void)

updateFirst_round

updateFirst_round: ((first_round: boolean) => void)

getVideos

getVideos: GetVideosType

prevActiveNames

prevActiveNames: string[]

updatePrevActiveNames

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

trigger

trigger: TriggerType

device

device: Device

updateConsumerTransports

updateConsumerTransports: ((transports: Transport[]) => void)

consumerResume

consumerResume: ConsumerResumeType

nStream

nStream: MediaStream

audioOnlyStreams

audioOnlyStreams: Element[]

gotAllVids

gotAllVids: boolean

defer_receive

defer_receive: boolean

`Optional`miniAudioComponent

miniAudioComponent?: ComponentType<MiniAudioOptions>

`Optional`miniAudioPlayerComponent

miniAudioPlayerComponent?: ComponentType<MiniAudioPlayerOptions>

updateAllAudioStreams

updateAllAudioStreams: ((value: (Stream | Participant)[]) => void)

updateAllVideoStreams

updateAllVideoStreams: ((value: (Stream | Participant)[]) => void)

updateStreamNames

updateStreamNames: ((value: Stream[]) => void)

updateAudStreamNames

updateAudStreamNames: ((value: Stream[]) => void)

updateNStream

updateNStream: ((value: MediaStream) => void)

updateLock_screen

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

updateRemoteScreenStream

updateRemoteScreenStream: ((value: Stream[]) => void)

updateOldAllStreams

updateOldAllStreams: ((value: (Stream | Participant)[]) => void)

updateAudioOnlyStreams

updateAudioOnlyStreams: ((value: Element[]) => void)

updateGotAllVids

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

updateScreenId

updateScreenId: ((value: string) => void)

updateDefer_receive

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

consumerTransports

consumerTransports: Transport[]

streamNames

streamNames: Stream[]

audStreamNames

audStreamNames: Stream[]

hostLabel

hostLabel: string

mainHeightWidth

mainHeightWidth: number

prevMainHeightWidth

prevMainHeightWidth: number

shareEnded

shareEnded: boolean

updateMainWindow

updateMainWindow: boolean

p_dispActiveNames

p_dispActiveNames: string[]

nForReadjustRecord

nForReadjustRecord: number

first_round

first_round: 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)

fixedPageLimit

fixedPageLimit: number

removeAltGrid

removeAltGrid: boolean

isMediumScreen

isMediumScreen: boolean

updateRemoveAltGrid

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

calculateRowsAndColumns

calculateRowsAndColumns: CalculateRowsAndColumnsType

signalNewConsumerTransport

signalNewConsumerTransport: SignalNewConsumerTransportType

addForBasic

addForBasic: boolean

updateAddForBasic

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

updateItemPageLimit

updateItemPageLimit: ((value: number) => void)

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)

`Optional`customVideoCard

customVideoCard?: CustomVideoCardType

`Optional`customAudioCard

customAudioCard?: CustomAudioCardType

`Optional`customMiniCard

customMiniCard?: CustomMiniCardType

`Optional`videoCardComponent

videoCardComponent?: ComponentType<VideoCardOptions>

`Optional`audioCardComponent

audioCardComponent?: ComponentType<AudioCardOptions>

`Optional`miniCardComponent

miniCardComponent?: ComponentType<MiniCardOptions>

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

reorderInterval

reorderInterval: number

fastReorderInterval

fastReorderInterval: number

lastReorderTime

lastReorderTime: number

oldSoundIds

oldSoundIds: string[]

updateLastReorderTime

updateLastReorderTime: ((value: number) => void)

updateOldSoundIds

updateOldSoundIds: ((ids: string[]) => void)

getPipedProducersAlt

getPipedProducersAlt: GetPipedProducersAltType

allVideoStreams

allVideoStreams: (Stream | Participant)[]

oldAllStreams

oldAllStreams: (Stream | Participant)[]

`Optional`adminVidID

adminVidID?: string

newLimitedStreams

newLimitedStreams: (Stream | Participant)[]

newLimitedStreamsIDs

newLimitedStreamsIDs: string[]

activeSounds

activeSounds: string[]

`Optional`screenShareIDStream

screenShareIDStream?: string

`Optional`screenShareNameStream

screenShareNameStream?: string

`Optional`adminIDStream

adminIDStream?: string

`Optional`adminNameStream

adminNameStream?: string

updateNewLimitedStreams

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

updateNewLimitedStreamsIDs

updateNewLimitedStreamsIDs: ((ids: string[]) => void)

updateActiveSounds

updateActiveSounds: ((sounds: string[]) => void)

updateScreenShareIDStream

updateScreenShareIDStream: ((id: string) => void)

updateScreenShareNameStream

updateScreenShareNameStream: ((name: string) => void)

updateAdminIDStream

updateAdminIDStream: ((id: string) => void)

updateAdminNameStream

updateAdminNameStream: ((name: string) => void)

updateYouYouStream

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

changeVids

changeVids: ChangeVidsType

allAudioStreams

allAudioStreams: (Stream | Participant)[]

limitedBreakRoom

limitedBreakRoom: BreakoutParticipant[]

updateLimitedBreakRoom

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

processConsumerTransportsAudio

processConsumerTransportsAudio: ProcessConsumerTransportsAudioType

consumingTransports

consumingTransports: string[]

updateConsumingTransports

updateConsumingTransports: ((transports: string[]) => void)

connectRecvTransport

connectRecvTransport: ConnectRecvTransportType

updateDevice

updateDevice: ((device: Device) => void)

receiveAllPipedTransports

receiveAllPipedTransports: ReceiveAllPipedTransportsType

createDeviceClient

createDeviceClient: CreateDeviceClientType

landScaped

landScaped: boolean

updateLandScaped

updateLandScaped: ((landScaped: boolean) => void)

closeAndResize

closeAndResize: CloseAndResizeType

`Optional`localSocket

localSocket?: Socket<DefaultEventsMap, DefaultEventsMap>

`Optional`updateDateState

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

reUpdateInter

reUpdateInter: ReUpdateInterType

updateParticipantAudioDecibels

updateParticipantAudioDecibels: UpdateParticipantAudioDecibelsType

participantsAll

participantsAll: Participant[]

participants

participants: Participant[]

Array of all participants in the session

dispActiveNames

dispActiveNames: string[]

requestList

requestList: Request[]

coHost

coHost: string

User ID of the co-host

coHostResponsibility

coHostResponsibility: CoHostResponsibility[]

Array of responsibilities assigned to co-hosts

lock_screen

lock_screen: boolean

firstAll

firstAll: boolean

membersReceived

membersReceived: boolean

roomRecvIPs

roomRecvIPs: string[]

deferScreenReceived

deferScreenReceived: boolean

`Optional`screenId

screenId?: string

shareScreenStarted

shareScreenStarted: boolean

meetingDisplayType

meetingDisplayType: string

hostFirstSwitch

hostFirstSwitch: boolean

waitingRoomList

waitingRoomList: WaitingRoomParticipant[]

islevel

islevel: string

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

socket

socket: Socket<DefaultEventsMap, DefaultEventsMap>

Socket.io client instance for real-time communication

updateParticipantsAll

updateParticipantsAll: ((participantsAll: Participant[]) => void)

updateParticipants

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

updateRequestList

updateRequestList: ((requestList: Request[]) => void)

updateCoHost

updateCoHost: ((coHost: string) => void)

updateCoHostResponsibility

updateCoHostResponsibility: ((coHostRes: CoHostResponsibility[]) => void)

updateFirstAll

updateFirstAll: ((firstAll: boolean) => void)

updateMembersReceived

updateMembersReceived: ((membersReceived: boolean) => void)

updateDeferScreenReceived

updateDeferScreenReceived: ((deferScreenReceived: boolean) => void)

updateShareScreenStarted

updateShareScreenStarted: ((shareScreenStarted: boolean) => void)

updateHostFirstSwitch

updateHostFirstSwitch: ((hostFirstSwitch: boolean) => void)

updateConsume_sockets

updateConsume_sockets: ((sockets: ConsumeSocket[]) => void)

updateRoomRecvIPs

updateRoomRecvIPs: ((ips: string[]) => void)

updateIsLoadingModalVisible

updateIsLoadingModalVisible: ((visible: boolean) => void)

updateTotalReqWait

updateTotalReqWait: ((total: number) => void)

onScreenChanges

onScreenChanges: OnScreenChangesType

connectIps

connectIps: ConnectIpsType

`Optional`connectLocalIps

connectLocalIps?: ConnectLocalIpsType

sleep

sleep: SleepType

reorderStreams

reorderStreams: ReorderStreamsType

getUpdatedAllParams

getUpdatedAllParams: (() => AllMembersParameters)

Function to retrieve latest parameter state

Interface AllMembersParameters

Param: params

Param: params.members

Param: params.requestss

Param: params.coHoste

Param: params.coHostRes

Param: params.parameters

Param: params.consume_sockets

Param: params.apiUserName

Param: params.apiKey

Param: params.apiToken

Returns

Example

Hierarchy (view full)

Indexable

Index

Properties

Properties

roomName

OptionalshowAlert

updateAddAltGrid

otherGridStreams

updateOtherGridStreams

updateMiniCardsGrid

p_activeNames

activeNames

shared

non_alVideoStreams

ref_participants

eventType

member

sortAudioLoudness

audioDecibels

mixed_alVideoStreams

non_alVideoStreams_muted

OptionalremoteProducerId

localStreamVideo

screenPageLimit

meetingVideoOptimized

recordingVideoOptimized

recordingDisplayType

paginatedStreams

itemPageLimit

doPaginate

prevDoPaginate

currentUserPage

breakoutRooms

hostNewRoom

breakOutRoomStarted

breakOutRoomEnded

virtualStream

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

updateShareEnded

updateFirst_round

getVideos

prevActiveNames

updatePrevActiveNames

trigger

device

updateConsumerTransports

consumerResume

nStream

`Optional`showAlert

`Optional`remoteProducerId

`Optional`miniAudioComponent

`Optional`miniAudioPlayerComponent