Interface ImageCaptureOptions

Options available for taking a screenshot with the camera.

interface ImageCaptureOptions {
    antialiasing?: boolean;
    imageHandler?: ((base64) => Promise<void>);
    name?: string;
    size?: number;
    sizeOptions?: SizeOptions;
}

Properties

antialiasing? imageHandler? name? size? sizeOptions?

Properties

Optional antialiasing

antialiasing?: boolean

Take screenshot with anti-aliasing. Default: true

Optional imageHandler

imageHandler?: ((base64) => Promise<void>)

Function that handles the captured image data. Default: Downloads a png file to the user's Downloads folder.

Type declaration

    • (base64): Promise<void>

    • Parameters

      • base64: string

      Returns Promise<void>

Optional name

name?: string

The name of the screen capture. Default: "ATLATL Visual Snapshot"

Optional size

size?: number

The size of the screenshot. Will use this number for both the width and height. Default: undefined

Optional sizeOptions

sizeOptions?: SizeOptions

Allows for height and width to be specified independently or for height and width to be based off of camera with a resolution multiplier. Mutually exclusive with size. Default: A SizeOptions object with a resolutionFactor of 1

Settings

Member Visibility

Theme

On This Page

antialiasingimageHandlernamesizesizeOptions

Generated using TypeDoc