MediaSFU Shared
    Preparing search index...

    Interface SwitchUserVideoAltParameters

    interface SwitchUserVideoAltParameters {
        audioParams: ProducerOptions;
        localStreamScreen: MediaStream | null;
        canvasStream: MediaStream | null;
        whiteboardStarted: boolean;
        whiteboardEnded: boolean;
        connectSendTransportAudio: ConnectSendTransportAudioType;
        connectSendTransportScreen: ConnectSendTransportScreenType;
        audioProducer: Producer<AppData> | null;
        localAudioProducer?: Producer<AppData> | null;
        updateAudioProducer: (producer: Producer<AppData> | null) => void;
        updateLocalAudioProducer?: (
            localProducer: Producer<AppData> | null,
        ) => void;
        updateAudioLevel: (level: number) => void;
        screenProducer: Producer<AppData> | null;
        localScreenProducer?: Producer<AppData> | null;
        screenParams: ProducerOptions;
        updateScreenProducer: (producer: Producer<AppData> | null) => void;
        updateLocalScreenProducer?: (
            localProducer: Producer<AppData> | null,
        ) => void;
        localVideoProducer?: Producer<AppData> | null;
        updateVideoProducer: (producer: Producer<AppData> | null) => void;
        updateLocalVideoProducer?: (
            localProducer: Producer<AppData> | null,
        ) => void;
        localSocket?: Socket<DefaultEventsMap, DefaultEventsMap>;
        producerTransport: Transport<AppData> | null;
        localProducerTransport?: Transport<AppData> | null;
        localTransportCreated?: boolean;
        updateProducerTransport: (
            producerTransport: Transport<AppData> | null,
        ) => void;
        updateLocalProducerTransport?: (
            localTransport: Transport<AppData> | null,
        ) => void;
        updateTransportCreated: (transportCreated: boolean) => void;
        updateLocalTransportCreated?: (localTransportCreated: boolean) => void;
        connectSendTransport: ConnectSendTransportType;
        allVideoStreams: (Participant | Stream)[];
        oldAllStreams: (Participant | Stream)[];
        screenId?: string;
        adminVidID?: string;
        newLimitedStreams: (Participant | Stream)[];
        newLimitedStreamsIDs: string[];
        activeSounds: string[];
        screenShareIDStream?: string;
        screenShareNameStream?: string;
        adminIDStream?: string;
        adminNameStream?: string;
        updateNewLimitedStreams: (streams: (Participant | Stream)[]) => 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: (Participant | Stream)[]) => void;
        changeVids: ChangeVidsInvoker;
        socket: Socket;
        participants: Participant[];
        localStream: MediaStream | null;
        transportCreated: boolean;
        transportCreatedVideo: boolean;
        videoAlreadyOn: boolean;
        videoAction: boolean;
        videoParams: ProducerOptions;
        localStreamVideo: MediaStream | null;
        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 | null;
        keepBackground: boolean;
        appliedBackground: boolean;
        videoProducer: Producer<AppData> | null;
        removeSingleVideoEncoding?: boolean;
        updateTransportCreatedVideo: (created: boolean) => void;
        updateVideoAlreadyOn: (videoOn: boolean) => void;
        updateVideoAction: (videoAction: boolean) => void;
        updateLocalStream: (stream: MediaStream | null) => void;
        updateLocalStreamVideo: (stream: MediaStream | null) => 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: MediaDevices;
        hasCameraPermission: boolean;
        updateVideoSwitching: (state: boolean) => void;
        updateCurrentFacingMode: (mode: string) => void;
        requestPermissionCamera: RequestPermissionCameraType;
        streamSuccessVideo: StreamSuccessVideoType;
        sleep: SleepType;
        checkMediaPermission: boolean;
        getUpdatedAllParams: () => SwitchUserVideoAltParameters;
        recordStarted: boolean;
        recordResumed: boolean;
        recordPaused: boolean;
        recordStopped: boolean;
        recordingMediaOptions: string;
        youAreCoHost: boolean;
        adminRestrictSetting: boolean;
        videoRequestState: string | null;
        videoRequestTime: number;
        roomName: string;
        audioSetting: string;
        videoSetting: string;
        screenshareSetting: string;
        chatSetting: string;
        updateRequestIntervalSeconds: number;
        updateVideoRequestState: (state: string) => void;
        disconnectSendTransportVideo: DisconnectSendTransportVideoType;
        checkPermission: CheckPermissionType;
        [key: string]: any;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: any
    Index

    Properties

    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 allVideoStreams oldAllStreams screenId? adminVidID? newLimitedStreams newLimitedStreamsIDs activeSounds screenShareIDStream? screenShareNameStream? adminIDStream? adminNameStream? updateNewLimitedStreams updateNewLimitedStreamsIDs updateActiveSounds updateScreenShareIDStream updateScreenShareNameStream updateAdminIDStream updateAdminNameStream updateYouYouStream changeVids 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 removeSingleVideoEncoding? 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 recordStarted recordResumed recordPaused recordStopped recordingMediaOptions youAreCoHost adminRestrictSetting videoRequestState videoRequestTime roomName audioSetting videoSetting screenshareSetting chatSetting updateRequestIntervalSeconds updateVideoRequestState disconnectSendTransportVideo checkPermission

    Properties

    audioParams: ProducerOptions
    localStreamScreen: MediaStream | null
    canvasStream: MediaStream | null
    whiteboardStarted: boolean
    whiteboardEnded: boolean
    connectSendTransportAudio: ConnectSendTransportAudioType
    connectSendTransportScreen: ConnectSendTransportScreenType
    audioProducer: Producer<AppData> | null
    localAudioProducer?: Producer<AppData> | null
    updateAudioProducer: (producer: Producer<AppData> | null) => void
    updateLocalAudioProducer?: (localProducer: Producer<AppData> | null) => void
    updateAudioLevel: (level: number) => void
    screenProducer: Producer<AppData> | null
    localScreenProducer?: Producer<AppData> | null
    screenParams: ProducerOptions
    updateScreenProducer: (producer: Producer<AppData> | null) => void
    updateLocalScreenProducer?: (localProducer: Producer<AppData> | null) => void
    localVideoProducer?: Producer<AppData> | null
    updateVideoProducer: (producer: Producer<AppData> | null) => void
    updateLocalVideoProducer?: (localProducer: Producer<AppData> | null) => void
    localSocket?: Socket<DefaultEventsMap, DefaultEventsMap>
    producerTransport: Transport<AppData> | null
    localProducerTransport?: Transport<AppData> | null
    localTransportCreated?: boolean
    updateProducerTransport: (producerTransport: Transport<AppData> | null) => void
    updateLocalProducerTransport?: (
        localTransport: Transport<AppData> | null,
    ) => void
    updateTransportCreated: (transportCreated: boolean) => void
    updateLocalTransportCreated?: (localTransportCreated: boolean) => void
    connectSendTransport: ConnectSendTransportType
    allVideoStreams: (Participant | Stream)[]
    oldAllStreams: (Participant | Stream)[]
    screenId?: string
    adminVidID?: string
    newLimitedStreams: (Participant | Stream)[]
    newLimitedStreamsIDs: string[]
    activeSounds: string[]
    screenShareIDStream?: string
    screenShareNameStream?: string
    adminIDStream?: string
    adminNameStream?: string
    updateNewLimitedStreams: (streams: (Participant | Stream)[]) => 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: (Participant | Stream)[]) => void
    changeVids: ChangeVidsInvoker
    socket: Socket
    participants: Participant[]
    localStream: MediaStream | null
    transportCreated: boolean
    transportCreatedVideo: boolean
    videoAlreadyOn: boolean
    videoAction: boolean
    videoParams: ProducerOptions
    localStreamVideo: MediaStream | null
    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 | null
    keepBackground: boolean
    appliedBackground: boolean
    videoProducer: Producer<AppData> | null
    removeSingleVideoEncoding?: boolean
    updateTransportCreatedVideo: (created: boolean) => void
    updateVideoAlreadyOn: (videoOn: boolean) => void
    updateVideoAction: (videoAction: boolean) => void
    updateLocalStream: (stream: MediaStream | null) => void
    updateLocalStreamVideo: (stream: MediaStream | null) => 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: MediaDevices
    hasCameraPermission: boolean
    updateVideoSwitching: (state: boolean) => void
    updateCurrentFacingMode: (mode: string) => void
    requestPermissionCamera: RequestPermissionCameraType
    streamSuccessVideo: StreamSuccessVideoType
    sleep: SleepType
    checkMediaPermission: boolean
    getUpdatedAllParams: () => SwitchUserVideoAltParameters
    recordStarted: boolean
    recordResumed: boolean
    recordPaused: boolean
    recordStopped: boolean
    recordingMediaOptions: string
    youAreCoHost: boolean
    adminRestrictSetting: boolean
    videoRequestState: string | null
    videoRequestTime: number
    roomName: string
    audioSetting: string
    videoSetting: string
    screenshareSetting: string
    chatSetting: string
    updateRequestIntervalSeconds: number
    updateVideoRequestState: (state: string) => void
    disconnectSendTransportVideo: DisconnectSendTransportVideoType
    checkPermission: CheckPermissionType