MediaSFU React Native
    Preparing search index...

    Interface AudioCardOptions

    Configuration options for rendering an AudioCard.

    AudioCardOptions

    Appearance:

    interface AudioCardOptions {
        controlUserMedia?: (options: ControlMediaOptions) => Promise<void>;
        customStyle?: StyleProp<ViewStyle>;
        name: string;
        barColor?: string;
        textColor?: string;
        imageSource?: string;
        roundedImage?: boolean;
        imageStyle?: StyleProp<ImageStyle>;
        showControls?: boolean;
        showInfo?: boolean;
        videoInfoComponent?: ReactNode;
        videoControlsComponent?: ReactNode;
        controlsPosition?: ControlsPosition;
        infoPosition?: InfoPosition;
        participant: Participant;
        backgroundColor?: string;
        audioDecibels?: AudioDecibels;
        parameters: AudioCardParameters;
        customAudioCard?: CustomAudioCardType;
        style?: StyleProp<ViewStyle>;
        renderContent?: (
            options: {
                defaultContent: Element;
                dimensions: { width: number; height: number };
            },
        ) => Element;
        renderContainer?: (
            options: {
                defaultContainer: Element;
                dimensions: { width: number; height: number };
            },
        ) => Element;
    }
    Index

    Properties

    controlUserMedia? customStyle? name barColor? textColor? imageSource? roundedImage? imageStyle? showControls? showInfo? videoInfoComponent? videoControlsComponent? controlsPosition? infoPosition? participant backgroundColor? audioDecibels? parameters customAudioCard? style? renderContent? renderContainer?

    Properties

    controlUserMedia?: (options: ControlMediaOptions) => Promise<void>

    Handler for toggling media.

    customStyle?: StyleProp<ViewStyle>

    Additional card styling.

    name: string

    Participant display name.

    barColor?: string

    Waveform bar color.

    textColor?: string

    Participant label color.

    imageSource?: string

    Optional avatar URL.

    roundedImage?: boolean

    Rounds avatar corners.

    imageStyle?: StyleProp<ImageStyle>

    Additional avatar styling.

    showControls?: boolean

    Toggles media controls visibility.

    showInfo?: boolean

    Toggles participant info display.

    videoInfoComponent?: ReactNode

    Replacement component for info overlay.

    videoControlsComponent?: ReactNode

    Replacement component for controls overlay.

    controlsPosition?: ControlsPosition

    Overlay placement for controls.

    infoPosition?: InfoPosition

    Overlay placement for info.

    Behaviour:

    participant: Participant

    Participant metadata used in controls.

    backgroundColor?: string

    Card background color.

    Controls & Info:

    audioDecibels?: AudioDecibels

    Loudness metrics for the participant.

    parameters: AudioCardParameters

    Shared meeting parameters.

    customAudioCard?: CustomAudioCardType

    Custom renderer to replace the default card body.

    Advanced Render Overrides:

    style?: StyleProp<ViewStyle>

    Style override applied to the container wrapper.

    renderContent?: (
        options: {
            defaultContent: Element;
            dimensions: { width: number; height: number };
        },
    ) => Element

    Override for the internal layout.

    renderContainer?: (
        options: {
            defaultContainer: Element;
            dimensions: { width: number; height: number };
        },
    ) => Element

    Override for the outer container implementation.

    Settings

    Member Visibility

    On This Page

    Properties