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: null | MediaStream;
    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;
}

Properties

customStyle? name barColor? textColor? imageSource? roundedImage? imageStyle? remoteProducerId eventType forceFullDisplay videoStream showControls? showInfo? videoInfoComponent? videoControlsComponent? controlsPosition? infoPosition? participant backgroundColor? audioDecibels? doMirror? parameters containerProps? infoOverlayProps? controlsOverlayProps? waveformContainerProps? waveformBarStyle? waveformBarClassName? videoDisplayProps? extraWidgets? children?

Properties

OptionalcustomStyle

customStyle?: CSSProperties

name

name: string

OptionalbarColor

barColor?: string

OptionaltextColor

textColor?: string

OptionalimageSource

imageSource?: string

OptionalroundedImage

roundedImage?: boolean

OptionalimageStyle

imageStyle?: CSSProperties

remoteProducerId

remoteProducerId: string

eventType

eventType: EventType

forceFullDisplay

forceFullDisplay: boolean

videoStream

videoStream: null | MediaStream

OptionalshowControls

showControls?: boolean

OptionalshowInfo

showInfo?: boolean

OptionalvideoInfoComponent

videoInfoComponent?: ReactNode

OptionalvideoControlsComponent

videoControlsComponent?: ReactNode

OptionalcontrolsPosition

controlsPosition?:
    | "topLeft"
    | "topRight"
    | "bottomLeft"
    | "bottomRight"

OptionalinfoPosition

infoPosition?:
    | "topLeft"
    | "topRight"
    | "bottomLeft"
    | "bottomRight"

participant

participant: Participant

OptionalbackgroundColor

backgroundColor?: string

OptionalaudioDecibels

audioDecibels?: AudioDecibels[]

OptionaldoMirror

doMirror?: boolean

parameters

parameters: VideoCardParameters

OptionalcontainerProps

containerProps?: HTMLAttributes<HTMLDivElement>

OptionalinfoOverlayProps

infoOverlayProps?: HTMLAttributes<HTMLDivElement>

OptionalcontrolsOverlayProps

controlsOverlayProps?: HTMLAttributes<HTMLDivElement>

OptionalwaveformContainerProps

waveformContainerProps?: HTMLAttributes<HTMLDivElement>

OptionalwaveformBarStyle

waveformBarStyle?: CSSProperties

OptionalwaveformBarClassName

waveformBarClassName?: string

OptionalvideoDisplayProps

videoDisplayProps?: Partial<CardVideoDisplayOptions>

OptionalextraWidgets

extraWidgets?: ReactNode

Optionalchildren

children?: ReactNode

Settings

Member Visibility

On This Page

Properties