MediaSFU Shared
    Preparing search index...

    Interface StartShareScreenParameters

    interface StartShareScreenParameters {
        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;
        whiteboardStarted: boolean;
        whiteboardEnded: boolean;
        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;
        screenProducer: Producer<AppData> | null;
        localScreenProducer?: Producer<AppData> | null;
        screenParams: ProducerOptions;
        params: ProducerOptions;
        updateScreenProducer: (producer: Producer<AppData> | null) => void;
        updateLocalScreenProducer?: (
            localProducer: Producer<AppData> | null,
        ) => void;
        videoProducer: Producer<AppData> | null;
        localVideoProducer?: Producer<AppData> | null;
        updateMainWindow: boolean;
        updateVideoProducer: (producer: Producer<AppData> | null) => void;
        updateLocalVideoProducer?: (
            localProducer: Producer<AppData> | null,
        ) => void;
        updateUpdateMainWindow: (state: boolean) => void;
        islevel: string;
        member: string;
        localSocket?: Socket<DefaultEventsMap, DefaultEventsMap>;
        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;
        roomName: string;
        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;
        shared: boolean;
        showAlert?: ShowAlert;
        updateShared: (shared: boolean) => void;
        mediaDevices: MediaDevices;
        onWeb: boolean;
        targetWidth?: number;
        targetHeight?: number;
        streamSuccessScreen: StreamSuccessScreenType;
        shareScreenStarted: boolean;
        shareEnded: boolean;
        defer_receive: boolean;
        lock_screen: boolean;
        forceFullDisplay: boolean;
        firstAll: boolean;
        first_round: boolean;
        prevForceFullDisplay: boolean;
        updateShareScreenStarted: (shareScreenStarted: boolean) => void;
        updateShareEnded: (shareEnded: 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;
        updateMainHeightWidth: (mainHeightWidth: number) => void;
        updateAnnotateScreenStream: (annotateScreenStream: boolean) => void;
        getVideos: GetVideosType;
        socket: Socket;
        transportCreated: boolean;
        localStreamScreen: MediaStream | null;
        screenAlreadyOn: boolean;
        screenAction: boolean;
        transportCreatedScreen: boolean;
        hostLabel: string;
        eventType: EventType;
        annotateScreenStream: boolean;
        updateTransportCreatedScreen: (transportCreatedScreen: boolean) => void;
        updateScreenAlreadyOn: (screenAlreadyOn: boolean) => void;
        updateScreenAction: (screenAction: boolean) => void;
        updateTransportCreated: (transportCreated: boolean) => void;
        updateLocalStreamScreen: (localStreamScreen: MediaStream | null) => void;
        updateIsScreenboardModalVisible: (isVisible: boolean) => void;
        sleep: SleepType;
        createSendTransport: CreateSendTransportType;
        connectSendTransportScreen: ConnectSendTransportScreenType;
        disconnectSendTransportScreen: DisconnectSendTransportScreenType;
        stopShareScreen: StopShareScreenType;
        reorderStreams: ReorderStreamsType;
        prepopulateUserMedia: PrepopulateUserMediaType;
        rePort: RePortType;
        getUpdatedAllParams: () => StreamSuccessScreenParameters;
        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

    prevActiveNames updateActiveNames updatePrevActiveNames recordingDisplayType recordingVideoOptimized activeNames trigger audioParams videoParams canvasStream whiteboardStarted whiteboardEnded connectSendTransportAudio connectSendTransportVideo audioProducer localAudioProducer? updateAudioProducer updateLocalAudioProducer? updateAudioLevel screenProducer localScreenProducer? screenParams params updateScreenProducer updateLocalScreenProducer? videoProducer localVideoProducer? updateMainWindow updateVideoProducer updateLocalVideoProducer? updateUpdateMainWindow islevel member localSocket? device producerTransport localProducerTransport? localTransportCreated? updateProducerTransport updateLocalProducerTransport? updateLocalTransportCreated? connectSendTransport roomName 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 shared showAlert? updateShared mediaDevices onWeb targetWidth? targetHeight? streamSuccessScreen shareScreenStarted shareEnded defer_receive lock_screen forceFullDisplay firstAll first_round prevForceFullDisplay updateShareScreenStarted updateShareEnded updateDefer_receive updateLock_screen updateForceFullDisplay updateFirstAll updateFirst_round updateMainHeightWidth updateAnnotateScreenStream getVideos socket transportCreated localStreamScreen screenAlreadyOn screenAction transportCreatedScreen hostLabel eventType annotateScreenStream updateTransportCreatedScreen updateScreenAlreadyOn updateScreenAction updateTransportCreated updateLocalStreamScreen updateIsScreenboardModalVisible sleep createSendTransport connectSendTransportScreen disconnectSendTransportScreen stopShareScreen reorderStreams prepopulateUserMedia rePort getUpdatedAllParams updateDateState? lastUpdate nForReadjust updateUpdateDateState updateLastUpdate updateNForReadjust autoAdjust

    Properties

    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
    whiteboardStarted: boolean
    whiteboardEnded: boolean
    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
    screenProducer: Producer<AppData> | null
    localScreenProducer?: Producer<AppData> | null
    screenParams: ProducerOptions
    params: ProducerOptions
    updateScreenProducer: (producer: Producer<AppData> | null) => void
    updateLocalScreenProducer?: (localProducer: Producer<AppData> | null) => void
    videoProducer: Producer<AppData> | null
    localVideoProducer?: Producer<AppData> | null
    updateMainWindow: boolean
    updateVideoProducer: (producer: Producer<AppData> | null) => void
    updateLocalVideoProducer?: (localProducer: Producer<AppData> | null) => void
    updateUpdateMainWindow: (state: boolean) => void
    islevel: string
    member: string
    localSocket?: Socket<DefaultEventsMap, DefaultEventsMap>
    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
    roomName: string
    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
    shared: boolean
    showAlert?: ShowAlert
    updateShared: (shared: boolean) => void
    mediaDevices: MediaDevices
    onWeb: boolean
    targetWidth?: number
    targetHeight?: number
    streamSuccessScreen: StreamSuccessScreenType
    shareScreenStarted: boolean
    shareEnded: boolean
    defer_receive: boolean
    lock_screen: boolean
    forceFullDisplay: boolean
    firstAll: boolean
    first_round: boolean
    prevForceFullDisplay: boolean
    updateShareScreenStarted: (shareScreenStarted: boolean) => void
    updateShareEnded: (shareEnded: 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
    updateMainHeightWidth: (mainHeightWidth: number) => void
    updateAnnotateScreenStream: (annotateScreenStream: boolean) => void
    getVideos: GetVideosType
    socket: Socket
    transportCreated: boolean
    localStreamScreen: MediaStream | null
    screenAlreadyOn: boolean
    screenAction: boolean
    transportCreatedScreen: boolean
    hostLabel: string
    eventType: EventType
    annotateScreenStream: boolean
    updateTransportCreatedScreen: (transportCreatedScreen: boolean) => void
    updateScreenAlreadyOn: (screenAlreadyOn: boolean) => void
    updateScreenAction: (screenAction: boolean) => void
    updateTransportCreated: (transportCreated: boolean) => void
    updateLocalStreamScreen: (localStreamScreen: MediaStream | null) => void
    updateIsScreenboardModalVisible: (isVisible: boolean) => void
    sleep: SleepType
    createSendTransport: CreateSendTransportType
    connectSendTransportScreen: ConnectSendTransportScreenType
    disconnectSendTransportScreen: DisconnectSendTransportScreenType
    stopShareScreen: StopShareScreenType
    reorderStreams: ReorderStreamsType
    prepopulateUserMedia: PrepopulateUserMediaType
    rePort: RePortType
    getUpdatedAllParams: () => StreamSuccessScreenParameters
    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