ImagePreviewOutputSettings interface

The settings for a Image Preview Output see NorskOutput.imagePreview()

Signature:

export interface ImagePreviewOutputSettings extends SinkNodeSettings<ImagePreviewOutputNode>, StreamStatisticsMixin

Extends: SinkNodeSettings<ImagePreviewOutputNode>, StreamStatisticsMixin

Properties

Property Type Description

Property	Type	Description
format?	'jpeg' \| 'png'	(Optional) The file format the stills are written in. Defaults to 'jpeg'. This is really a choice about the ALPHA CHANNEL rather than the container: JPEG cannot carry alpha, so a still of a source with transparency arrives with its transparent pixels flattened to black. That is invisible when the still is viewed on its own, and wrong as soon as one still is stacked over another (for example composing thumbnails into a layout diagram). 'png' keeps the alpha, at the cost of a larger, lossless file.
frequency	number
keep	number
onImagePublished?	(info: ImagePreviewPublishedInfo) ⇒ void	(Optional) Invoked when a new image is created on the server this filename can be appended to baseUrl to get the full location
quality	number	Ignored when `format` is 'png', which is lossless.
resolution	Resolution

format?

'jpeg' | 'png'

(Optional) The file format the stills are written in. Defaults to 'jpeg'.

This is really a choice about the ALPHA CHANNEL rather than the container: JPEG cannot carry alpha, so a still of a source with transparency arrives with its transparent pixels flattened to black. That is invisible when the still is viewed on its own, and wrong as soon as one still is stacked over another (for example composing thumbnails into a layout diagram). 'png' keeps the alpha, at the cost of a larger, lossless file.

frequency

number

keep

number

onImagePublished?

(info: ImagePreviewPublishedInfo) ⇒ void

(Optional) Invoked when a new image is created on the server this filename can be appended to baseUrl to get the full location

quality

number

Ignored when format is 'png', which is lossless.

resolution

Resolution