DELTA_Status

DELTA_Status defines the common return codes used across the DELTA SDK. Most API functions return delta::Status, so applications can handle success, invalid arguments, device errors, file errors, timeout conditions, and other failures in a consistent way.

Back to API overview.

Function

Function Purpose
getStatusMessage() Convert a Status value into a readable message.

Status codes

Status Value Meaning
Status::Success 0 The operation completed successfully.
Status::Error_InvalidArgument 1 A required pointer, handle, path, index, or parameter value is invalid.
Status::Error_NotInitialized 2 The SDK object or internal state needed for the operation is not ready.
Status::Error_NotStarted 3 The operation requires live streaming or playback to be started first.
Status::Error_AlreadyDone 4 The requested operation has already been completed.
Status::Error_Unsupported 5 The requested operation or option is not supported by the current source.
Status::Error_Timeout 6 The operation waited too long for data, USB transfer, or internal processing.
Status::Error_NoData 7 No output data is currently available. This can happen before the next generated frame is ready.
Status::Error_SystemRunning 8 The operation cannot be performed while streaming, playback, or saving is active.
Status::Error_UnsetBias 9 Sensor bias settings have not been applied before a stream-dependent operation.
Status::Error_BufferTooSmall 10 The caller-owned output buffer is smaller than the required size.
Status::Error_DeviceBusy 100 The Delta series camera or USB resource is already in use.
Status::Error_InvalidDevice 101 The device handle is invalid or no longer usable.
Status::Error_DeviceNotFound 102 No matching Delta series camera was found for the requested index or operation.
Status::Error_TooManyDevices 103 More connected devices were detected than the SDK can handle.
Status::Error_OpenUsbFailed 104 The SDK failed to open the USB device.
Status::Error_TransferFailed 105 USB data transfer failed while reading or streaming data.
Status::Error_ReadRegFailed 106 A sensor or device register read failed.
Status::Error_WriteRegFailed 107 A sensor or device register write failed.
Status::Error_FileOpenFailed 200 The SDK failed to open the requested file.
Status::Error_FileCreateFailed 201 The SDK failed to create an output file.
Status::Error_FileReadFailed 202 File reading failed during playback or data loading.
Status::Error_FileWriteFailed 203 File writing failed during raw or frame saving.
Status::Error_FileSeekFailed 204 The SDK failed to seek within a playback or output file.
Status::Error_InvalidFile 205 The file is missing required data, has an invalid format, or is not a supported .dvs file.
Status::Error_SaveFailed 206 Saving failed for raw data or generated frame output.
Status::Error_DiskNoSpace 207 The target disk does not have enough available space.
Status::Error_Common 1000 A fallback SDK error occurred when no more specific status applies.

Example

delta::Status status = delta::scanDevices(&deviceCount);
if (status != delta::Status::Success) {
    std::cout << delta::getStatusMessage(status) << std::endl;
    return;
}