Interface WhiteboardParameters

interface WhiteboardParameters {
    coHostResponsibility: CoHostResponsibility[];
    coHost: string;
    socket: Socket<DefaultEventsMap, DefaultEventsMap>;
    showAlert?: ShowAlert;
    islevel: string;
    roomName: string;
    shapes: Shape[];
    useImageBackground: boolean;
    redoStack: Shape[];
    undoStack: string[];
    whiteboardStarted: boolean;
    whiteboardEnded: boolean;
    whiteboardUsers: WhiteboardUser[];
    participants: Participant[];
    participantsAll: Participant[];
    screenId: string;
    recordStarted: boolean;
    recordStopped: boolean;
    recordPaused: boolean;
    recordResumed: boolean;
    recordingMediaOptions: string;
    member: string;
    shareScreenStarted: boolean;
    canvasWhiteboard: null | HTMLCanvasElement;
    targetResolution?: string;
    targetResolutionHost?: string;
    updateShapes: ((shapes: Shape[]) => void);
    updateUseImageBackground: ((useImageBackground: boolean) => void);
    updateRedoStack: ((redoStack: Shape[]) => void);
    updateUndoStack: ((undoStack: string[]) => void);
    updateWhiteboardStarted: ((whiteboardStarted: boolean) => void);
    updateWhiteboardEnded: ((whiteboardEnded: boolean) => void);
    updateWhiteboardUsers: ((whiteboardUsers: WhiteboardUser[]) => void);
    updateParticipants: ((participants: Participant[]) => void);
    updateScreenId: ((screenId: string) => void);
    updateShareScreenStarted: ((shareScreenStarted: boolean) => void);
    updateCanvasWhiteboard: ((canvasWhiteboard: null | HTMLCanvasElement) => void);
    onScreenChanges: OnScreenChangesType;
    captureCanvasStream: CaptureCanvasStreamType;
    getUpdatedAllParams: (() => WhiteboardParameters);
    updateAddAltGrid: ((addAltGrid: boolean) => void);
    otherGridStreams: CustomMediaComponent[][];
    updateOtherGridStreams: ((otherGridStreams: CustomMediaComponent[][]) => void);
    updateMiniCardsGrid: UpdateMiniCardsGridType;
    p_activeNames: string[];
    activeNames: string[];
    dispActiveNames: string[];
    non_alVideoStreams: Participant[];
    ref_participants: Participant[];
    sortAudioLoudness: boolean;
    audioDecibels: AudioDecibels[];
    mixed_alVideoStreams: (Stream | Participant)[];
    non_alVideoStreams_muted: Participant[];
    remoteProducerId?: string;
    localStreamVideo: null | MediaStream;
    screenPageLimit: number;
    meetingDisplayType: string;
    meetingVideoOptimized: boolean;
    recordingVideoOptimized: boolean;
    recordingDisplayType: "video" | "media" | "all";
    paginatedStreams: (Stream | Participant)[][];
    doPaginate: boolean;
    prevDoPaginate: boolean;
    currentUserPage: number;
    breakoutRooms: BreakoutParticipant[][];
    hostNewRoom: number;
    breakOutRoomStarted: boolean;
    breakOutRoomEnded: boolean;
    virtualStream: null | 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;
    audioProducer: null | Producer<AppData>;
    localAudioProducer?: null | Producer<AppData>;
    updateAudioProducer: ((producer: null | Producer<AppData>) => void);
    updateLocalAudioProducer?: ((localProducer: null | Producer<AppData>) => void);
    updateAudioLevel: ((level: number) => void);
    screenParams: ProducerOptions;
    params: ProducerOptions;
    videoProducer: null | Producer<AppData>;
    localVideoProducer?: null | Producer<AppData>;
    updateVideoProducer: ((producer: null | Producer<AppData>) => void);
    updateLocalVideoProducer?: ((localProducer: null | Producer<AppData>) => void);
    audioParams: ProducerOptions;
    videoParams: ProducerOptions;
    connectSendTransportAudio: ConnectSendTransportAudioType;
    connectSendTransportVideo: ConnectSendTransportVideoType;
    device: null | Device;
    producerTransport: null | Transport<AppData>;
    localProducerTransport?: null | Transport<AppData>;
    updateProducerTransport: ((producerTransport: null | Transport<AppData>) => void);
    updateLocalProducerTransport?: ((localTransport: null | 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;
    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;
    eventType: EventType;
    shared: boolean;
    addForBasic: boolean;
    updateAddForBasic: ((value: boolean) => void);
    itemPageLimit: number;
    updateItemPageLimit: ((value: number) => void);
    updateMainHeightWidth: ((value: number) => void);
    reorderStreams: ReorderStreamsType;
    forceFullDisplay: boolean;
    mainScreenFilled: boolean;
    adminOnMainScreen: boolean;
    mainScreenPerson: string;
    videoAlreadyOn: boolean;
    audioAlreadyOn: boolean;
    checkOrientation: (() => string);
    screenForceFullDisplay: boolean;
    localStreamScreen: null | MediaStream;
    remoteScreenStream: Stream[];
    isWideScreen: boolean;
    localUIMode: boolean;
    annotateScreenStream: boolean;
    updateMainScreenPerson: ((person: string) => void);
    updateMainScreenFilled: ((filled: boolean) => void);
    updateAdminOnMainScreen: ((admin: boolean) => void);
    updateScreenForceFullDisplay: ((force: boolean) => void);
    updateMainGridStream: ((components: CustomMediaComponent[]) => void);
    sleep: SleepType;
    screenStates: ScreenState[];
    prevScreenStates: ScreenState[];
    updateScreenStates: ((states: ScreenState[]) => void);
    updatePrevScreenStates: ((states: ScreenState[]) => void);
    compareActiveNames: CompareActiveNamesType;
    compareScreenStates: CompareScreenStatesType;
    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;
    localSocket?: Socket<DefaultEventsMap, DefaultEventsMap>;
    updateDateState?: null | number;
    lastUpdate: null | number;
    nForReadjust: number;
    updateUpdateDateState: ((timestamp: null | number) => void);
    updateLastUpdate: ((lastUpdate: null | 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;
    canvasStream: null | MediaStream;
    updateCanvasStream: ((stream: null | MediaStream) => void);
    screenProducer: null | Producer<AppData>;
    localScreenProducer?: null | Producer<AppData>;
    transportCreated: boolean;
    localTransportCreated?: boolean;
    updateScreenProducer: ((producer: null | Producer<AppData>) => void);
    updateLocalScreenProducer?: ((localProducer: null | Producer<AppData>) => void);
    createSendTransport: CreateSendTransportType;
    connectSendTransportScreen: ConnectSendTransportScreenType;
    disconnectSendTransportScreen: DisconnectSendTransportScreenType;
    [key: string]: any;
}

Hierarchy (view full)

Indexable

  • [key: string]: any

Properties

coHostResponsibility coHost socket showAlert? islevel roomName shapes useImageBackground redoStack undoStack whiteboardStarted whiteboardEnded whiteboardUsers participants participantsAll screenId recordStarted recordStopped recordPaused recordResumed recordingMediaOptions member shareScreenStarted canvasWhiteboard targetResolution? targetResolutionHost? updateShapes updateUseImageBackground updateRedoStack updateUndoStack updateWhiteboardStarted updateWhiteboardEnded updateWhiteboardUsers updateParticipants updateScreenId updateShareScreenStarted updateCanvasWhiteboard onScreenChanges captureCanvasStream getUpdatedAllParams updateAddAltGrid otherGridStreams updateOtherGridStreams updateMiniCardsGrid p_activeNames activeNames dispActiveNames non_alVideoStreams ref_participants sortAudioLoudness audioDecibels mixed_alVideoStreams non_alVideoStreams_muted remoteProducerId? localStreamVideo screenPageLimit meetingDisplayType meetingVideoOptimized recordingVideoOptimized recordingDisplayType paginatedStreams 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 audioProducer localAudioProducer? updateAudioProducer updateLocalAudioProducer? updateAudioLevel screenParams params videoProducer localVideoProducer? updateVideoProducer updateLocalVideoProducer? audioParams videoParams connectSendTransportAudio connectSendTransportVideo device producerTransport localProducerTransport? updateProducerTransport updateLocalProducerTransport? updateTransportCreated updateLocalTransportCreated? connectSendTransport 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 eventType shared addForBasic updateAddForBasic itemPageLimit updateItemPageLimit updateMainHeightWidth reorderStreams forceFullDisplay mainScreenFilled adminOnMainScreen mainScreenPerson videoAlreadyOn audioAlreadyOn checkOrientation screenForceFullDisplay localStreamScreen remoteScreenStream isWideScreen localUIMode annotateScreenStream updateMainScreenPerson updateMainScreenFilled updateAdminOnMainScreen updateScreenForceFullDisplay updateMainGridStream sleep screenStates prevScreenStates updateScreenStates updatePrevScreenStates compareActiveNames compareScreenStates allVideoStreams oldAllStreams adminVidID? newLimitedStreams newLimitedStreamsIDs activeSounds screenShareIDStream? screenShareNameStream? adminIDStream? adminNameStream? updateNewLimitedStreams updateNewLimitedStreamsIDs updateActiveSounds updateScreenShareIDStream updateScreenShareNameStream updateAdminIDStream updateAdminNameStream updateYouYouStream changeVids allAudioStreams limitedBreakRoom updateLimitedBreakRoom processConsumerTransportsAudio localSocket? updateDateState? lastUpdate nForReadjust updateUpdateDateState updateLastUpdate updateNForReadjust autoAdjust updateGridRows updateGridCols updateAltGridRows updateAltGridCols updateGridSizes gridSizes paginationDirection paginationHeightWidth componentSizes canvasStream updateCanvasStream screenProducer localScreenProducer? transportCreated localTransportCreated? updateScreenProducer updateLocalScreenProducer? createSendTransport connectSendTransportScreen disconnectSendTransportScreen

Properties

coHostResponsibility

coHostResponsibility: CoHostResponsibility[]

coHost

coHost: string

socket

socket: Socket<DefaultEventsMap, DefaultEventsMap>

OptionalshowAlert

showAlert?: ShowAlert

islevel

islevel: string

roomName

roomName: string

shapes

shapes: Shape[]

useImageBackground

useImageBackground: boolean

redoStack

redoStack: Shape[]

undoStack

undoStack: string[]

whiteboardStarted

whiteboardStarted: boolean

whiteboardEnded

whiteboardEnded: boolean

whiteboardUsers

whiteboardUsers: WhiteboardUser[]

participants

participants: Participant[]

participantsAll

participantsAll: Participant[]

screenId

screenId: string

recordStarted

recordStarted: boolean

recordStopped

recordStopped: boolean

recordPaused

recordPaused: boolean

recordResumed

recordResumed: boolean

recordingMediaOptions

recordingMediaOptions: string

member

member: string

shareScreenStarted

shareScreenStarted: boolean

canvasWhiteboard

canvasWhiteboard: null | HTMLCanvasElement

OptionaltargetResolution

targetResolution?: string

OptionaltargetResolutionHost

targetResolutionHost?: string

updateShapes

updateShapes: ((shapes: Shape[]) => void)

updateUseImageBackground

updateUseImageBackground: ((useImageBackground: boolean) => void)

updateRedoStack

updateRedoStack: ((redoStack: Shape[]) => void)

updateUndoStack

updateUndoStack: ((undoStack: string[]) => void)

updateWhiteboardStarted

updateWhiteboardStarted: ((whiteboardStarted: boolean) => void)

updateWhiteboardEnded

updateWhiteboardEnded: ((whiteboardEnded: boolean) => void)

updateWhiteboardUsers

updateWhiteboardUsers: ((whiteboardUsers: WhiteboardUser[]) => void)

updateParticipants

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

updateScreenId

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

updateShareScreenStarted

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

updateCanvasWhiteboard

updateCanvasWhiteboard: ((canvasWhiteboard: null | HTMLCanvasElement) => void)

onScreenChanges

onScreenChanges: OnScreenChangesType

captureCanvasStream

captureCanvasStream: CaptureCanvasStreamType

getUpdatedAllParams

getUpdatedAllParams: (() => WhiteboardParameters)

updateAddAltGrid

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

otherGridStreams

otherGridStreams: CustomMediaComponent[][]

updateOtherGridStreams

updateOtherGridStreams: ((otherGridStreams: CustomMediaComponent[][]) => 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[]

sortAudioLoudness

sortAudioLoudness: boolean

audioDecibels

audioDecibels: AudioDecibels[]

mixed_alVideoStreams

mixed_alVideoStreams: (Stream | Participant)[]

non_alVideoStreams_muted

non_alVideoStreams_muted: Participant[]

OptionalremoteProducerId

remoteProducerId?: string

localStreamVideo

localStreamVideo: null | MediaStream

screenPageLimit

screenPageLimit: number

meetingDisplayType

meetingDisplayType: string

meetingVideoOptimized

meetingVideoOptimized: boolean

recordingVideoOptimized

recordingVideoOptimized: boolean

recordingDisplayType

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

paginatedStreams

paginatedStreams: (Stream | Participant)[][]

doPaginate

doPaginate: boolean

prevDoPaginate

prevDoPaginate: boolean

currentUserPage

currentUserPage: number

breakoutRooms

breakoutRooms: BreakoutParticipant[][]

hostNewRoom

hostNewRoom: number

breakOutRoomStarted

breakOutRoomStarted: boolean

breakOutRoomEnded

breakOutRoomEnded: boolean

virtualStream

virtualStream: null | 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

audioProducer

audioProducer: null | Producer<AppData>

OptionallocalAudioProducer

localAudioProducer?: null | Producer<AppData>

updateAudioProducer

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

OptionalupdateLocalAudioProducer

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

updateAudioLevel

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

screenParams

screenParams: ProducerOptions

params

params: ProducerOptions

videoProducer

videoProducer: null | Producer<AppData>

OptionallocalVideoProducer

localVideoProducer?: null | Producer<AppData>

updateVideoProducer

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

OptionalupdateLocalVideoProducer

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

audioParams

audioParams: ProducerOptions

videoParams

videoParams: ProducerOptions

connectSendTransportAudio

connectSendTransportAudio: ConnectSendTransportAudioType

connectSendTransportVideo

connectSendTransportVideo: ConnectSendTransportVideoType

device

device: null | Device

producerTransport

producerTransport: null | Transport<AppData>

OptionallocalProducerTransport

localProducerTransport?: null | Transport<AppData>

updateProducerTransport

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

OptionalupdateLocalProducerTransport

updateLocalProducerTransport?: ((localTransport: null | 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

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

eventType

eventType: EventType

shared

shared: boolean

addForBasic

addForBasic: boolean

updateAddForBasic

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

itemPageLimit

itemPageLimit: number

updateItemPageLimit

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

updateMainHeightWidth

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

reorderStreams

reorderStreams: ReorderStreamsType

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: null | MediaStream

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)

updateScreenForceFullDisplay

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

updateMainGridStream

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

sleep

sleep: SleepType

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

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

OptionallocalSocket

localSocket?: Socket<DefaultEventsMap, DefaultEventsMap>

OptionalupdateDateState

updateDateState?: null | number

lastUpdate

lastUpdate: null | number

nForReadjust

nForReadjust: number

updateUpdateDateState

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

updateLastUpdate

updateLastUpdate: ((lastUpdate: null | 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

canvasStream

canvasStream: null | MediaStream

updateCanvasStream

updateCanvasStream: ((stream: null | MediaStream) => void)

screenProducer

screenProducer: null | Producer<AppData>

OptionallocalScreenProducer

localScreenProducer?: null | Producer<AppData>

transportCreated

transportCreated: boolean

OptionallocalTransportCreated

localTransportCreated?: boolean

updateScreenProducer

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

OptionalupdateLocalScreenProducer

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

createSendTransport

createSendTransport: CreateSendTransportType

connectSendTransportScreen

connectSendTransportScreen: ConnectSendTransportScreenType

disconnectSendTransportScreen

disconnectSendTransportScreen: DisconnectSendTransportScreenType

Settings

Member Visibility

On This Page

Properties
coHostResponsibilitycoHostsocketshowAlertislevelroomNameshapesuseImageBackgroundredoStackundoStackwhiteboardStartedwhiteboardEndedwhiteboardUsersparticipantsparticipantsAllscreenIdrecordStartedrecordStoppedrecordPausedrecordResumedrecordingMediaOptionsmembershareScreenStartedcanvasWhiteboardtargetResolutiontargetResolutionHostupdateShapesupdateUseImageBackgroundupdateRedoStackupdateUndoStackupdateWhiteboardStartedupdateWhiteboardEndedupdateWhiteboardUsersupdateParticipantsupdateScreenIdupdateShareScreenStartedupdateCanvasWhiteboardonScreenChangescaptureCanvasStreamgetUpdatedAllParamsupdateAddAltGridotherGridStreamsupdateOtherGridStreamsupdateMiniCardsGridp_activeNamesactiveNamesdispActiveNamesnon_alVideoStreamsref_participantssortAudioLoudnessaudioDecibelsmixed_alVideoStreamsnon_alVideoStreams_mutedremoteProducerIdlocalStreamVideoscreenPageLimitmeetingDisplayTypemeetingVideoOptimizedrecordingVideoOptimizedrecordingDisplayTypepaginatedStreamsdoPaginateprevDoPaginatecurrentUserPagebreakoutRoomshostNewRoombreakOutRoomStartedbreakOutRoomEndedvirtualStreammainRoomsLengthmemberRoomupdateP_activeNamesupdateActiveNamesupdateDispActiveNamesupdateNon_alVideoStreamsupdateRef_participantsupdateSortAudioLoudnessupdateMixed_alVideoStreamsupdateNon_alVideoStreams_mutedupdatePaginatedStreamsupdateDoPaginateupdatePrevDoPaginateupdateCurrentUserPageupdateNumberPagesupdateMainRoomsLengthupdateMemberRoommixStreamsdispStreamsprevActiveNamesupdatePrevActiveNamestriggeraudioProducerlocalAudioProducerupdateAudioProducerupdateLocalAudioProducerupdateAudioLevelscreenParamsparamsvideoProducerlocalVideoProducerupdateVideoProducerupdateLocalVideoProduceraudioParamsvideoParamsconnectSendTransportAudioconnectSendTransportVideodeviceproducerTransportlocalProducerTransportupdateProducerTransportupdateLocalProducerTransportupdateTransportCreatedupdateLocalTransportCreatedconnectSendTransportconsumerTransportsstreamNamesaudStreamNameshostLabelmainHeightWidthprevMainHeightWidthfirstAllshareEndedupdateMainWindowp_dispActiveNamesnForReadjustRecordfirst_roundlock_screenchatRefStreamskeepBackgroundupdateLStreamsupdateChatRefStreamsupdateNForReadjustRecordupdateUpdateMainWindowupdateShowMiniViewprepopulateUserMediarePortprocessConsumerTransportsresumePauseStreamsreadjustaddVideosGridgetEstimatecheckGridresumePauseAudioStreamsfixedPageLimitremoveAltGridisMediumScreenupdateRemoveAltGridcalculateRowsAndColumnseventTypesharedaddForBasicupdateAddForBasicitemPageLimitupdateItemPageLimitupdateMainHeightWidthreorderStreamsforceFullDisplaymainScreenFilledadminOnMainScreenmainScreenPersonvideoAlreadyOnaudioAlreadyOncheckOrientationscreenForceFullDisplaylocalStreamScreenremoteScreenStreamisWideScreenlocalUIModeannotateScreenStreamupdateMainScreenPersonupdateMainScreenFilledupdateAdminOnMainScreenupdateScreenForceFullDisplayupdateMainGridStreamsleepscreenStatesprevScreenStatesupdateScreenStatesupdatePrevScreenStatescompareActiveNamescompareScreenStatesallVideoStreamsoldAllStreamsadminVidIDnewLimitedStreamsnewLimitedStreamsIDsactiveSoundsscreenShareIDStreamscreenShareNameStreamadminIDStreamadminNameStreamupdateNewLimitedStreamsupdateNewLimitedStreamsIDsupdateActiveSoundsupdateScreenShareIDStreamupdateScreenShareNameStreamupdateAdminIDStreamupdateAdminNameStreamupdateYouYouStreamchangeVidsallAudioStreamslimitedBreakRoomupdateLimitedBreakRoomprocessConsumerTransportsAudiolocalSocketupdateDateStatelastUpdatenForReadjustupdateUpdateDateStateupdateLastUpdateupdateNForReadjustautoAdjustupdateGridRowsupdateGridColsupdateAltGridRowsupdateAltGridColsupdateGridSizesgridSizespaginationDirectionpaginationHeightWidthcomponentSizescanvasStreamupdateCanvasStreamscreenProducerlocalScreenProducertransportCreatedlocalTransportCreatedupdateScreenProducerupdateLocalScreenProducercreateSendTransportconnectSendTransportScreendisconnectSendTransportScreen