MediaSFU React Native
    Preparing search index...

    Interface SwitchUserAudioParameters

    Parameters consumed by AudioCard to reflect live meeting state and permissions.

    AudioCardParameters

    Telemetry & Participants:

    interface SwitchUserAudioParameters {
        audioDecibels: AudioDecibels[];
        coHostResponsibility: CoHostResponsibility[];
        coHost: string;
        videoParams: ProducerOptions;
        canvasStream: MediaStream;
        connectSendTransportVideo: ConnectSendTransportVideoType;
        connectSendTransportScreen: ConnectSendTransportScreenType;
        updateAudioLevel: (level: number) => void;
        screenProducer: Producer<AppData>;
        localScreenProducer?: Producer<AppData>;
        screenParams: ProducerOptions;
        params: ProducerOptions;
        updateScreenProducer: (producer: Producer<AppData>) => void;
        updateLocalScreenProducer?: (localProducer: Producer<AppData>) => void;
        videoProducer: Producer<AppData>;
        localVideoProducer?: Producer<AppData>;
        updateVideoProducer: (producer: Producer<AppData>) => void;
        updateLocalVideoProducer?: (localProducer: Producer<AppData>) => void;
        device: Device;
        producerTransport: Transport<AppData>;
        localProducerTransport?: Transport<AppData>;
        updateProducerTransport: (producerTransport: Transport<AppData>) => void;
        updateLocalProducerTransport?: (localTransport: Transport<AppData>) => void;
        updateTransportCreated: (transportCreated: boolean) => void;
        updateLocalTransportCreated?: (localTransportCreated: boolean) => void;
        connectSendTransport: ConnectSendTransportType;
        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: MediaStream;
        remoteScreenStream: Stream[];
        localStreamVideo: MediaStream;
        mainHeightWidth: number;
        isWideScreen: boolean;
        localUIMode: boolean;
        whiteboardStarted: boolean;
        whiteboardEnded: boolean;
        virtualStream: 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: Element[]) => void;
        customVideoCard?: CustomVideoCardType;
        customAudioCard?: CustomAudioCardType;
        customMiniCard?: CustomMiniCardType;
        videoCardComponent?: ComponentType<VideoCardOptions>;
        audioCardComponent?: ComponentType<AudioCardOptions>;
        miniCardComponent?: ComponentType<MiniCardOptions>;
        audioProducer: Producer<AppData>;
        localAudioProducer?: Producer<AppData>;
        socket: Socket;
        localSocket?: Socket;
        roomName: string;
        localStream: MediaStream;
        localStreamAudio: MediaStream;
        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<AppData>) => void;
        updateLocalAudioProducer?: (localAudioProducer: Producer<AppData>) => void;
        updateLocalStream: (localStream: MediaStream) => void;
        updateAudioParams: (audioParams: ProducerOptions) => void;
        updateDefAudioID: (defAudioID: string) => void;
        updateUpdateMainWindow: (updateMainWindow: boolean) => void;
        sleep: SleepType;
        prepopulateUserMedia: PrepopulateUserMediaType;
        createSendTransport: CreateSendTransportType;
        connectSendTransportAudio: ConnectSendTransportAudioType;
        getUpdatedAllParams: () => StreamSuccessAudioSwitchParameters;
        mediaDevices: {
            getUserMedia: (
                constraints: MediaStreamConstraints,
            ) => Promise<MediaStream>;
            getDisplayMedia: (
                constraints: MediaStreamConstraints,
            ) => Promise<MediaStream>;
            enumerateDevices: () => Promise<MediaDeviceInfo[]>;
        };
        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 videoParams canvasStream connectSendTransportVideo connectSendTransportScreen updateAudioLevel screenProducer localScreenProducer? screenParams params updateScreenProducer updateLocalScreenProducer? videoProducer localVideoProducer? updateVideoProducer updateLocalVideoProducer? 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 mediaDevices userDefaultAudioInputDevice prevAudioInputDevice showAlert? hasAudioPermission updateUserDefaultAudioInputDevice streamSuccessAudioSwitch requestPermissionAudio checkMediaPermission

    Properties

    audioDecibels: AudioDecibels[]

    Live loudness metrics per participant.

    coHostResponsibility: CoHostResponsibility[]

    Active co-host capabilities.

    coHost: string

    Current co-host identifier.

    videoParams: ProducerOptions
    canvasStream: MediaStream
    connectSendTransportVideo: ConnectSendTransportVideoType
    connectSendTransportScreen: ConnectSendTransportScreenType
    updateAudioLevel: (level: number) => void
    screenProducer: Producer<AppData>
    localScreenProducer?: Producer<AppData>
    screenParams: ProducerOptions
    params: ProducerOptions
    updateScreenProducer: (producer: Producer<AppData>) => void
    updateLocalScreenProducer?: (localProducer: Producer<AppData>) => void
    videoProducer: Producer<AppData>
    localVideoProducer?: Producer<AppData>
    updateVideoProducer: (producer: Producer<AppData>) => void
    updateLocalVideoProducer?: (localProducer: Producer<AppData>) => void
    device: Device
    producerTransport: Transport<AppData>
    localProducerTransport?: Transport<AppData>
    updateProducerTransport: (producerTransport: Transport<AppData>) => void
    updateLocalProducerTransport?: (localTransport: Transport<AppData>) => void
    updateTransportCreated: (transportCreated: boolean) => void
    updateLocalTransportCreated?: (localTransportCreated: boolean) => void
    connectSendTransport: ConnectSendTransportType
    participants: Participant[]

    Current participant roster.

    Session Context:

    allVideoStreams: (Stream | Participant)[]
    member: string

    Local member identifier.

    shareScreenStarted: boolean
    eventType: EventType

    Meeting event type (e.g., conference).

    Helpers:

    screenId?: string
    forceFullDisplay: boolean
    mainScreenFilled: boolean
    adminOnMainScreen: boolean
    mainScreenPerson: string
    oldAllStreams: (Stream | Participant)[]
    checkOrientation: () => string
    screenForceFullDisplay: boolean
    localStreamScreen: MediaStream
    remoteScreenStream: Stream[]
    localStreamVideo: MediaStream
    mainHeightWidth: number
    isWideScreen: boolean
    localUIMode: boolean
    whiteboardStarted: boolean
    whiteboardEnded: boolean
    virtualStream: 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: Element[]) => void
    customVideoCard?: CustomVideoCardType
    customAudioCard?: CustomAudioCardType
    customMiniCard?: CustomMiniCardType
    videoCardComponent?: ComponentType<VideoCardOptions>
    audioCardComponent?: ComponentType<AudioCardOptions>
    miniCardComponent?: ComponentType<MiniCardOptions>
    audioProducer: Producer<AppData>
    localAudioProducer?: Producer<AppData>
    socket: Socket

    Socket instance for media control events.

    localSocket?: Socket
    roomName: string

    Active room identifier.

    localStream: MediaStream
    localStreamAudio: MediaStream
    audioParams: ProducerOptions
    audioPaused: boolean
    audioAlreadyOn: boolean
    transportCreated: boolean
    localTransportCreated?: boolean
    audioParamse?: ProducerCodecOptions
    defAudioID: string
    hostLabel: string
    updateMainWindow: boolean
    videoAlreadyOn: boolean
    islevel: string

    Member privilege level.

    lock_screen: boolean
    shared: boolean
    updateAudioProducer: (audioProducer: Producer<AppData>) => void
    updateLocalAudioProducer?: (localAudioProducer: Producer<AppData>) => void
    updateLocalStream: (localStream: MediaStream) => void
    updateAudioParams: (audioParams: ProducerOptions) => void
    updateDefAudioID: (defAudioID: string) => void
    updateUpdateMainWindow: (updateMainWindow: boolean) => void
    sleep: SleepType
    prepopulateUserMedia: PrepopulateUserMediaType
    createSendTransport: CreateSendTransportType
    connectSendTransportAudio: ConnectSendTransportAudioType
    getUpdatedAllParams: () => StreamSuccessAudioSwitchParameters

    Refreshes parameters before invoking side effects.

    mediaDevices: {
        getUserMedia: (
            constraints: MediaStreamConstraints,
        ) => Promise<MediaStream>;
        getDisplayMedia: (
            constraints: MediaStreamConstraints,
        ) => Promise<MediaStream>;
        enumerateDevices: () => Promise<MediaDeviceInfo[]>;
    }
    userDefaultAudioInputDevice: string
    prevAudioInputDevice: string
    showAlert?: ShowAlert

    Optional alert helper.

    hasAudioPermission: boolean
    updateUserDefaultAudioInputDevice: (deviceId: string) => void
    streamSuccessAudioSwitch: StreamSuccessAudioSwitchType
    requestPermissionAudio: RequestPermissionAudioType
    checkMediaPermission: boolean