MediaSFU Angular
    Preparing search index...

    Interface SwitchUserAudioParametersFunction

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

    The parameters object containing necessary variables.

    The new MediaStream with the switched audio device.

    interface SwitchUserAudioParameters {
        audioDecibels: AudioDecibels[];
        coHostResponsibility: CoHostResponsibility[];
        coHost: string;
        updateAudioLevel: (level: number) => void;
        screenProducer: Producer | null;
        localScreenProducer?: Producer | null;
        screenParams: ProducerOptions;
        params: ProducerOptions;
        updateScreenProducer: (producer: Producer | null) => void;
        updateLocalScreenProducer?: (localProducer: Producer | null) => void;
        videoProducer: Producer | null;
        localVideoProducer?: Producer | null;
        updateVideoProducer: (producer: Producer | null) => void;
        updateLocalVideoProducer?: (localProducer: Producer | null) => void;
        videoParams: ProducerOptions;
        canvasStream: MediaStream | null;
        connectSendTransportVideo: ConnectSendTransportVideoType;
        connectSendTransportScreen: ConnectSendTransportScreenType;
        device: Device | null;
        producerTransport: Transport | null;
        localProducerTransport?: Transport | null;
        updateProducerTransport: (producerTransport: Transport | null) => void;
        updateLocalProducerTransport?: (localTransport: Transport | null) => void;
        updateTransportCreated: (transportCreated: boolean) => void;
        updateLocalTransportCreated?: (localTransportCreated: boolean) => void;
        connectSendTransport: ConnectSendTransportType;
        participants: Participant[];
        allVideoStreams: (Participant | Stream)[];
        member: string;
        shareScreenStarted: boolean;
        eventType: EventType;
        screenId?: string;
        forceFullDisplay: boolean;
        mainScreenFilled: boolean;
        adminOnMainScreen: boolean;
        mainScreenPerson: string;
        oldAllStreams: (Participant | Stream)[];
        checkOrientation: () => string;
        screenForceFullDisplay: boolean;
        localStreamScreen: MediaStream | null;
        remoteScreenStream: Stream[];
        localStreamVideo: MediaStream | null;
        mainHeightWidth: number;
        isWideScreen: boolean;
        localUIMode: boolean;
        whiteboardStarted: boolean;
        whiteboardEnded: boolean;
        virtualStream: MediaStream | null;
        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;
        customVideoCard?: any;
        customAudioCard?: any;
        customMiniCard?: any;
        videoCardComponent?: any;
        audioCardComponent?: any;
        miniCardComponent?: any;
        audioProducer: Producer | null;
        localAudioProducer?: Producer | null;
        socket: Socket;
        localSocket?: Socket<DefaultEventsMap, DefaultEventsMap>;
        roomName: string;
        localStream: MediaStream | null;
        localStreamAudio: MediaStream | null;
        audioParams: ProducerOptions;
        audioPaused: boolean;
        audioAlreadyOn: boolean;
        transportCreated: boolean;
        localTransportCreated?: boolean;
        audioParamse?: ProducerCodecOptions;
        defAudioID: string;
        hostLabel: string;
        updateMainWindow: boolean;
        videoAlreadyOn: boolean;
        islevel: string;
        lock_screen: boolean;
        shared: boolean;
        updateAudioProducer: (audioProducer: Producer | null) => void;
        updateLocalAudioProducer?: (localAudioProducer: Producer | null) => void;
        updateLocalStream: (localStream: MediaStream | null) => void;
        updateAudioParams: (audioParams: ProducerOptions) => void;
        updateDefAudioID: (defAudioID: string) => void;
        updateUpdateMainWindow: (updateMainWindow: boolean) => void;
        sleep: SleepType;
        prepopulateUserMedia: PrepopulateUserMediaType;
        createSendTransport: CreateSendTransportType;
        connectSendTransportAudio: ConnectSendTransportAudioType;
        getUpdatedAllParams: () => StreamSuccessAudioSwitchParameters;
        userDefaultAudioInputDevice: string;
        prevAudioInputDevice: string;
        showAlert?: ShowAlert;
        hasAudioPermission: boolean;
        updateUserDefaultAudioInputDevice: (deviceId: string) => void;
        streamSuccessAudioSwitch: StreamSuccessAudioSwitchType;
        requestPermissionAudio: RequestPermissionAudioType;
        checkMediaPermission: boolean;
        [key: string]: any;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: any
    Index

    Properties

    audioDecibels coHostResponsibility coHost updateAudioLevel screenProducer localScreenProducer? screenParams params updateScreenProducer updateLocalScreenProducer? videoProducer localVideoProducer? updateVideoProducer updateLocalVideoProducer? videoParams canvasStream connectSendTransportVideo connectSendTransportScreen device producerTransport localProducerTransport? updateProducerTransport updateLocalProducerTransport? updateTransportCreated updateLocalTransportCreated? connectSendTransport 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 customVideoCard? customAudioCard? customMiniCard? videoCardComponent? audioCardComponent? miniCardComponent? audioProducer localAudioProducer? socket localSocket? roomName localStream localStreamAudio audioParams audioPaused audioAlreadyOn transportCreated localTransportCreated? audioParamse? defAudioID hostLabel updateMainWindow videoAlreadyOn islevel lock_screen shared updateAudioProducer updateLocalAudioProducer? updateLocalStream updateAudioParams updateDefAudioID updateUpdateMainWindow sleep prepopulateUserMedia createSendTransport connectSendTransportAudio getUpdatedAllParams userDefaultAudioInputDevice prevAudioInputDevice showAlert? hasAudioPermission updateUserDefaultAudioInputDevice streamSuccessAudioSwitch requestPermissionAudio checkMediaPermission

    Properties

    audioDecibels: AudioDecibels[]
    coHostResponsibility: CoHostResponsibility[]
    coHost: string
    updateAudioLevel: (level: number) => void
    screenProducer: Producer | null
    localScreenProducer?: Producer | null
    screenParams: ProducerOptions
    params: ProducerOptions
    updateScreenProducer: (producer: Producer | null) => void
    updateLocalScreenProducer?: (localProducer: Producer | null) => void
    videoProducer: Producer | null
    localVideoProducer?: Producer | null
    updateVideoProducer: (producer: Producer | null) => void
    updateLocalVideoProducer?: (localProducer: Producer | null) => void
    videoParams: ProducerOptions
    canvasStream: MediaStream | null
    connectSendTransportVideo: ConnectSendTransportVideoType
    connectSendTransportScreen: ConnectSendTransportScreenType
    device: Device | null
    producerTransport: Transport | null
    localProducerTransport?: Transport | null
    updateProducerTransport: (producerTransport: Transport | null) => void
    updateLocalProducerTransport?: (localTransport: Transport | null) => void
    updateTransportCreated: (transportCreated: boolean) => void
    updateLocalTransportCreated?: (localTransportCreated: boolean) => void
    connectSendTransport: ConnectSendTransportType
    participants: Participant[]
    allVideoStreams: (Participant | Stream)[]
    member: string
    shareScreenStarted: boolean
    eventType: EventType
    screenId?: string
    forceFullDisplay: boolean
    mainScreenFilled: boolean
    adminOnMainScreen: boolean
    mainScreenPerson: string
    oldAllStreams: (Participant | Stream)[]
    checkOrientation: () => string
    screenForceFullDisplay: boolean
    localStreamScreen: MediaStream | null
    remoteScreenStream: Stream[]
    localStreamVideo: MediaStream | null
    mainHeightWidth: number
    isWideScreen: boolean
    localUIMode: boolean
    whiteboardStarted: boolean
    whiteboardEnded: boolean
    virtualStream: MediaStream | null
    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
    customVideoCard?: any
    customAudioCard?: any
    customMiniCard?: any
    videoCardComponent?: any
    audioCardComponent?: any
    miniCardComponent?: any
    audioProducer: Producer | null
    localAudioProducer?: Producer | null
    socket: Socket
    localSocket?: Socket<DefaultEventsMap, DefaultEventsMap>
    roomName: string
    localStream: MediaStream | null
    localStreamAudio: MediaStream | null
    audioParams: ProducerOptions
    audioPaused: boolean
    audioAlreadyOn: boolean
    transportCreated: boolean
    localTransportCreated?: boolean
    audioParamse?: ProducerCodecOptions
    defAudioID: string
    hostLabel: string
    updateMainWindow: boolean
    videoAlreadyOn: boolean
    islevel: string
    lock_screen: boolean
    shared: boolean
    updateAudioProducer: (audioProducer: Producer | null) => void
    updateLocalAudioProducer?: (localAudioProducer: Producer | null) => void
    updateLocalStream: (localStream: MediaStream | null) => void
    updateAudioParams: (audioParams: ProducerOptions) => void
    updateDefAudioID: (defAudioID: string) => void
    updateUpdateMainWindow: (updateMainWindow: boolean) => void
    sleep: SleepType
    prepopulateUserMedia: PrepopulateUserMediaType
    createSendTransport: CreateSendTransportType
    connectSendTransportAudio: ConnectSendTransportAudioType
    getUpdatedAllParams: () => StreamSuccessAudioSwitchParameters
    userDefaultAudioInputDevice: string
    prevAudioInputDevice: string
    showAlert?: ShowAlert
    hasAudioPermission: boolean
    updateUserDefaultAudioInputDevice: (deviceId: string) => void
    streamSuccessAudioSwitch: StreamSuccessAudioSwitchType
    requestPermissionAudio: RequestPermissionAudioType
    checkMediaPermission: boolean