class SnapshotAPI

Provides access to patcher snapshots.

Index

Constructors

• new SnapshotAPI(varname)

Methods

• addsnapshot(userpath, index, name)
• deletesnapshot(index, newcurrent)
• exportsnapshot(index, userpath)
• getembedsnapshot(index)
• getnumsnapshots()
• getsnapshotname(index)
• importsnapshot(index, userpath)
• movesnapshot(srcIndex, destIndex)
• restore(index, userpath)
• setembedsnapshot(index, embedstate)
• setsnapshotname(index, name)
• snapshot(userpath, index, name)

new SnapshotAPI(varname)

new SnapshotAPI(varname: string);

Constructs a new instance of the SnapshotAPI class

addsnapshot(userpath, index, name)

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(index, newcurrent)

Delete a snapshot

deletesnapshot(index?: number, newcurrent?: number): void;

exportsnapshot(index, userpath)

Save a snapshot to a file

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

getembedsnapshot(index)

Query the 'embed' state of a snapshot

getembedsnapshot(index: number): number;

getnumsnapshots()

Get the total number of snapshots

getnumsnapshots(): number;

getsnapshotname(index)

Get the name of the snapshot at a given index

getsnapshotname(index: number): string;

importsnapshot(index, userpath)

Load a snapshot from a file into a given slot

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

movesnapshot(srcIndex, destIndex)

Change a snapshot's index

Does nothing if the srcIndex or destIndex doesn't exist

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

restore(index, userpath)

Restore a snapshot

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

setembedsnapshot(index, embedstate)

Set the embed state of a snapshot

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

setsnapshotname(index, name)

Set the name of the snapshot at the given index

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

snapshot(userpath, index, name)

Create a snapshot at a given index

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

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