MediaSFU React Native (Expo)
    Preparing search index...

    Interface StreamSuccessAudioSwitchParameters

    Interface defining the parameters required by the AudioCard component.

    These parameters provide the context and state needed for audio display, participant management, and media controls.

    AudioCardParameters

    interface StreamSuccessAudioSwitchParameters {
        audioDecibels: AudioDecibels[];
        coHostResponsibility: CoHostResponsibility[];
        showAlert?: ShowAlert;
        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: (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;
        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>;
        translationTranscripts?: {
            speakerId?: string;
            speakerName?: string;
            translatedText?: string;
            originalText?: string;
            timestamp?: number;
        }[];
        showSubtitlesOnCards?: boolean;
        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;
        userDefaultAudioInputDevice: 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;
        updateUserDefaultAudioInputDevice: (
            userDefaultAudioInputDevice: string,
        ) => void;
        updateUpdateMainWindow: (updateMainWindow: boolean) => void;
        sleep: SleepType;
        prepopulateUserMedia: PrepopulateUserMediaType;
        createSendTransport: CreateSendTransportType;
        connectSendTransportAudio: ConnectSendTransportAudioType;
        getUpdatedAllParams: () => StreamSuccessAudioSwitchParameters;
        [key: string]: any;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: any
    Index

    Properties

    audioDecibels coHostResponsibility showAlert? 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? translationTranscripts? showSubtitlesOnCards? audioProducer localAudioProducer? socket localSocket? roomName localStream localStreamAudio audioParams audioPaused audioAlreadyOn transportCreated localTransportCreated? audioParamse? defAudioID userDefaultAudioInputDevice hostLabel updateMainWindow videoAlreadyOn islevel lock_screen shared updateAudioProducer updateLocalAudioProducer? updateLocalStream updateAudioParams updateDefAudioID updateUserDefaultAudioInputDevice updateUpdateMainWindow sleep prepopulateUserMedia createSendTransport connectSendTransportAudio getUpdatedAllParams

    Properties

    audioDecibels: AudioDecibels[]

    Array of audio level data for all participants (used for waveform visualization)

    coHostResponsibility: CoHostResponsibility[]

    Array of responsibilities assigned to co-hosts

    showAlert?: ShowAlert

    Optional function to display alerts/notifications

    coHost: string

    User ID of the co-host

    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[]

    Array of all participants in the session

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

    Current user's member ID

    shareScreenStarted: boolean
    eventType: EventType

    Type of event ('conference', 'webinar', 'broadcast', etc.)

    screenId?: string
    forceFullDisplay: boolean
    mainScreenFilled: boolean
    adminOnMainScreen: boolean
    mainScreenPerson: string
    oldAllStreams: (Participant | Stream)[]
    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>
    translationTranscripts?: {
        speakerId?: string;
        speakerName?: string;
        translatedText?: string;
        originalText?: string;
        timestamp?: number;
    }[]
    showSubtitlesOnCards?: boolean
    audioProducer: Producer<AppData>
    localAudioProducer?: Producer<AppData>
    socket: Socket

    Socket.io client instance for real-time communication

    localSocket?: Socket
    roomName: string

    Name/ID of the current room session

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

    Current user's level/role (e.g., '0', '1', '2')

    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
    updateUserDefaultAudioInputDevice: (userDefaultAudioInputDevice: string) => void
    updateUpdateMainWindow: (updateMainWindow: boolean) => void
    sleep: SleepType
    prepopulateUserMedia: PrepopulateUserMediaType
    createSendTransport: CreateSendTransportType
    connectSendTransportAudio: ConnectSendTransportAudioType
    getUpdatedAllParams: () => StreamSuccessAudioSwitchParameters

    Function to retrieve latest parameter state