class SnapshotAPI

Provides access to patcher snapshots.

SnapshotAPI is not yet supported in the v8 engine.

Constructors

new SnapshotAPI(varname: string);

Constructs a new instance of the SnapshotAPI class

Methods

addsnapshot

Create a snapshot at a given index, appending to the snapshot list if the index is already occupied.

addsnapshot(userpath?: string, index?: number, name?: string): void;

deletesnapshot

Delete a snapshot

deletesnapshot(index: number): void;

exportsnapshot

Save a snapshot to a file

exportsnapshot(index: number, userpath?: string): void;

getembedsnapshot

Query the 'embed' state of a snapshot

getembedsnapshot(index: number): number;

getnumsnapshots

Get the total number of snapshots

getnumsnapshots(): number;

getsnapshotname

Get the name of the snapshot at a given index

getsnapshotname(index: number): string;

importsnapshot

Load a snapshot from a file into a given slot

importsnapshot(index?: number, userpath?: string): void;

movesnapshot

Change a snapshot's index

Does nothing if the srcIndex or destIndex doesn't exist

movesnapshot(srcIndex: number, destIndex: number): void;

restore

Restore a snapshot

restore(index: number): void;

setembedsnapshot

Set the embed state of a snapshot

setembedsnapshot(index: number, embedstate: number): void;

setsnapshotname

Set the name of the snapshot at the given index

setsnapshotname(index: number, name: string): void;

snapshot

Create a snapshot at a given index

Unlike SnapshotAPI.addsnapshot(), snapshot will overwrite existing snapshots

snapshot(userpath?: string, index?: number, name?: string): void;