Click or drag to resize

BaseSequenceManagerSaveKoalaSequence Method

Saves the sequence in a Koala compatible format.

Namespace:  LynceeTec.API.Sequence
Assembly:  LynceeTec.API.Sequence (in LynceeTec.API.Sequence.dll) Version: 9.0.26418.0 , built 2021-10-22 08:54:13 UTC
Syntax
Copy
public Task SaveKoalaSequence(
	string folderPath,
	HashSet<SavingType> exportTypes,
	bool saveValidOnly = false,
	IProgress<float> progress = null,
	int startIndex = 0,
	int endIndex = 2147483647
)

Parameters

folderPath
Type: SystemString
The export folder path.
exportTypes
Type: System.Collections.GenericHashSetSavingType
Structure defining which images are exported.
saveValidOnly (Optional)
Type: SystemBoolean
true if only valid holograms are saved; otherwise, false.
progress (Optional)
Type: SystemIProgressSingle
IProgress object used to track the saving process. [0 - 100%]
startIndex (Optional)
Type: SystemInt32
The starting hologram index between 0 and NumberOfHolograms excluded.
endIndex (Optional)
Type: SystemInt32
The ending index between 0 and NumberOfHolograms excluded.

Return Value

Type: Task
The task saving the sequence.
Exceptions
ExceptionCondition
InvalidOperationExceptionThe current state does not allow the method to be called.
FileLoadExceptionReference hologram could not be loaded.
Remarks

Sets CurrentState value first to Saving, then to Saved or previous state if an error occurs.

Can only be called when CurrentState is Loaded, Recorded or Saved.

See Also