Interface ImageSinkOptions

interface ImageSinkOptions {
    completedEvent?: boolean;
    filePath: string;
    name?: string;
    persistence?: boolean;
    uid?: string;
}

Hierarchy

  • SinkNodeOptions
    • ImageSinkOptions

Properties

completedEvent? filePath name? persistence? uid?

Properties

Optional completedEvent

completedEvent?: boolean

Emit a completed event for this sink

Default

true

filePath

filePath: string

File to save it to

Placeholders

  • {createdTimestamp}: Timestamp of the created frame

Optional name

name?: string

User friendly name of the node Used for querying a node by its name.

Optional persistence

persistence?: boolean

Store objects in data services

Default

true

Optional uid

uid?: string

Manually set the unique identifier of the node

Settings

Member Visibility

Theme

On This Page