Scrypted Development

Appearance

Scrypted Documentation / Image

Interface: Image ​

Properties ​

width ​

width: number

height ​

height: number

format? ​

optional format: ImageFormat

The in raw memory format of this image. Operations of this image may only safely request this format, or a compressed format such as jpg.

Methods ​

toBuffer() ​

toBuffer(options?): Promise<Buffer>

Parameters ​

• options?: ImageOptions

Returns ​

Promise<Buffer>

toImage() ​

toImage(options?): Promise<Image & MediaObject>

Parameters ​

• options?: ImageOptions

Returns ​

Promise<Image & MediaObject>

close() ​

close(): Promise<void>

Returns ​

Promise<void>