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;
}

Properties

customStyle? name barColor? textColor? imageSource? roundedImage? imageStyle? remoteProducerId eventType forceFullDisplay videoStream showControls? showInfo? videoInfoComponent? videoControlsComponent? controlsPosition? infoPosition? participant backgroundColor? audioDecibels? doMirror? parameters

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

Settings

Member Visibility

On This Page

Properties