MediaSFU ReactJS
    Preparing search index...

    Interface VideoCardOptions

    interface VideoCardOptions {
        customStyle?: CSSProperties;
        name: string;
        barColor?: string;
        textColor?: string;
        imageSource?: string;
        roundedImage?: boolean;
        imageStyle?: CSSProperties;
        remoteProducerId: string;
        eventType: EventType;
        forceFullDisplay: boolean;
        videoStream: MediaStream | null;
        showControls?: boolean;
        showInfo?: boolean;
        videoInfoComponent?: ReactNode;
        videoControlsComponent?: ReactNode;
        controlsPosition?: "topLeft" | "topRight" | "bottomLeft" | "bottomRight";
        infoPosition?: "topLeft" | "topRight" | "bottomLeft" | "bottomRight";
        participant: Participant;
        backgroundColor?: string;
        audioDecibels?: AudioDecibels[];
        doMirror?: boolean;
        parameters: VideoCardParameters;
        containerProps?: HTMLAttributes<HTMLDivElement>;
        infoOverlayProps?: HTMLAttributes<HTMLDivElement>;
        controlsOverlayProps?: HTMLAttributes<HTMLDivElement>;
        waveformContainerProps?: HTMLAttributes<HTMLDivElement>;
        waveformBarStyle?: CSSProperties;
        waveformBarClassName?: string;
        videoDisplayProps?: Partial<CardVideoDisplayOptions>;
        extraWidgets?: ReactNode;
        children?: ReactNode;
        isDarkMode?: boolean;
        liveSubtitle?: LiveSubtitle | (() => LiveSubtitle | null) | null;
        showSubtitles?: boolean;
    }
    Index

    Properties

    customStyle?: CSSProperties
    name: string
    barColor?: string
    textColor?: string
    imageSource?: string
    roundedImage?: boolean
    imageStyle?: CSSProperties
    remoteProducerId: string
    eventType: EventType
    forceFullDisplay: boolean
    videoStream: MediaStream | null
    showControls?: boolean
    showInfo?: boolean
    videoInfoComponent?: ReactNode
    videoControlsComponent?: ReactNode
    controlsPosition?: "topLeft" | "topRight" | "bottomLeft" | "bottomRight"
    infoPosition?: "topLeft" | "topRight" | "bottomLeft" | "bottomRight"
    participant: Participant
    backgroundColor?: string
    audioDecibels?: AudioDecibels[]
    doMirror?: boolean
    containerProps?: HTMLAttributes<HTMLDivElement>
    infoOverlayProps?: HTMLAttributes<HTMLDivElement>
    controlsOverlayProps?: HTMLAttributes<HTMLDivElement>
    waveformContainerProps?: HTMLAttributes<HTMLDivElement>
    waveformBarStyle?: CSSProperties
    waveformBarClassName?: string
    videoDisplayProps?: Partial<CardVideoDisplayOptions>
    extraWidgets?: ReactNode
    children?: ReactNode
    isDarkMode?: boolean
    liveSubtitle?: LiveSubtitle | (() => LiveSubtitle | null) | null

    Live subtitle for displaying translated speech

    showSubtitles?: boolean

    Whether to show subtitles on this card