MediaSFU ReactJS
    Preparing search index...

    Interface AudioCardOptions

    interface AudioCardOptions {
        controlUserMedia?: (options: ControlMediaOptions) => Promise<void>;
        customStyle?: CSSProperties;
        name: string;
        barColor?: string;
        textColor?: string;
        imageSource?: string;
        roundedImage?: boolean;
        imageStyle?: CSSProperties;
        showControls?: boolean;
        showInfo?: boolean;
        videoInfoComponent?: ReactNode;
        videoControlsComponent?: ReactNode;
        controlsPosition?: ControlsPosition;
        infoPosition?: InfoPosition;
        participant: Participant;
        backgroundColor?: string;
        audioDecibels?: AudioDecibels;
        parameters: AudioCardParameters;
        cardProps?: HTMLAttributes<HTMLDivElement>;
        infoOverlayProps?: HTMLAttributes<HTMLDivElement>;
        nameContainerProps?: HTMLAttributes<HTMLDivElement>;
        nameTextProps?: HTMLAttributes<HTMLParagraphElement>;
        waveformContainerProps?: HTMLAttributes<HTMLDivElement>;
        waveformBarStyle?: CSSProperties;
        waveformBarProps?: HTMLAttributes<HTMLDivElement>;
        waveformHeights?: { silent?: number; active?: number };
        waveformDurations?: number[];
        waveformBarCount?: number;
        renderWaveformBar?: (
            options: {
                index: number;
                isActive: boolean;
                height: number;
                style: CSSProperties;
                props: HTMLAttributes<HTMLDivElement>;
            },
        ) => ReactNode;
        controlsOverlayProps?: HTMLAttributes<HTMLDivElement>;
        controlButtonProps?: {
            audio?: ButtonHTMLAttributes<HTMLButtonElement>;
            video?: ButtonHTMLAttributes<HTMLButtonElement>;
        };
        audioEnabledIcon?: ReactNode;
        audioDisabledIcon?: ReactNode;
        videoEnabledIcon?: ReactNode;
        videoDisabledIcon?: ReactNode;
        fallbackMiniCardProps?: Partial<MiniCardOptions>;
        imageProps?: ImgHTMLAttributes<HTMLImageElement>;
        showWaveformWhenMuted?: boolean;
        isDarkMode?: boolean;
        liveSubtitle?: LiveSubtitle | (() => LiveSubtitle | null) | null;
        showSubtitles?: boolean;
    }
    Index

    Properties

    controlUserMedia?: (options: ControlMediaOptions) => Promise<void>
    customStyle?: CSSProperties
    name: string
    barColor?: string
    textColor?: string
    imageSource?: string
    roundedImage?: boolean
    imageStyle?: CSSProperties
    showControls?: boolean
    showInfo?: boolean
    videoInfoComponent?: ReactNode
    videoControlsComponent?: ReactNode
    controlsPosition?: ControlsPosition
    infoPosition?: InfoPosition
    participant: Participant
    backgroundColor?: string
    audioDecibels?: AudioDecibels
    cardProps?: HTMLAttributes<HTMLDivElement>
    infoOverlayProps?: HTMLAttributes<HTMLDivElement>
    nameContainerProps?: HTMLAttributes<HTMLDivElement>
    nameTextProps?: HTMLAttributes<HTMLParagraphElement>
    waveformContainerProps?: HTMLAttributes<HTMLDivElement>
    waveformBarStyle?: CSSProperties
    waveformBarProps?: HTMLAttributes<HTMLDivElement>
    waveformHeights?: { silent?: number; active?: number }
    waveformDurations?: number[]
    waveformBarCount?: number
    renderWaveformBar?: (
        options: {
            index: number;
            isActive: boolean;
            height: number;
            style: CSSProperties;
            props: HTMLAttributes<HTMLDivElement>;
        },
    ) => ReactNode
    controlsOverlayProps?: HTMLAttributes<HTMLDivElement>
    controlButtonProps?: {
        audio?: ButtonHTMLAttributes<HTMLButtonElement>;
        video?: ButtonHTMLAttributes<HTMLButtonElement>;
    }
    audioEnabledIcon?: ReactNode
    audioDisabledIcon?: ReactNode
    videoEnabledIcon?: ReactNode
    videoDisabledIcon?: ReactNode
    fallbackMiniCardProps?: Partial<MiniCardOptions>
    imageProps?: ImgHTMLAttributes<HTMLImageElement>
    showWaveformWhenMuted?: boolean
    isDarkMode?: boolean
    liveSubtitle?: LiveSubtitle | (() => LiveSubtitle | null) | null

    Live subtitle for displaying translated speech

    showSubtitles?: boolean

    Whether to show subtitles on this card