MediaSFU React Native
    Preparing search index...

    Interface StreamSuccessAudioParameters

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

    AudioCardParameters

    Telemetry & Participants:

    interface StreamSuccessAudioParameters {
        audioDecibels: AudioDecibels[];
        coHostResponsibility: CoHostResponsibility[];
        roomName: string;
        coHost: string;
        videoParams: ProducerOptions;
        localStreamScreen: MediaStream;
        canvasStream: MediaStream;
        whiteboardStarted: boolean;
        whiteboardEnded: boolean;
        connectSendTransportVideo: ConnectSendTransportVideoType;
        connectSendTransportScreen: ConnectSendTransportScreenType;
        audioProducer: Producer<AppData>;
        localAudioProducer?: Producer<AppData>;
        updateAudioProducer: (producer: Producer<AppData>) => void;
        updateLocalAudioProducer?: (localProducer: Producer<AppData>) => void;
        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;
        localSocket?: Socket;
        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;
        allVideoStreams: (Stream | Participant)[];
        shareScreenStarted: boolean;
        eventType: EventType;
        screenId?: string;
        forceFullDisplay: boolean;
        mainScreenFilled: boolean;
        adminOnMainScreen: boolean;
        mainScreenPerson: string;
        oldAllStreams: (Stream | Participant)[];
        checkOrientation: () => string;
        screenForceFullDisplay: boolean;
        remoteScreenStream: Stream[];
        localStreamVideo: MediaStream;
        mainHeightWidth: number;
        isWideScreen: boolean;
        localUIMode: 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;
        socket: Socket;
        participants: Participant[];
        localStream: MediaStream;
        transportCreated: boolean;
        transportCreatedAudio: boolean;
        audioAlreadyOn: boolean;
        micAction: boolean;
        audioParams: ProducerOptions;
        localStreamAudio: MediaStream;
        defAudioID: string;
        userDefaultAudioInputDevice: string;
        params: ProducerOptions;
        audioParamse?: ProducerOptions;
        aParams: ProducerOptions;
        hostLabel: string;
        islevel: string;
        member: string;
        updateMainWindow: boolean;
        lock_screen: boolean;
        shared: boolean;
        videoAlreadyOn: boolean;
        showAlert?: ShowAlert;
        updateParticipants: (participants: Participant[]) => void;
        updateTransportCreated: (transportCreated: boolean) => void;
        updateTransportCreatedAudio: (transportCreatedAudio: boolean) => void;
        updateAudioAlreadyOn: (audioAlreadyOn: boolean) => void;
        updateMicAction: (micAction: boolean) => void;
        updateAudioParams: (audioParams: ProducerOptions) => void;
        updateLocalStream: (localStream: MediaStream) => void;
        updateLocalStreamAudio: (localStreamAudio: MediaStream) => void;
        updateDefAudioID: (defAudioID: string) => void;
        updateUserDefaultAudioInputDevice: (
            userDefaultAudioInputDevice: string,
        ) => void;
        updateUpdateMainWindow: (updateMainWindow: boolean) => void;
        createSendTransport: CreateSendTransportType;
        connectSendTransportAudio: ConnectSendTransportAudioType;
        resumeSendTransportAudio: ResumeSendTransportAudioType;
        prepopulateUserMedia: PrepopulateUserMediaType;
        getUpdatedAllParams: () => StreamSuccessAudioParameters;
        [key: string]: any;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: any
    Index

    Properties

    audioDecibels coHostResponsibility roomName coHost videoParams localStreamScreen canvasStream whiteboardStarted whiteboardEnded connectSendTransportVideo connectSendTransportScreen audioProducer localAudioProducer? updateAudioProducer updateLocalAudioProducer? updateAudioLevel screenProducer localScreenProducer? screenParams updateScreenProducer updateLocalScreenProducer? videoProducer localVideoProducer? updateVideoProducer updateLocalVideoProducer? localSocket? device producerTransport localProducerTransport? localTransportCreated? updateProducerTransport updateLocalProducerTransport? updateLocalTransportCreated? connectSendTransport allVideoStreams shareScreenStarted eventType screenId? forceFullDisplay mainScreenFilled adminOnMainScreen mainScreenPerson oldAllStreams checkOrientation screenForceFullDisplay remoteScreenStream localStreamVideo mainHeightWidth isWideScreen localUIMode virtualStream keepBackground annotateScreenStream updateMainScreenPerson updateMainScreenFilled updateAdminOnMainScreen updateMainHeightWidth updateScreenForceFullDisplay updateMainGridStream customVideoCard? customAudioCard? customMiniCard? videoCardComponent? audioCardComponent? miniCardComponent? prepopulateLocalUserMedia? socket participants localStream transportCreated transportCreatedAudio audioAlreadyOn micAction audioParams localStreamAudio defAudioID userDefaultAudioInputDevice params audioParamse? aParams hostLabel islevel member updateMainWindow lock_screen shared videoAlreadyOn showAlert? updateParticipants updateTransportCreated updateTransportCreatedAudio updateAudioAlreadyOn updateMicAction updateAudioParams updateLocalStream updateLocalStreamAudio updateDefAudioID updateUserDefaultAudioInputDevice updateUpdateMainWindow createSendTransport connectSendTransportAudio resumeSendTransportAudio prepopulateUserMedia getUpdatedAllParams

    Properties

    audioDecibels: AudioDecibels[]

    Live loudness metrics per participant.

    coHostResponsibility: CoHostResponsibility[]

    Active co-host capabilities.

    roomName: string

    Active room identifier.

    coHost: string

    Current co-host identifier.

    videoParams: ProducerOptions
    localStreamScreen: MediaStream
    canvasStream: MediaStream
    whiteboardStarted: boolean
    whiteboardEnded: boolean
    connectSendTransportVideo: ConnectSendTransportVideoType
    connectSendTransportScreen: ConnectSendTransportScreenType
    audioProducer: Producer<AppData>
    localAudioProducer?: Producer<AppData>
    updateAudioProducer: (producer: Producer<AppData>) => void
    updateLocalAudioProducer?: (localProducer: Producer<AppData>) => void
    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
    localSocket?: Socket
    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
    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
    remoteScreenStream: Stream[]
    localStreamVideo: MediaStream
    mainHeightWidth: number
    isWideScreen: boolean
    localUIMode: 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
    socket: Socket

    Socket instance for media control events.

    participants: Participant[]

    Current participant roster.

    Session Context:

    localStream: MediaStream
    transportCreated: boolean
    transportCreatedAudio: boolean
    audioAlreadyOn: boolean
    micAction: boolean
    audioParams: ProducerOptions
    localStreamAudio: MediaStream
    defAudioID: string
    userDefaultAudioInputDevice: string
    params: ProducerOptions
    audioParamse?: ProducerOptions
    aParams: ProducerOptions
    hostLabel: string
    islevel: string

    Member privilege level.

    member: string

    Local member identifier.

    updateMainWindow: boolean
    lock_screen: boolean
    shared: boolean
    videoAlreadyOn: boolean
    showAlert?: ShowAlert

    Optional alert helper.

    updateParticipants: (participants: Participant[]) => void
    updateTransportCreated: (transportCreated: boolean) => void
    updateTransportCreatedAudio: (transportCreatedAudio: boolean) => void
    updateAudioAlreadyOn: (audioAlreadyOn: boolean) => void
    updateMicAction: (micAction: boolean) => void
    updateAudioParams: (audioParams: ProducerOptions) => void
    updateLocalStream: (localStream: MediaStream) => void
    updateLocalStreamAudio: (localStreamAudio: MediaStream) => void
    updateDefAudioID: (defAudioID: string) => void
    updateUserDefaultAudioInputDevice: (userDefaultAudioInputDevice: string) => void
    updateUpdateMainWindow: (updateMainWindow: boolean) => void
    createSendTransport: CreateSendTransportType
    connectSendTransportAudio: ConnectSendTransportAudioType
    resumeSendTransportAudio: ResumeSendTransportAudioType
    prepopulateUserMedia: PrepopulateUserMediaType
    getUpdatedAllParams: () => StreamSuccessAudioParameters

    Refreshes parameters before invoking side effects.