MediaSFU React Native
    Preparing search index...

    Interface ClickAudioParameters

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

    AudioCardParameters

    Telemetry & Participants:

    interface ClickAudioParameters {
        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;
        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>;
        localTransportCreated?: boolean;
        updateProducerTransport: (producerTransport: Transport<AppData>) => void;
        updateLocalProducerTransport?: (localTransport: Transport<AppData>) => void;
        updateLocalTransportCreated?: (localTransportCreated: boolean) => void;
        connectSendTransport: ConnectSendTransportType;
        audioProducer: Producer<AppData>;
        localAudioProducer?: Producer<AppData>;
        videoAlreadyOn: boolean;
        lock_screen: boolean;
        shared: boolean;
        updateMainWindow: boolean;
        hostLabel: string;
        updateAudioProducer: (audioProducer: Producer<AppData>) => void;
        updateLocalAudioProducer?: (localAudioProducer: Producer<AppData>) => void;
        updateUpdateMainWindow: (updateMainWindow: boolean) => void;
        prepopulateUserMedia: PrepopulateUserMediaType;
        allVideoStreams: (Stream | Participant)[];
        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>;
        prepopulateLocalUserMedia?: PrepopulateUserMediaType;
        audioParams: ProducerOptions;
        localStreamAudio: MediaStream;
        defAudioID: string;
        params: ProducerOptions;
        audioParamse?: ProducerOptions;
        aParams: ProducerOptions;
        updateAudioParams: (audioParams: ProducerOptions) => void;
        updateLocalStreamAudio: (localStreamAudio: MediaStream) => void;
        updateDefAudioID: (defAudioID: string) => void;
        updateUserDefaultAudioInputDevice: (
            userDefaultAudioInputDevice: string,
        ) => void;
        createSendTransport: CreateSendTransportType;
        connectSendTransportAudio: ConnectSendTransportAudioType;
        checkMediaPermission: boolean;
        hasAudioPermission: boolean;
        audioPaused: boolean;
        audioAlreadyOn: boolean;
        audioOnlyRoom: boolean;
        recordStarted: boolean;
        recordResumed: boolean;
        recordPaused: boolean;
        recordStopped: boolean;
        recordingMediaOptions: string;
        islevel: string;
        youAreCoHost: boolean;
        adminRestrictSetting: boolean;
        audioRequestState: string;
        audioRequestTime: number;
        member: string;
        socket: Socket;
        localSocket?: Socket;
        roomName: string;
        userDefaultAudioInputDevice: string;
        micAction: boolean;
        localStream: MediaStream;
        audioSetting: string;
        videoSetting: string;
        screenshareSetting: string;
        chatSetting: string;
        updateRequestIntervalSeconds: number;
        participants: Participant[];
        mediaDevices: {
            getUserMedia: (
                constraints: MediaStreamConstraints,
            ) => Promise<MediaStream>;
            getDisplayMedia: (
                constraints: MediaStreamConstraints,
            ) => Promise<MediaStream>;
            enumerateDevices: () => Promise<MediaDeviceInfo[]>;
        };
        transportCreated: boolean;
        transportCreatedAudio: boolean;
        updateAudioAlreadyOn: (status: boolean) => void;
        updateAudioRequestState: (state: string) => void;
        updateAudioPaused: (status: boolean) => void;
        updateLocalStream: (stream: MediaStream) => void;
        updateParticipants: (participants: Participant[]) => void;
        updateTransportCreated: (status: boolean) => void;
        updateTransportCreatedAudio: (status: boolean) => void;
        updateMicAction: (action: boolean) => void;
        showAlert?: ShowAlert;
        checkPermission: CheckPermissionType;
        streamSuccessAudio: StreamSuccessAudioType;
        disconnectSendTransportAudio: DisconnectSendTransportAudioType;
        requestPermissionAudio: RequestPermissionAudioType;
        resumeSendTransportAudio: ResumeSendTransportAudioType;
        getUpdatedAllParams: () => ClickAudioParameters;
        [key: string]: any;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: any
    Index

    Properties

    audioDecibels coHostResponsibility coHost videoParams canvasStream connectSendTransportVideo connectSendTransportScreen updateAudioLevel screenProducer localScreenProducer? screenParams updateScreenProducer updateLocalScreenProducer? videoProducer localVideoProducer? updateVideoProducer updateLocalVideoProducer? device producerTransport localProducerTransport? localTransportCreated? updateProducerTransport updateLocalProducerTransport? updateLocalTransportCreated? connectSendTransport audioProducer localAudioProducer? videoAlreadyOn lock_screen shared updateMainWindow hostLabel updateAudioProducer updateLocalAudioProducer? updateUpdateMainWindow prepopulateUserMedia allVideoStreams 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? prepopulateLocalUserMedia? audioParams localStreamAudio defAudioID params audioParamse? aParams updateAudioParams updateLocalStreamAudio updateDefAudioID updateUserDefaultAudioInputDevice createSendTransport connectSendTransportAudio checkMediaPermission hasAudioPermission audioPaused audioAlreadyOn audioOnlyRoom recordStarted recordResumed recordPaused recordStopped recordingMediaOptions islevel youAreCoHost adminRestrictSetting audioRequestState audioRequestTime member socket localSocket? roomName userDefaultAudioInputDevice micAction localStream audioSetting videoSetting screenshareSetting chatSetting updateRequestIntervalSeconds participants mediaDevices transportCreated transportCreatedAudio updateAudioAlreadyOn updateAudioRequestState updateAudioPaused updateLocalStream updateParticipants updateTransportCreated updateTransportCreatedAudio updateMicAction showAlert? checkPermission streamSuccessAudio disconnectSendTransportAudio requestPermissionAudio resumeSendTransportAudio getUpdatedAllParams

    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
    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>
    localTransportCreated?: boolean
    updateProducerTransport: (producerTransport: Transport<AppData>) => void
    updateLocalProducerTransport?: (localTransport: Transport<AppData>) => void
    updateLocalTransportCreated?: (localTransportCreated: boolean) => void
    connectSendTransport: ConnectSendTransportType
    audioProducer: Producer<AppData>
    localAudioProducer?: Producer<AppData>
    videoAlreadyOn: boolean
    lock_screen: boolean
    shared: boolean
    updateMainWindow: boolean
    hostLabel: string
    updateAudioProducer: (audioProducer: Producer<AppData>) => void
    updateLocalAudioProducer?: (localAudioProducer: Producer<AppData>) => void
    updateUpdateMainWindow: (updateMainWindow: boolean) => void
    prepopulateUserMedia: PrepopulateUserMediaType
    allVideoStreams: (Stream | Participant)[]
    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>
    prepopulateLocalUserMedia?: PrepopulateUserMediaType
    audioParams: ProducerOptions
    localStreamAudio: MediaStream
    defAudioID: string
    params: ProducerOptions
    audioParamse?: ProducerOptions
    aParams: ProducerOptions
    updateAudioParams: (audioParams: ProducerOptions) => void
    updateLocalStreamAudio: (localStreamAudio: MediaStream) => void
    updateDefAudioID: (defAudioID: string) => void
    updateUserDefaultAudioInputDevice: (userDefaultAudioInputDevice: string) => void
    createSendTransport: CreateSendTransportType
    connectSendTransportAudio: ConnectSendTransportAudioType
    checkMediaPermission: boolean
    hasAudioPermission: boolean
    audioPaused: boolean
    audioAlreadyOn: boolean
    audioOnlyRoom: boolean
    recordStarted: boolean
    recordResumed: boolean
    recordPaused: boolean
    recordStopped: boolean
    recordingMediaOptions: string
    islevel: string

    Member privilege level.

    youAreCoHost: boolean
    adminRestrictSetting: boolean
    audioRequestState: string
    audioRequestTime: number
    member: string

    Local member identifier.

    socket: Socket

    Socket instance for media control events.

    localSocket?: Socket
    roomName: string

    Active room identifier.

    userDefaultAudioInputDevice: string
    micAction: boolean
    localStream: MediaStream
    audioSetting: string
    videoSetting: string
    screenshareSetting: string
    chatSetting: string
    updateRequestIntervalSeconds: number
    participants: Participant[]

    Current participant roster.

    Session Context:

    mediaDevices: {
        getUserMedia: (
            constraints: MediaStreamConstraints,
        ) => Promise<MediaStream>;
        getDisplayMedia: (
            constraints: MediaStreamConstraints,
        ) => Promise<MediaStream>;
        enumerateDevices: () => Promise<MediaDeviceInfo[]>;
    }
    transportCreated: boolean
    transportCreatedAudio: boolean
    updateAudioAlreadyOn: (status: boolean) => void
    updateAudioRequestState: (state: string) => void
    updateAudioPaused: (status: boolean) => void
    updateLocalStream: (stream: MediaStream) => void
    updateParticipants: (participants: Participant[]) => void
    updateTransportCreated: (status: boolean) => void
    updateTransportCreatedAudio: (status: boolean) => void
    updateMicAction: (action: boolean) => void
    showAlert?: ShowAlert

    Optional alert helper.

    checkPermission: CheckPermissionType
    streamSuccessAudio: StreamSuccessAudioType
    disconnectSendTransportAudio: DisconnectSendTransportAudioType
    requestPermissionAudio: RequestPermissionAudioType
    resumeSendTransportAudio: ResumeSendTransportAudioType
    getUpdatedAllParams: () => ClickAudioParameters

    Refreshes parameters before invoking side effects.