MediaSFU Shared
    Preparing search index...

    Interface CheckScreenShareParameters

    interface CheckScreenShareParameters {
        shared: boolean;
        whiteboardStarted: boolean;
        whiteboardEnded: boolean;
        breakOutRoomStarted: boolean;
        breakOutRoomEnded: boolean;
        showAlert?: ShowAlert;
        stopShareScreen: StopShareScreenType;
        requestScreenShare: RequestScreenShareType;
        getUpdatedAllParams: () => CheckScreenShareParameters;
        prevActiveNames: string[];
        updateActiveNames: (activeNames: string[]) => void;
        updatePrevActiveNames: (prevActiveNames: string[]) => void;
        recordingDisplayType: "video" | "media" | "all";
        recordingVideoOptimized: boolean;
        activeNames: string[];
        trigger: TriggerType;
        audioParams: ProducerOptions;
        videoParams: ProducerOptions;
        canvasStream: MediaStream | null;
        connectSendTransportAudio: ConnectSendTransportAudioType;
        connectSendTransportVideo: ConnectSendTransportVideoType;
        audioProducer: Producer<AppData> | null;
        localAudioProducer?: Producer<AppData> | null;
        updateAudioProducer: (producer: Producer<AppData> | null) => void;
        updateLocalAudioProducer?: (
            localProducer: Producer<AppData> | null,
        ) => void;
        updateAudioLevel: (level: number) => void;
        localScreenProducer?: Producer<AppData> | null;
        screenParams: ProducerOptions;
        params: ProducerOptions;
        videoProducer: Producer<AppData> | null;
        localVideoProducer?: Producer<AppData> | null;
        updateVideoProducer: (producer: Producer<AppData> | null) => void;
        updateLocalVideoProducer?: (
            localProducer: Producer<AppData> | null,
        ) => void;
        islevel: string;
        member: string;
        device: Device | null;
        producerTransport: Transport<AppData> | null;
        localProducerTransport?: Transport<AppData> | null;
        localTransportCreated?: boolean;
        updateProducerTransport: (
            producerTransport: Transport<AppData> | null,
        ) => void;
        updateLocalProducerTransport?: (
            localTransport: Transport<AppData> | null,
        ) => void;
        updateLocalTransportCreated?: (localTransportCreated: boolean) => void;
        connectSendTransport: ConnectSendTransportType;
        screenProducer: Producer<AppData> | null;
        socket: Socket;
        localSocket?: Socket<DefaultEventsMap, DefaultEventsMap>;
        roomName: string;
        updateScreenProducer: (screenProducer: Producer<AppData> | null) => void;
        updateLocalScreenProducer?: (
            localScreenProducer: Producer<AppData> | null,
        ) => void;
        mainScreenPerson: string;
        adminOnMainScreen: boolean;
        mainScreenFilled: boolean;
        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: (Participant | Stream)[];
        participants: Participant[];
        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;
        localUIMode: boolean;
        targetResolution?: string;
        targetResolutionHost?: string;
        startShareScreen: StartShareScreenType;
        mediaDevices: MediaDevices;
        onWeb: boolean;
        targetWidth?: number;
        targetHeight?: number;
        streamSuccessScreen: StreamSuccessScreenType;
        shareScreenStarted: boolean;
        shareEnded: boolean;
        updateMainWindow: boolean;
        defer_receive: boolean;
        hostLabel: string;
        lock_screen: boolean;
        forceFullDisplay: boolean;
        firstAll: boolean;
        first_round: boolean;
        localStreamScreen: MediaStream | null;
        eventType: EventType;
        prevForceFullDisplay: boolean;
        annotateScreenStream: boolean;
        updateShared: (shared: boolean) => void;
        updateShareScreenStarted: (shareScreenStarted: boolean) => void;
        updateShareEnded: (shareEnded: boolean) => void;
        updateUpdateMainWindow: (updateMainWindow: boolean) => void;
        updateDefer_receive: (defer_receive: boolean) => void;
        updateLock_screen: (lock_screen: boolean) => void;
        updateForceFullDisplay: (forceFullDisplay: boolean) => void;
        updateFirstAll: (firstAll: boolean) => void;
        updateFirst_round: (first_round: boolean) => void;
        updateLocalStreamScreen: (localStreamScreen: MediaStream | null) => void;
        updateMainHeightWidth: (mainHeightWidth: number) => void;
        updateAnnotateScreenStream: (annotateScreenStream: boolean) => void;
        updateIsScreenboardModalVisible: (isVisible: boolean) => void;
        disconnectSendTransportScreen: DisconnectSendTransportScreenType;
        prepopulateUserMedia: PrepopulateUserMediaType;
        reorderStreams: ReorderStreamsType;
        getVideos: GetVideosType;
        transportCreated: boolean;
        screenAlreadyOn: boolean;
        screenAction: boolean;
        transportCreatedScreen: boolean;
        updateTransportCreatedScreen: (transportCreatedScreen: boolean) => void;
        updateScreenAlreadyOn: (screenAlreadyOn: boolean) => void;
        updateScreenAction: (screenAction: boolean) => void;
        updateTransportCreated: (transportCreated: boolean) => void;
        sleep: SleepType;
        createSendTransport: CreateSendTransportType;
        connectSendTransportScreen: ConnectSendTransportScreenType;
        rePort: RePortType;
        updateDateState?: number | null;
        lastUpdate: number | null;
        nForReadjust: number | null;
        updateUpdateDateState: (timestamp: number | null) => void;
        updateLastUpdate: (lastUpdate: number | null) => void;
        updateNForReadjust: (nForReadjust: number) => void;
        autoAdjust: AutoAdjustType;
        [key: string]: any;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: any
    Index

    Properties

    shared whiteboardStarted whiteboardEnded breakOutRoomStarted breakOutRoomEnded showAlert? stopShareScreen requestScreenShare getUpdatedAllParams prevActiveNames updateActiveNames updatePrevActiveNames recordingDisplayType recordingVideoOptimized activeNames trigger audioParams videoParams canvasStream connectSendTransportAudio connectSendTransportVideo audioProducer localAudioProducer? updateAudioProducer updateLocalAudioProducer? updateAudioLevel localScreenProducer? screenParams params videoProducer localVideoProducer? updateVideoProducer updateLocalVideoProducer? islevel member device producerTransport localProducerTransport? localTransportCreated? updateProducerTransport updateLocalProducerTransport? updateLocalTransportCreated? connectSendTransport screenProducer socket localSocket? roomName updateScreenProducer updateLocalScreenProducer? mainScreenPerson adminOnMainScreen mainScreenFilled recordStarted recordStopped recordPaused recordResumed screenStates prevScreenStates updateScreenStates updatePrevScreenStates compareActiveNames compareScreenStates allVideoStreams participants oldAllStreams screenId? adminVidID? newLimitedStreams newLimitedStreamsIDs activeSounds screenShareIDStream? screenShareNameStream? adminIDStream? adminNameStream? updateNewLimitedStreams updateNewLimitedStreamsIDs updateActiveSounds updateScreenShareIDStream updateScreenShareNameStream updateAdminIDStream updateAdminNameStream updateYouYouStream changeVids localUIMode targetResolution? targetResolutionHost? startShareScreen mediaDevices onWeb targetWidth? targetHeight? streamSuccessScreen shareScreenStarted shareEnded updateMainWindow defer_receive hostLabel lock_screen forceFullDisplay firstAll first_round localStreamScreen eventType prevForceFullDisplay annotateScreenStream updateShared updateShareScreenStarted updateShareEnded updateUpdateMainWindow updateDefer_receive updateLock_screen updateForceFullDisplay updateFirstAll updateFirst_round updateLocalStreamScreen updateMainHeightWidth updateAnnotateScreenStream updateIsScreenboardModalVisible disconnectSendTransportScreen prepopulateUserMedia reorderStreams getVideos transportCreated screenAlreadyOn screenAction transportCreatedScreen updateTransportCreatedScreen updateScreenAlreadyOn updateScreenAction updateTransportCreated sleep createSendTransport connectSendTransportScreen rePort updateDateState? lastUpdate nForReadjust updateUpdateDateState updateLastUpdate updateNForReadjust autoAdjust

    Properties

    shared: boolean
    whiteboardStarted: boolean
    whiteboardEnded: boolean
    breakOutRoomStarted: boolean
    breakOutRoomEnded: boolean
    showAlert?: ShowAlert
    stopShareScreen: StopShareScreenType
    requestScreenShare: RequestScreenShareType
    getUpdatedAllParams: () => CheckScreenShareParameters
    prevActiveNames: string[]
    updateActiveNames: (activeNames: string[]) => void
    updatePrevActiveNames: (prevActiveNames: string[]) => void
    recordingDisplayType: "video" | "media" | "all"
    recordingVideoOptimized: boolean
    activeNames: string[]
    trigger: TriggerType
    audioParams: ProducerOptions
    videoParams: ProducerOptions
    canvasStream: MediaStream | null
    connectSendTransportAudio: ConnectSendTransportAudioType
    connectSendTransportVideo: ConnectSendTransportVideoType
    audioProducer: Producer<AppData> | null
    localAudioProducer?: Producer<AppData> | null
    updateAudioProducer: (producer: Producer<AppData> | null) => void
    updateLocalAudioProducer?: (localProducer: Producer<AppData> | null) => void
    updateAudioLevel: (level: number) => void
    localScreenProducer?: Producer<AppData> | null
    screenParams: ProducerOptions
    params: ProducerOptions
    videoProducer: Producer<AppData> | null
    localVideoProducer?: Producer<AppData> | null
    updateVideoProducer: (producer: Producer<AppData> | null) => void
    updateLocalVideoProducer?: (localProducer: Producer<AppData> | null) => void
    islevel: string
    member: string
    device: Device | null
    producerTransport: Transport<AppData> | null
    localProducerTransport?: Transport<AppData> | null
    localTransportCreated?: boolean
    updateProducerTransport: (producerTransport: Transport<AppData> | null) => void
    updateLocalProducerTransport?: (
        localTransport: Transport<AppData> | null,
    ) => void
    updateLocalTransportCreated?: (localTransportCreated: boolean) => void
    connectSendTransport: ConnectSendTransportType
    screenProducer: Producer<AppData> | null
    socket: Socket
    localSocket?: Socket<DefaultEventsMap, DefaultEventsMap>
    roomName: string
    updateScreenProducer: (screenProducer: Producer<AppData> | null) => void
    updateLocalScreenProducer?: (
        localScreenProducer: Producer<AppData> | null,
    ) => void
    mainScreenPerson: string
    adminOnMainScreen: boolean
    mainScreenFilled: boolean
    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: (Participant | Stream)[]
    participants: Participant[]
    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
    localUIMode: boolean
    targetResolution?: string
    targetResolutionHost?: string
    startShareScreen: StartShareScreenType
    mediaDevices: MediaDevices
    onWeb: boolean
    targetWidth?: number
    targetHeight?: number
    streamSuccessScreen: StreamSuccessScreenType
    shareScreenStarted: boolean
    shareEnded: boolean
    updateMainWindow: boolean
    defer_receive: boolean
    hostLabel: string
    lock_screen: boolean
    forceFullDisplay: boolean
    firstAll: boolean
    first_round: boolean
    localStreamScreen: MediaStream | null
    eventType: EventType
    prevForceFullDisplay: boolean
    annotateScreenStream: boolean
    updateShared: (shared: boolean) => void
    updateShareScreenStarted: (shareScreenStarted: boolean) => void
    updateShareEnded: (shareEnded: boolean) => void
    updateUpdateMainWindow: (updateMainWindow: boolean) => void
    updateDefer_receive: (defer_receive: boolean) => void
    updateLock_screen: (lock_screen: boolean) => void
    updateForceFullDisplay: (forceFullDisplay: boolean) => void
    updateFirstAll: (firstAll: boolean) => void
    updateFirst_round: (first_round: boolean) => void
    updateLocalStreamScreen: (localStreamScreen: MediaStream | null) => void
    updateMainHeightWidth: (mainHeightWidth: number) => void
    updateAnnotateScreenStream: (annotateScreenStream: boolean) => void
    updateIsScreenboardModalVisible: (isVisible: boolean) => void
    disconnectSendTransportScreen: DisconnectSendTransportScreenType
    prepopulateUserMedia: PrepopulateUserMediaType
    reorderStreams: ReorderStreamsType
    getVideos: GetVideosType
    transportCreated: boolean
    screenAlreadyOn: boolean
    screenAction: boolean
    transportCreatedScreen: boolean
    updateTransportCreatedScreen: (transportCreatedScreen: boolean) => void
    updateScreenAlreadyOn: (screenAlreadyOn: boolean) => void
    updateScreenAction: (screenAction: boolean) => void
    updateTransportCreated: (transportCreated: boolean) => void
    sleep: SleepType
    createSendTransport: CreateSendTransportType
    connectSendTransportScreen: ConnectSendTransportScreenType
    rePort: RePortType
    updateDateState?: number | null
    lastUpdate: number | null
    nForReadjust: number | null
    updateUpdateDateState: (timestamp: number | null) => void
    updateLastUpdate: (lastUpdate: number | null) => void
    updateNForReadjust: (nForReadjust: number) => void
    autoAdjust: AutoAdjustType