Interface SwitchUserVideoAltParameters

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 SwitchUserVideoAltParameters {
    coHostResponsibility: CoHostResponsibility[];
    roomName: string;
    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[];
    eventType: EventType;
    sortAudioLoudness: boolean;
    audioDecibels: AudioDecibels[];
    mixed_alVideoStreams: (Stream | Participant)[];
    non_alVideoStreams_muted: Participant[];
    remoteProducerId?: string;
    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);
    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;
    audioParams: ProducerOptions;
    localStreamScreen: MediaStream;
    canvasStream: MediaStream;
    whiteboardStarted: boolean;
    whiteboardEnded: boolean;
    connectSendTransportAudio: ConnectSendTransportAudioType;
    connectSendTransportScreen: ConnectSendTransportScreenType;
    audioProducer: Producer<AppData>;
    localAudioProducer?: Producer<AppData>;
    updateAudioProducer: ((producer: Producer<AppData>) => void);
    updateLocalAudioProducer?: ((localProducer: Producer<AppData>) => void);
    updateAudioLevel: ((level: number) => void);
    screenProducer: Producer<AppData>;
    localScreenProducer?: Producer<AppData>;
    screenParams: ProducerOptions;
    updateScreenProducer: ((producer: Producer<AppData>) => void);
    updateLocalScreenProducer?: ((localProducer: Producer<AppData>) => void);
    localVideoProducer?: Producer<AppData>;
    updateVideoProducer: ((producer: Producer<AppData>) => void);
    updateLocalVideoProducer?: ((localProducer: Producer<AppData>) => void);
    localSocket?: Socket<DefaultEventsMap, DefaultEventsMap>;
    producerTransport: Transport<AppData>;
    localProducerTransport?: Transport<AppData>;
    localTransportCreated?: boolean;
    updateProducerTransport: ((producerTransport: Transport<AppData>) => void);
    updateLocalProducerTransport?: ((localTransport: Transport<AppData>) => void);
    updateTransportCreated: ((transportCreated: boolean) => void);
    updateLocalTransportCreated?: ((localTransportCreated: boolean) => void);
    connectSendTransport: ConnectSendTransportType;
    consumerTransports: Transport[];
    streamNames: Stream[];
    audStreamNames: Stream[];
    hostLabel: string;
    mainHeightWidth: number;
    prevMainHeightWidth: number;
    firstAll: boolean;
    shareEnded: boolean;
    p_dispActiveNames: string[];
    nForReadjustRecord: number;
    first_round: boolean;
    chatRefStreams: (Stream | Participant)[];
    updateLStreams: ((streams: (Stream | Participant)[]) => void);
    updateChatRefStreams: ((streams: (Stream | Participant)[]) => void);
    updateNForReadjustRecord: ((n: number) => 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;
    forceFullDisplay: boolean;
    mainScreenFilled: boolean;
    adminOnMainScreen: boolean;
    mainScreenPerson: string;
    audioAlreadyOn: boolean;
    checkOrientation: (() => string);
    screenForceFullDisplay: boolean;
    remoteScreenStream: Stream[];
    isWideScreen: boolean;
    localUIMode: 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;
    allVideoStreams: (Stream | Participant)[];
    oldAllStreams: (Stream | Participant)[];
    screenId?: string;
    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;
    socket: Socket<DefaultEventsMap, DefaultEventsMap>;
    participants: Participant[];
    localStream: MediaStream;
    transportCreated: boolean;
    transportCreatedVideo: boolean;
    videoAlreadyOn: boolean;
    videoAction: boolean;
    videoParams: ProducerOptions;
    localStreamVideo: MediaStream;
    defVideoID: string;
    userDefaultVideoInputDevice: string;
    params: ProducerOptions;
    videoParamse?: ProducerOptions;
    islevel: string;
    member: string;
    updateMainWindow: boolean;
    lock_screen: boolean;
    shared: boolean;
    shareScreenStarted: boolean;
    vParams: VParamsType;
    hParams: HParamsType;
    allowed: boolean;
    currentFacingMode: string;
    device: Device;
    keepBackground: boolean;
    appliedBackground: boolean;
    videoProducer: Producer<AppData>;
    updateTransportCreatedVideo: ((created: boolean) => void);
    updateVideoAlreadyOn: ((videoOn: boolean) => void);
    updateVideoAction: ((videoAction: boolean) => void);
    updateLocalStream: ((stream: MediaStream) => void);
    updateLocalStreamVideo: ((stream: MediaStream) => void);
    updateUserDefaultVideoInputDevice: ((device: string) => void);
    updateDefVideoID: ((id: string) => void);
    updateAllowed: ((allowed: boolean) => void);
    updateUpdateMainWindow: ((updateMainWindow: boolean) => void);
    updateParticipants: ((participants: Participant[]) => void);
    updateVideoParams: ((params: ProducerOptions) => void);
    updateIsBackgroundModalVisible: ((isVisible: boolean) => void);
    updateAutoClickBackground: ((autoClick: boolean) => void);
    createSendTransport: CreateSendTransportType;
    connectSendTransportVideo: ConnectSendTransportVideoType;
    reorderStreams: ReorderStreamsType;
    audioOnlyRoom: boolean;
    frameRate: number;
    vidCons: VidCons;
    showAlert?: ShowAlert;
    mediaDevices: {
        getUserMedia: ((constraints: MediaStreamConstraints) => Promise<MediaStream>);
        getDisplayMedia: ((constraints: MediaStreamConstraints) => Promise<MediaStream>);
        enumerateDevices: (() => Promise<MediaDeviceInfo[]>);
    };
    hasCameraPermission: boolean;
    updateVideoSwitching: ((state: boolean) => void);
    updateCurrentFacingMode: ((mode: string) => void);
    requestPermissionCamera: RequestPermissionCameraType;
    streamSuccessVideo: StreamSuccessVideoType;
    sleep: SleepType;
    checkMediaPermission: boolean;
    getUpdatedAllParams: (() => SwitchUserVideoAltParameters);
    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;
    recordingMediaOptions: string;
    youAreCoHost: boolean;
    adminRestrictSetting: boolean;
    videoRequestState: string;
    videoRequestTime: number;
    audioSetting: string;
    videoSetting: string;
    screenshareSetting: string;
    chatSetting: string;
    updateRequestIntervalSeconds: number;
    updateVideoRequestState: ((state: string) => void);
    disconnectSendTransportVideo: DisconnectSendTransportVideoType;
    checkPermission: CheckPermissionType;
    [key: string]: any;
}

Hierarchy (view full)

Indexable

  • [key: string]: any

Properties

coHostResponsibility roomName coHost updateAddAltGrid otherGridStreams updateOtherGridStreams updateMiniCardsGrid p_activeNames activeNames dispActiveNames non_alVideoStreams ref_participants eventType sortAudioLoudness audioDecibels mixed_alVideoStreams non_alVideoStreams_muted remoteProducerId? screenPageLimit meetingDisplayType 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 prevActiveNames updatePrevActiveNames trigger audioParams localStreamScreen canvasStream whiteboardStarted whiteboardEnded connectSendTransportAudio connectSendTransportScreen audioProducer localAudioProducer? updateAudioProducer updateLocalAudioProducer? updateAudioLevel screenProducer localScreenProducer? screenParams updateScreenProducer updateLocalScreenProducer? localVideoProducer? updateVideoProducer updateLocalVideoProducer? localSocket? producerTransport localProducerTransport? localTransportCreated? updateProducerTransport updateLocalProducerTransport? updateTransportCreated updateLocalTransportCreated? connectSendTransport consumerTransports streamNames audStreamNames hostLabel mainHeightWidth prevMainHeightWidth firstAll shareEnded p_dispActiveNames nForReadjustRecord first_round chatRefStreams updateLStreams updateChatRefStreams updateNForReadjustRecord updateShowMiniView prepopulateUserMedia rePort processConsumerTransports resumePauseStreams readjust addVideosGrid getEstimate checkGrid resumePauseAudioStreams fixedPageLimit removeAltGrid isMediumScreen updateRemoveAltGrid calculateRowsAndColumns forceFullDisplay mainScreenFilled adminOnMainScreen mainScreenPerson audioAlreadyOn checkOrientation screenForceFullDisplay remoteScreenStream isWideScreen localUIMode annotateScreenStream updateMainScreenPerson updateMainScreenFilled updateAdminOnMainScreen updateMainHeightWidth updateScreenForceFullDisplay updateMainGridStream customVideoCard? customAudioCard? customMiniCard? videoCardComponent? audioCardComponent? miniCardComponent? recordStarted recordStopped recordPaused recordResumed screenStates prevScreenStates updateScreenStates updatePrevScreenStates compareActiveNames compareScreenStates allVideoStreams oldAllStreams screenId? adminVidID? newLimitedStreams newLimitedStreamsIDs activeSounds screenShareIDStream? screenShareNameStream? adminIDStream? adminNameStream? updateNewLimitedStreams updateNewLimitedStreamsIDs updateActiveSounds updateScreenShareIDStream updateScreenShareNameStream updateAdminIDStream updateAdminNameStream updateYouYouStream changeVids allAudioStreams limitedBreakRoom updateLimitedBreakRoom processConsumerTransportsAudio socket participants localStream transportCreated transportCreatedVideo videoAlreadyOn videoAction videoParams localStreamVideo defVideoID userDefaultVideoInputDevice params videoParamse? islevel member updateMainWindow lock_screen shared shareScreenStarted vParams hParams allowed currentFacingMode device keepBackground appliedBackground videoProducer updateTransportCreatedVideo updateVideoAlreadyOn updateVideoAction updateLocalStream updateLocalStreamVideo updateUserDefaultVideoInputDevice updateDefVideoID updateAllowed updateUpdateMainWindow updateParticipants updateVideoParams updateIsBackgroundModalVisible updateAutoClickBackground createSendTransport connectSendTransportVideo reorderStreams audioOnlyRoom frameRate vidCons showAlert? mediaDevices hasCameraPermission updateVideoSwitching updateCurrentFacingMode requestPermissionCamera streamSuccessVideo sleep checkMediaPermission getUpdatedAllParams updateDateState? lastUpdate nForReadjust updateUpdateDateState updateLastUpdate updateNForReadjust autoAdjust updateGridRows updateGridCols updateAltGridRows updateAltGridCols updateGridSizes gridSizes paginationDirection paginationHeightWidth componentSizes recordingMediaOptions youAreCoHost adminRestrictSetting videoRequestState videoRequestTime audioSetting videoSetting screenshareSetting chatSetting updateRequestIntervalSeconds updateVideoRequestState disconnectSendTransportVideo checkPermission

Properties

coHostResponsibility

coHostResponsibility: CoHostResponsibility[]

Array of responsibilities assigned to co-hosts

roomName

roomName: string

Name/ID of the current room session

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

p_activeNames

p_activeNames: string[]

activeNames

activeNames: string[]

dispActiveNames

dispActiveNames: string[]

non_alVideoStreams

non_alVideoStreams: Participant[]

ref_participants

ref_participants: Participant[]

eventType

eventType: EventType

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

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

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)

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

prevActiveNames

prevActiveNames: string[]

updatePrevActiveNames

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

trigger

trigger: TriggerType

audioParams

audioParams: ProducerOptions

localStreamScreen

localStreamScreen: MediaStream

canvasStream

canvasStream: MediaStream

whiteboardStarted

whiteboardStarted: boolean

whiteboardEnded

whiteboardEnded: boolean

connectSendTransportAudio

connectSendTransportAudio: ConnectSendTransportAudioType

connectSendTransportScreen

connectSendTransportScreen: ConnectSendTransportScreenType

audioProducer

audioProducer: Producer<AppData>

OptionallocalAudioProducer

localAudioProducer?: Producer<AppData>

updateAudioProducer

updateAudioProducer: ((producer: Producer<AppData>) => void)

OptionalupdateLocalAudioProducer

updateLocalAudioProducer?: ((localProducer: Producer<AppData>) => void)

updateAudioLevel

updateAudioLevel: ((level: number) => void)

screenProducer

screenProducer: Producer<AppData>

OptionallocalScreenProducer

localScreenProducer?: Producer<AppData>

screenParams

screenParams: ProducerOptions

updateScreenProducer

updateScreenProducer: ((producer: Producer<AppData>) => void)

OptionalupdateLocalScreenProducer

updateLocalScreenProducer?: ((localProducer: Producer<AppData>) => void)

OptionallocalVideoProducer

localVideoProducer?: Producer<AppData>

updateVideoProducer

updateVideoProducer: ((producer: Producer<AppData>) => void)

OptionalupdateLocalVideoProducer

updateLocalVideoProducer?: ((localProducer: Producer<AppData>) => void)

OptionallocalSocket

localSocket?: Socket<DefaultEventsMap, DefaultEventsMap>

producerTransport

producerTransport: Transport<AppData>

OptionallocalProducerTransport

localProducerTransport?: Transport<AppData>

OptionallocalTransportCreated

localTransportCreated?: boolean

updateProducerTransport

updateProducerTransport: ((producerTransport: Transport<AppData>) => void)

OptionalupdateLocalProducerTransport

updateLocalProducerTransport?: ((localTransport: Transport<AppData>) => void)

updateTransportCreated

updateTransportCreated: ((transportCreated: boolean) => void)

OptionalupdateLocalTransportCreated

updateLocalTransportCreated?: ((localTransportCreated: boolean) => void)

connectSendTransport

connectSendTransport: ConnectSendTransportType

consumerTransports

consumerTransports: Transport[]

streamNames

streamNames: Stream[]

audStreamNames

audStreamNames: Stream[]

hostLabel

hostLabel: string

mainHeightWidth

mainHeightWidth: number

prevMainHeightWidth

prevMainHeightWidth: number

firstAll

firstAll: boolean

shareEnded

shareEnded: boolean

p_dispActiveNames

p_dispActiveNames: string[]

nForReadjustRecord

nForReadjustRecord: number

first_round

first_round: boolean

chatRefStreams

chatRefStreams: (Stream | Participant)[]

updateLStreams

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

updateChatRefStreams

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

updateNForReadjustRecord

updateNForReadjustRecord: ((n: number) => 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

forceFullDisplay

forceFullDisplay: boolean

mainScreenFilled

mainScreenFilled: boolean

adminOnMainScreen

adminOnMainScreen: boolean

mainScreenPerson

mainScreenPerson: string

audioAlreadyOn

audioAlreadyOn: boolean

checkOrientation

checkOrientation: (() => string)

screenForceFullDisplay

screenForceFullDisplay: boolean

remoteScreenStream

remoteScreenStream: Stream[]

isWideScreen

isWideScreen: boolean

localUIMode

localUIMode: 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>

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

allVideoStreams

allVideoStreams: (Stream | Participant)[]

oldAllStreams

oldAllStreams: (Stream | Participant)[]

OptionalscreenId

screenId?: string

OptionaladminVidID

adminVidID?: string

newLimitedStreams

newLimitedStreams: (Stream | Participant)[]

newLimitedStreamsIDs

newLimitedStreamsIDs: string[]

activeSounds

activeSounds: string[]

OptionalscreenShareIDStream

screenShareIDStream?: string

OptionalscreenShareNameStream

screenShareNameStream?: string

OptionaladminIDStream

adminIDStream?: string

OptionaladminNameStream

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

socket

socket: Socket<DefaultEventsMap, DefaultEventsMap>

Socket.io client instance for real-time communication

participants

participants: Participant[]

Array of all participants in the session

localStream

localStream: MediaStream

transportCreated

transportCreated: boolean

transportCreatedVideo

transportCreatedVideo: boolean

videoAlreadyOn

videoAlreadyOn: boolean

videoAction

videoAction: boolean

videoParams

videoParams: ProducerOptions

localStreamVideo

localStreamVideo: MediaStream

defVideoID

defVideoID: string

userDefaultVideoInputDevice

userDefaultVideoInputDevice: string

params

params: ProducerOptions

OptionalvideoParamse

videoParamse?: ProducerOptions

islevel

islevel: string

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

member

member: string

Current user's member ID

updateMainWindow

updateMainWindow: boolean

lock_screen

lock_screen: boolean

shared

shared: boolean

shareScreenStarted

shareScreenStarted: boolean

vParams

vParams: VParamsType

hParams

hParams: HParamsType

allowed

allowed: boolean

currentFacingMode

currentFacingMode: string

device

device: Device

keepBackground

keepBackground: boolean

appliedBackground

appliedBackground: boolean

videoProducer

videoProducer: Producer<AppData>

updateTransportCreatedVideo

updateTransportCreatedVideo: ((created: boolean) => void)

updateVideoAlreadyOn

updateVideoAlreadyOn: ((videoOn: boolean) => void)

updateVideoAction

updateVideoAction: ((videoAction: boolean) => void)

updateLocalStream

updateLocalStream: ((stream: MediaStream) => void)

updateLocalStreamVideo

updateLocalStreamVideo: ((stream: MediaStream) => void)

updateUserDefaultVideoInputDevice

updateUserDefaultVideoInputDevice: ((device: string) => void)

updateDefVideoID

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

updateAllowed

updateAllowed: ((allowed: boolean) => void)

updateUpdateMainWindow

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

updateParticipants

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

updateVideoParams

updateVideoParams: ((params: ProducerOptions) => void)

updateIsBackgroundModalVisible

updateIsBackgroundModalVisible: ((isVisible: boolean) => void)

updateAutoClickBackground

updateAutoClickBackground: ((autoClick: boolean) => void)

createSendTransport

createSendTransport: CreateSendTransportType

connectSendTransportVideo

connectSendTransportVideo: ConnectSendTransportVideoType

reorderStreams

reorderStreams: ReorderStreamsType

audioOnlyRoom

audioOnlyRoom: boolean

frameRate

frameRate: number

vidCons

vidCons: VidCons

OptionalshowAlert

showAlert?: ShowAlert

Optional function to display alerts/notifications

mediaDevices

mediaDevices: {
    getUserMedia: ((constraints: MediaStreamConstraints) => Promise<MediaStream>);
    getDisplayMedia: ((constraints: MediaStreamConstraints) => Promise<MediaStream>);
    enumerateDevices: (() => Promise<MediaDeviceInfo[]>);
}

hasCameraPermission

hasCameraPermission: boolean

updateVideoSwitching

updateVideoSwitching: ((state: boolean) => void)

updateCurrentFacingMode

updateCurrentFacingMode: ((mode: string) => void)

requestPermissionCamera

requestPermissionCamera: RequestPermissionCameraType

streamSuccessVideo

streamSuccessVideo: StreamSuccessVideoType

sleep

sleep: SleepType

checkMediaPermission

checkMediaPermission: boolean

getUpdatedAllParams

getUpdatedAllParams: (() => SwitchUserVideoAltParameters)

Function to retrieve latest parameter state

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

recordingMediaOptions

recordingMediaOptions: string

youAreCoHost

youAreCoHost: boolean

adminRestrictSetting

adminRestrictSetting: boolean

videoRequestState

videoRequestState: string

videoRequestTime

videoRequestTime: number

audioSetting

audioSetting: string

videoSetting

videoSetting: string

screenshareSetting

screenshareSetting: string

chatSetting

chatSetting: string

updateRequestIntervalSeconds

updateRequestIntervalSeconds: number

updateVideoRequestState

updateVideoRequestState: ((state: string) => void)

disconnectSendTransportVideo

disconnectSendTransportVideo: DisconnectSendTransportVideoType

checkPermission

checkPermission: CheckPermissionType

Settings

Member Visibility

On This Page

Properties
coHostResponsibilityroomNamecoHostupdateAddAltGridotherGridStreamsupdateOtherGridStreamsupdateMiniCardsGridp_activeNamesactiveNamesdispActiveNamesnon_alVideoStreamsref_participantseventTypesortAudioLoudnessaudioDecibelsmixed_alVideoStreamsnon_alVideoStreams_mutedremoteProducerIdscreenPageLimitmeetingDisplayTypemeetingVideoOptimizedrecordingVideoOptimizedrecordingDisplayTypepaginatedStreamsitemPageLimitdoPaginateprevDoPaginatecurrentUserPagebreakoutRoomshostNewRoombreakOutRoomStartedbreakOutRoomEndedvirtualStreammainRoomsLengthmemberRoomupdateP_activeNamesupdateActiveNamesupdateDispActiveNamesupdateNon_alVideoStreamsupdateRef_participantsupdateSortAudioLoudnessupdateMixed_alVideoStreamsupdateNon_alVideoStreams_mutedupdatePaginatedStreamsupdateDoPaginateupdatePrevDoPaginateupdateCurrentUserPageupdateNumberPagesupdateMainRoomsLengthupdateMemberRoommixStreamsdispStreamsprevActiveNamesupdatePrevActiveNamestriggeraudioParamslocalStreamScreencanvasStreamwhiteboardStartedwhiteboardEndedconnectSendTransportAudioconnectSendTransportScreenaudioProducerlocalAudioProducerupdateAudioProducerupdateLocalAudioProducerupdateAudioLevelscreenProducerlocalScreenProducerscreenParamsupdateScreenProducerupdateLocalScreenProducerlocalVideoProducerupdateVideoProducerupdateLocalVideoProducerlocalSocketproducerTransportlocalProducerTransportlocalTransportCreatedupdateProducerTransportupdateLocalProducerTransportupdateTransportCreatedupdateLocalTransportCreatedconnectSendTransportconsumerTransportsstreamNamesaudStreamNameshostLabelmainHeightWidthprevMainHeightWidthfirstAllshareEndedp_dispActiveNamesnForReadjustRecordfirst_roundchatRefStreamsupdateLStreamsupdateChatRefStreamsupdateNForReadjustRecordupdateShowMiniViewprepopulateUserMediarePortprocessConsumerTransportsresumePauseStreamsreadjustaddVideosGridgetEstimatecheckGridresumePauseAudioStreamsfixedPageLimitremoveAltGridisMediumScreenupdateRemoveAltGridcalculateRowsAndColumnsforceFullDisplaymainScreenFilledadminOnMainScreenmainScreenPersonaudioAlreadyOncheckOrientationscreenForceFullDisplayremoteScreenStreamisWideScreenlocalUIModeannotateScreenStreamupdateMainScreenPersonupdateMainScreenFilledupdateAdminOnMainScreenupdateMainHeightWidthupdateScreenForceFullDisplayupdateMainGridStreamcustomVideoCardcustomAudioCardcustomMiniCardvideoCardComponentaudioCardComponentminiCardComponentrecordStartedrecordStoppedrecordPausedrecordResumedscreenStatesprevScreenStatesupdateScreenStatesupdatePrevScreenStatescompareActiveNamescompareScreenStatesallVideoStreamsoldAllStreamsscreenIdadminVidIDnewLimitedStreamsnewLimitedStreamsIDsactiveSoundsscreenShareIDStreamscreenShareNameStreamadminIDStreamadminNameStreamupdateNewLimitedStreamsupdateNewLimitedStreamsIDsupdateActiveSoundsupdateScreenShareIDStreamupdateScreenShareNameStreamupdateAdminIDStreamupdateAdminNameStreamupdateYouYouStreamchangeVidsallAudioStreamslimitedBreakRoomupdateLimitedBreakRoomprocessConsumerTransportsAudiosocketparticipantslocalStreamtransportCreatedtransportCreatedVideovideoAlreadyOnvideoActionvideoParamslocalStreamVideodefVideoIDuserDefaultVideoInputDeviceparamsvideoParamseislevelmemberupdateMainWindowlock_screensharedshareScreenStartedvParamshParamsallowedcurrentFacingModedevicekeepBackgroundappliedBackgroundvideoProducerupdateTransportCreatedVideoupdateVideoAlreadyOnupdateVideoActionupdateLocalStreamupdateLocalStreamVideoupdateUserDefaultVideoInputDeviceupdateDefVideoIDupdateAllowedupdateUpdateMainWindowupdateParticipantsupdateVideoParamsupdateIsBackgroundModalVisibleupdateAutoClickBackgroundcreateSendTransportconnectSendTransportVideoreorderStreamsaudioOnlyRoomframeRatevidConsshowAlertmediaDeviceshasCameraPermissionupdateVideoSwitchingupdateCurrentFacingModerequestPermissionCamerastreamSuccessVideosleepcheckMediaPermissiongetUpdatedAllParamsupdateDateStatelastUpdatenForReadjustupdateUpdateDateStateupdateLastUpdateupdateNForReadjustautoAdjustupdateGridRowsupdateGridColsupdateAltGridRowsupdateAltGridColsupdateGridSizesgridSizespaginationDirectionpaginationHeightWidthcomponentSizesrecordingMediaOptionsyouAreCoHostadminRestrictSettingvideoRequestStatevideoRequestTimeaudioSettingvideoSettingscreenshareSettingchatSettingupdateRequestIntervalSecondsupdateVideoRequestStatedisconnectSendTransportVideocheckPermission