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

    Interface PrepopulateUserMediaParameters

    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 PrepopulateUserMediaParameters {
        audioDecibels: AudioDecibels[];
        socket: Socket;
        coHostResponsibility: CoHostResponsibility[];
        roomName: string;
        showAlert?: ShowAlert;
        coHost: string;
        participants: Participant[];
        allVideoStreams: (Participant | Stream)[];
        islevel: string;
        member: string;
        shared: boolean;
        shareScreenStarted: boolean;
        eventType: EventType;
        screenId?: string;
        forceFullDisplay: boolean;
        updateMainWindow: boolean;
        mainScreenFilled: boolean;
        adminOnMainScreen: boolean;
        mainScreenPerson: string;
        videoAlreadyOn: boolean;
        audioAlreadyOn: boolean;
        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;
        updateUpdateMainWindow: (update: 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;
        getUpdatedAllParams: () => PrepopulateUserMediaParameters;
        [key: string]: any;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: any
    Index

    Properties

    audioDecibels socket coHostResponsibility roomName showAlert? coHost participants allVideoStreams islevel member shared shareScreenStarted eventType screenId? forceFullDisplay updateMainWindow mainScreenFilled adminOnMainScreen mainScreenPerson videoAlreadyOn audioAlreadyOn oldAllStreams checkOrientation screenForceFullDisplay localStreamScreen remoteScreenStream localStreamVideo mainHeightWidth isWideScreen localUIMode whiteboardStarted whiteboardEnded virtualStream keepBackground annotateScreenStream updateMainScreenPerson updateMainScreenFilled updateAdminOnMainScreen updateMainHeightWidth updateScreenForceFullDisplay updateUpdateMainWindow updateMainGridStream customVideoCard? customAudioCard? customMiniCard? videoCardComponent? audioCardComponent? miniCardComponent? translationTranscripts? showSubtitlesOnCards? getUpdatedAllParams

    Properties

    audioDecibels: AudioDecibels[]

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

    socket: Socket

    Socket.io client instance for real-time communication

    coHostResponsibility: CoHostResponsibility[]

    Array of responsibilities assigned to co-hosts

    roomName: string

    Name/ID of the current room session

    showAlert?: ShowAlert

    Optional function to display alerts/notifications

    coHost: string

    User ID of the co-host

    participants: Participant[]

    Array of all participants in the session

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

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

    member: string

    Current user's member ID

    shared: boolean
    shareScreenStarted: boolean
    eventType: EventType

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

    screenId?: string
    forceFullDisplay: boolean
    updateMainWindow: boolean
    mainScreenFilled: boolean
    adminOnMainScreen: boolean
    mainScreenPerson: string
    videoAlreadyOn: boolean
    audioAlreadyOn: boolean
    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
    updateUpdateMainWindow: (update: 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
    getUpdatedAllParams: () => PrepopulateUserMediaParameters

    Function to retrieve latest parameter state

    Settings

    Member Visibility

    On This Page

    Properties