Interface VideoCardOptions

interface VideoCardOptions {
    customStyle?: Partial<CSSStyleDeclaration>;
    name: string;
    barColor?: string;
    textColor?: string;
    imageSource: string;
    roundedImage?: boolean;
    imageStyle?: Partial<CSSStyleDeclaration>;
    remoteProducerId: string;
    eventType: EventType;
    forceFullDisplay?: boolean;
    videoStream: null | MediaStream;
    showControls?: boolean;
    showInfo?: boolean;
    videoInfoComponent?: HTMLElement | CustomComponent;
    videoControlsComponent?: HTMLElement | CustomComponent;
    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?: Partial<CSSStyleDeclaration>

name

name: string

OptionalbarColor

barColor?: string

OptionaltextColor

textColor?: string

imageSource

imageSource: string

OptionalroundedImage

roundedImage?: boolean

OptionalimageStyle

imageStyle?: Partial<CSSStyleDeclaration>

remoteProducerId

remoteProducerId: string

eventType

eventType: EventType

OptionalforceFullDisplay

forceFullDisplay?: boolean

videoStream

videoStream: null | MediaStream

OptionalshowControls

showControls?: boolean

OptionalshowInfo

showInfo?: boolean

OptionalvideoInfoComponent

videoInfoComponent?: HTMLElement | CustomComponent

OptionalvideoControlsComponent

videoControlsComponent?: HTMLElement | CustomComponent

OptionalcontrolsPosition

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

OptionalinfoPosition

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

participant

participant: Participant

backgroundColor

backgroundColor: string

audioDecibels

audioDecibels: AudioDecibels[]

OptionaldoMirror

doMirror?: boolean

parameters

parameters: VideoCardParameters

Settings

Member Visibility

On This Page

Properties