Interface MediaSettingsModalParameters

Handles the success of switching audio devices in a streaming context.

Async

Function

Param: parameters

The parameters object containing necessary variables.

Param: stream

The new MediaStream with the switched audio device.

interface MediaSettingsModalParameters {
    audioDecibels: AudioDecibels[];
    coHostResponsibility: CoHostResponsibility[];
    coHost: string;
    userDefaultVideoInputDevice: string;
    videoInputs: MediaDeviceInfo[];
    audioInputs: MediaDeviceInfo[];
    userDefaultAudioInputDevice: string;
    isBackgroundModalVisible: boolean;
    updateIsBackgroundModalVisible: ((visible: boolean) => void);
    getUpdatedAllParams: (() => MediaSettingsModalParameters);
    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;
    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;
    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;
    updateAudioLevel: ((level: number) => void);
    screenProducer: null | Producer<AppData>;
    localScreenProducer?: null | Producer<AppData>;
    screenParams: ProducerOptions;
    params: ProducerOptions;
    updateScreenProducer: ((producer: null | Producer<AppData>) => void);
    updateLocalScreenProducer?: ((localProducer: null | Producer<AppData>) => void);
    videoProducer: null | Producer<AppData>;
    localVideoProducer?: null | Producer<AppData>;
    updateVideoProducer: ((producer: null | Producer<AppData>) => void);
    updateLocalVideoProducer?: ((localProducer: null | Producer<AppData>) => void);
    videoParams: ProducerOptions;
    canvasStream: null | MediaStream;
    connectSendTransportVideo: ConnectSendTransportVideoType;
    connectSendTransportScreen: ConnectSendTransportScreenType;
    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[];
    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);
    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;
    participants: Participant[];
    allVideoStreams: (Stream | Participant)[];
    member: string;
    shareScreenStarted: boolean;
    eventType: EventType;
    screenId?: string;
    forceFullDisplay: boolean;
    mainScreenFilled: boolean;
    adminOnMainScreen: boolean;
    mainScreenPerson: string;
    oldAllStreams: (Stream | Participant)[];
    checkOrientation: (() => string);
    screenForceFullDisplay: boolean;
    localStreamScreen: null | MediaStream;
    remoteScreenStream: Stream[];
    localStreamVideo: null | MediaStream;
    mainHeightWidth: number;
    isWideScreen: boolean;
    localUIMode: boolean;
    whiteboardStarted: boolean;
    whiteboardEnded: boolean;
    virtualStream: null | MediaStream;
    keepBackground: 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: CustomMediaComponent[]) => void);
    screenStates: ScreenState[];
    prevScreenStates: ScreenState[];
    updateScreenStates: ((states: ScreenState[]) => void);
    updatePrevScreenStates: ((states: ScreenState[]) => void);
    compareActiveNames: CompareActiveNamesType;
    compareScreenStates: CompareScreenStatesType;
    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;
    audioProducer: null | Producer<AppData>;
    localAudioProducer?: null | Producer<AppData>;
    socket: Socket<DefaultEventsMap, DefaultEventsMap>;
    localSocket?: Socket<DefaultEventsMap, DefaultEventsMap>;
    roomName: string;
    localStream: null | MediaStream;
    localStreamAudio: null | MediaStream;
    audioParams: ProducerOptions;
    audioPaused: boolean;
    audioAlreadyOn: boolean;
    transportCreated: boolean;
    localTransportCreated?: boolean;
    audioParamse?: ProducerCodecOptions;
    hostLabel: string;
    updateMainWindow: boolean;
    videoAlreadyOn: boolean;
    islevel: string;
    lock_screen: boolean;
    shared: boolean;
    updateAudioProducer: ((audioProducer: null | Producer<AppData>) => void);
    updateLocalAudioProducer?: ((localAudioProducer: null | Producer<AppData>) => void);
    updateLocalStream: ((localStream: null | MediaStream) => void);
    updateAudioParams: ((audioParams: ProducerOptions) => void);
    updateDefAudioID: ((defAudioID: string) => void);
    updateUpdateMainWindow: ((updateMainWindow: boolean) => void);
    sleep: SleepType;
    prepopulateUserMedia: PrepopulateUserMediaType;
    createSendTransport: CreateSendTransportType;
    connectSendTransportAudio: ConnectSendTransportAudioType;
    transportCreatedVideo: boolean;
    videoAction: boolean;
    videoParamse?: ProducerOptions;
    vParams: VParamsType;
    hParams: HParamsType;
    currentFacingMode: string;
    appliedBackground: boolean;
    updateTransportCreatedVideo: ((created: boolean) => void);
    updateVideoAlreadyOn: ((videoOn: boolean) => void);
    updateVideoAction: ((videoAction: boolean) => void);
    updateLocalStreamVideo: ((stream: null | MediaStream) => void);
    updateCurrentFacingMode: ((mode: string) => void);
    updateAllowed: ((allowed: boolean) => void);
    updateParticipants: ((participants: Participant[]) => void);
    updateVideoParams: ((params: ProducerOptions) => void);
    updateAutoClickBackground: ((autoClick: boolean) => void);
    reorderStreams: ReorderStreamsType;
    showAlert?: ShowAlert;
    hasAudioPermission: boolean;
    streamSuccessAudioSwitch: StreamSuccessAudioSwitchType;
    requestPermissionAudio: RequestPermissionAudioType;
    checkMediaPermission: boolean;
    audioOnlyRoom: boolean;
    frameRate: number;
    vidCons: VidCons;
    prevVideoInputDevice: string;
    hasCameraPermission: boolean;
    updateVideoSwitching: ((state: boolean) => void);
    requestPermissionCamera: RequestPermissionCameraType;
    streamSuccessVideo: StreamSuccessVideoType;
    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;
    youAreCoHost: boolean;
    adminRestrictSetting: boolean;
    videoRequestState: null | string;
    videoRequestTime: number;
    audioSetting: string;
    videoSetting: string;
    screenshareSetting: string;
    chatSetting: string;
    updateRequestIntervalSeconds: number;
    updateVideoRequestState: ((state: string) => void);
    disconnectSendTransportVideo: DisconnectSendTransportVideoType;
    checkPermission: CheckPermissionType;
    defAudioID: string;
    prevAudioInputDevice: string;
    updateUserDefaultAudioInputDevice: ((deviceId: string) => void);
    updatePrevAudioInputDevice: ((deviceId: string) => void);
    switchUserAudio: SwitchUserAudioType;
    prevFacingMode: string;
    updatePrevFacingMode: ((mode: string) => void);
    switchUserVideoAlt: SwitchUserVideoAltType;
    recordStarted: boolean;
    recordResumed: boolean;
    recordStopped: boolean;
    recordPaused: boolean;
    recordingMediaOptions: string;
    defVideoID: string;
    allowed: boolean;
    updateDefVideoID: ((deviceId: string) => void);
    updatePrevVideoInputDevice: ((deviceId: string) => void);
    updateUserDefaultVideoInputDevice: ((deviceId: string) => void);
    updateIsMediaSettingsModalVisible: ((isVisible: boolean) => void);
    switchUserVideo: SwitchUserVideoType;
}

Hierarchy (view full)

Properties

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

Properties

audioDecibels

audioDecibels: AudioDecibels[]

coHostResponsibility

coHostResponsibility: CoHostResponsibility[]

coHost

coHost: string

userDefaultVideoInputDevice

userDefaultVideoInputDevice: string

videoInputs

videoInputs: MediaDeviceInfo[]

audioInputs

audioInputs: MediaDeviceInfo[]

userDefaultAudioInputDevice

userDefaultAudioInputDevice: string

isBackgroundModalVisible

isBackgroundModalVisible: boolean

updateIsBackgroundModalVisible

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

getUpdatedAllParams

getUpdatedAllParams: (() => MediaSettingsModalParameters)

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

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

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

updateAudioLevel

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

screenProducer

screenProducer: null | Producer<AppData>

OptionallocalScreenProducer

localScreenProducer?: null | Producer<AppData>

screenParams

screenParams: ProducerOptions

params

params: ProducerOptions

updateScreenProducer

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

OptionalupdateLocalScreenProducer

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

videoProducer

videoProducer: null | Producer<AppData>

OptionallocalVideoProducer

localVideoProducer?: null | Producer<AppData>

updateVideoProducer

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

OptionalupdateLocalVideoProducer

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

videoParams

videoParams: ProducerOptions

canvasStream

canvasStream: null | MediaStream

connectSendTransportVideo

connectSendTransportVideo: ConnectSendTransportVideoType

connectSendTransportScreen

connectSendTransportScreen: ConnectSendTransportScreenType

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

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)

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

participants

participants: Participant[]

allVideoStreams

allVideoStreams: (Stream | Participant)[]

member

member: string

shareScreenStarted

shareScreenStarted: boolean

eventType

eventType: EventType

OptionalscreenId

screenId?: string

forceFullDisplay

forceFullDisplay: boolean

mainScreenFilled

mainScreenFilled: boolean

adminOnMainScreen

adminOnMainScreen: boolean

mainScreenPerson

mainScreenPerson: string

oldAllStreams

oldAllStreams: (Stream | Participant)[]

checkOrientation

checkOrientation: (() => string)

screenForceFullDisplay

screenForceFullDisplay: boolean

localStreamScreen

localStreamScreen: null | MediaStream

remoteScreenStream

remoteScreenStream: Stream[]

localStreamVideo

localStreamVideo: null | MediaStream

mainHeightWidth

mainHeightWidth: number

isWideScreen

isWideScreen: boolean

localUIMode

localUIMode: boolean

whiteboardStarted

whiteboardStarted: boolean

whiteboardEnded

whiteboardEnded: boolean

virtualStream

virtualStream: null | MediaStream

keepBackground

keepBackground: 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: CustomMediaComponent[]) => void)

screenStates

screenStates: ScreenState[]

prevScreenStates

prevScreenStates: ScreenState[]

updateScreenStates

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

updatePrevScreenStates

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

compareActiveNames

compareActiveNames: CompareActiveNamesType

compareScreenStates

compareScreenStates: CompareScreenStatesType

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

audioProducer

audioProducer: null | Producer<AppData>

OptionallocalAudioProducer

localAudioProducer?: null | Producer<AppData>

socket

socket: Socket<DefaultEventsMap, DefaultEventsMap>

OptionallocalSocket

localSocket?: Socket<DefaultEventsMap, DefaultEventsMap>

roomName

roomName: string

localStream

localStream: null | MediaStream

localStreamAudio

localStreamAudio: null | MediaStream

audioParams

audioParams: ProducerOptions

audioPaused

audioPaused: boolean

audioAlreadyOn

audioAlreadyOn: boolean

transportCreated

transportCreated: boolean

OptionallocalTransportCreated

localTransportCreated?: boolean

OptionalaudioParamse

audioParamse?: ProducerCodecOptions

hostLabel

hostLabel: string

updateMainWindow

updateMainWindow: boolean

videoAlreadyOn

videoAlreadyOn: boolean

islevel

islevel: string

lock_screen

lock_screen: boolean

shared

shared: boolean

updateAudioProducer

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

OptionalupdateLocalAudioProducer

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

updateLocalStream

updateLocalStream: ((localStream: null | MediaStream) => void)

updateAudioParams

updateAudioParams: ((audioParams: ProducerOptions) => void)

updateDefAudioID

updateDefAudioID: ((defAudioID: string) => void)

updateUpdateMainWindow

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

sleep

sleep: SleepType

prepopulateUserMedia

prepopulateUserMedia: PrepopulateUserMediaType

createSendTransport

createSendTransport: CreateSendTransportType

connectSendTransportAudio

connectSendTransportAudio: ConnectSendTransportAudioType

transportCreatedVideo

transportCreatedVideo: boolean

videoAction

videoAction: boolean

OptionalvideoParamse

videoParamse?: ProducerOptions

vParams

vParams: VParamsType

hParams

hParams: HParamsType

currentFacingMode

currentFacingMode: string

appliedBackground

appliedBackground: boolean

updateTransportCreatedVideo

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

updateVideoAlreadyOn

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

updateVideoAction

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

updateLocalStreamVideo

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

updateCurrentFacingMode

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

updateAllowed

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

updateParticipants

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

updateVideoParams

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

updateAutoClickBackground

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

reorderStreams

reorderStreams: ReorderStreamsType

OptionalshowAlert

showAlert?: ShowAlert

hasAudioPermission

hasAudioPermission: boolean

streamSuccessAudioSwitch

streamSuccessAudioSwitch: StreamSuccessAudioSwitchType

requestPermissionAudio

requestPermissionAudio: RequestPermissionAudioType

checkMediaPermission

checkMediaPermission: boolean

audioOnlyRoom

audioOnlyRoom: boolean

frameRate

frameRate: number

vidCons

vidCons: VidCons

prevVideoInputDevice

prevVideoInputDevice: string

hasCameraPermission

hasCameraPermission: boolean

updateVideoSwitching

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

requestPermissionCamera

requestPermissionCamera: RequestPermissionCameraType

streamSuccessVideo

streamSuccessVideo: StreamSuccessVideoType

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

youAreCoHost

youAreCoHost: boolean

adminRestrictSetting

adminRestrictSetting: boolean

videoRequestState

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

defAudioID

defAudioID: string

prevAudioInputDevice

prevAudioInputDevice: string

updateUserDefaultAudioInputDevice

updateUserDefaultAudioInputDevice: ((deviceId: string) => void)

updatePrevAudioInputDevice

updatePrevAudioInputDevice: ((deviceId: string) => void)

switchUserAudio

switchUserAudio: SwitchUserAudioType

prevFacingMode

prevFacingMode: string

updatePrevFacingMode

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

switchUserVideoAlt

switchUserVideoAlt: SwitchUserVideoAltType

recordStarted

recordStarted: boolean

recordResumed

recordResumed: boolean

recordStopped

recordStopped: boolean

recordPaused

recordPaused: boolean

recordingMediaOptions

recordingMediaOptions: string

defVideoID

defVideoID: string

allowed

allowed: boolean

updateDefVideoID

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

updatePrevVideoInputDevice

updatePrevVideoInputDevice: ((deviceId: string) => void)

updateUserDefaultVideoInputDevice

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

updateIsMediaSettingsModalVisible

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

switchUserVideo

switchUserVideo: SwitchUserVideoType

Settings

Member Visibility

On This Page

Properties
audioDecibelscoHostResponsibilitycoHostuserDefaultVideoInputDevicevideoInputsaudioInputsuserDefaultAudioInputDeviceisBackgroundModalVisibleupdateIsBackgroundModalVisiblegetUpdatedAllParamsupdateAddAltGridotherGridStreamsupdateOtherGridStreamsupdateMiniCardsGridp_activeNamesactiveNamesdispActiveNamesnon_alVideoStreamsref_participantssortAudioLoudnessmixed_alVideoStreamsnon_alVideoStreams_mutedremoteProducerIdscreenPageLimitmeetingDisplayTypemeetingVideoOptimizedrecordingVideoOptimizedrecordingDisplayTypepaginatedStreamsitemPageLimitdoPaginateprevDoPaginatecurrentUserPagebreakoutRoomshostNewRoombreakOutRoomStartedbreakOutRoomEndedmainRoomsLengthmemberRoomupdateP_activeNamesupdateActiveNamesupdateDispActiveNamesupdateNon_alVideoStreamsupdateRef_participantsupdateSortAudioLoudnessupdateMixed_alVideoStreamsupdateNon_alVideoStreams_mutedupdatePaginatedStreamsupdateDoPaginateupdatePrevDoPaginateupdateCurrentUserPageupdateNumberPagesupdateMainRoomsLengthupdateMemberRoommixStreamsdispStreamsprevActiveNamesupdatePrevActiveNamestriggerupdateAudioLevelscreenProducerlocalScreenProducerscreenParamsparamsupdateScreenProducerupdateLocalScreenProducervideoProducerlocalVideoProducerupdateVideoProducerupdateLocalVideoProducervideoParamscanvasStreamconnectSendTransportVideoconnectSendTransportScreendeviceproducerTransportlocalProducerTransportupdateProducerTransportupdateLocalProducerTransportupdateTransportCreatedupdateLocalTransportCreatedconnectSendTransportconsumerTransportsstreamNamesaudStreamNamesprevMainHeightWidthfirstAllshareEndedp_dispActiveNamesnForReadjustRecordfirst_roundchatRefStreamsupdateLStreamsupdateChatRefStreamsupdateNForReadjustRecordupdateShowMiniViewrePortprocessConsumerTransportsresumePauseStreamsreadjustaddVideosGridgetEstimatecheckGridresumePauseAudioStreamsfixedPageLimitremoveAltGridisMediumScreenupdateRemoveAltGridcalculateRowsAndColumnsparticipantsallVideoStreamsmembershareScreenStartedeventTypescreenIdforceFullDisplaymainScreenFilledadminOnMainScreenmainScreenPersonoldAllStreamscheckOrientationscreenForceFullDisplaylocalStreamScreenremoteScreenStreamlocalStreamVideomainHeightWidthisWideScreenlocalUIModewhiteboardStartedwhiteboardEndedvirtualStreamkeepBackgroundannotateScreenStreamupdateMainScreenPersonupdateMainScreenFilledupdateAdminOnMainScreenupdateMainHeightWidthupdateScreenForceFullDisplayupdateMainGridStreamscreenStatesprevScreenStatesupdateScreenStatesupdatePrevScreenStatescompareActiveNamescompareScreenStatesadminVidIDnewLimitedStreamsnewLimitedStreamsIDsactiveSoundsscreenShareIDStreamscreenShareNameStreamadminIDStreamadminNameStreamupdateNewLimitedStreamsupdateNewLimitedStreamsIDsupdateActiveSoundsupdateScreenShareIDStreamupdateScreenShareNameStreamupdateAdminIDStreamupdateAdminNameStreamupdateYouYouStreamchangeVidsallAudioStreamslimitedBreakRoomupdateLimitedBreakRoomprocessConsumerTransportsAudioaudioProducerlocalAudioProducersocketlocalSocketroomNamelocalStreamlocalStreamAudioaudioParamsaudioPausedaudioAlreadyOntransportCreatedlocalTransportCreatedaudioParamsehostLabelupdateMainWindowvideoAlreadyOnislevellock_screensharedupdateAudioProducerupdateLocalAudioProducerupdateLocalStreamupdateAudioParamsupdateDefAudioIDupdateUpdateMainWindowsleepprepopulateUserMediacreateSendTransportconnectSendTransportAudiotransportCreatedVideovideoActionvideoParamsevParamshParamscurrentFacingModeappliedBackgroundupdateTransportCreatedVideoupdateVideoAlreadyOnupdateVideoActionupdateLocalStreamVideoupdateCurrentFacingModeupdateAllowedupdateParticipantsupdateVideoParamsupdateAutoClickBackgroundreorderStreamsshowAlerthasAudioPermissionstreamSuccessAudioSwitchrequestPermissionAudiocheckMediaPermissionaudioOnlyRoomframeRatevidConsprevVideoInputDevicehasCameraPermissionupdateVideoSwitchingrequestPermissionCamerastreamSuccessVideoupdateDateStatelastUpdatenForReadjustupdateUpdateDateStateupdateLastUpdateupdateNForReadjustautoAdjustupdateGridRowsupdateGridColsupdateAltGridRowsupdateAltGridColsupdateGridSizesgridSizespaginationDirectionpaginationHeightWidthcomponentSizesyouAreCoHostadminRestrictSettingvideoRequestStatevideoRequestTimeaudioSettingvideoSettingscreenshareSettingchatSettingupdateRequestIntervalSecondsupdateVideoRequestStatedisconnectSendTransportVideocheckPermissiondefAudioIDprevAudioInputDeviceupdateUserDefaultAudioInputDeviceupdatePrevAudioInputDeviceswitchUserAudioprevFacingModeupdatePrevFacingModeswitchUserVideoAltrecordStartedrecordResumedrecordStoppedrecordPausedrecordingMediaOptionsdefVideoIDallowedupdateDefVideoIDupdatePrevVideoInputDeviceupdateUserDefaultVideoInputDeviceupdateIsMediaSettingsModalVisibleswitchUserVideo
MMNEPVFCICPMFPCPTTAAATR