Interface Video

_drawable

_skinId

Optionalmirror

provider

runtime

ReadonlyvideoReady

disableVideo

• disableVideo(): void

  Returns void

enableVideo

• enableVideo(): Promise<void> | null

  Returns Promise<void> | null

getFrame

• getFrame(
      frameInfo: {
          cacheTimeout?: number;
          dimensions?: [number, number];
          format?: "image-data";
          mirror?: boolean;
      },
  ): ImageData
  | null

  Parameters

  • frameInfo: {
        cacheTimeout?: number;
        dimensions?: [number, number];
        format?: "image-data";
        mirror?: boolean;
    }

  Returns ImageData | null

• getFrame(
      frameInfo: {
          cacheTimeout?: number;
          dimensions?: [number, number];
          format?: "canvas";
          mirror?: boolean;
      },
  ): HTMLCanvasElement
  | null

  Parameters

  • frameInfo: {
        cacheTimeout?: number;
        dimensions?: [number, number];
        format?: "canvas";
        mirror?: boolean;
    }

  Returns HTMLCanvasElement | null

• getFrame(
      frameInfo: {
          cacheTimeout?: number;
          dimensions?: [number, number];
          format?: string;
          mirror?: boolean;
      },
  ): string
  | HTMLCanvasElement
  | ImageData
  | null

  Parameters

  • frameInfo: {
        cacheTimeout?: number;
        dimensions?: [number, number];
        format?: string;
        mirror?: boolean;
    }

  Returns string | HTMLCanvasElement | ImageData | null

postData

• postData(data: VideoData): void

  Parameters

  • data: VideoData

  Returns void

setPreviewGhost

• setPreviewGhost(ghost: number): void

  Parameters

  • ghost: number

    from 0 (visible) to 100 (invisible)

  Returns void