ob::Device Class Reference

#include <Device.hpp>

Inheritance diagram for ob::Device:

Public Types
typedef std::function< void(OBFwUpdateState state, const char *message, uint8_t percent)>	DeviceFwUpdateCallback
	Callback function for device firmware update progress.
typedef std::function< void(OBDeviceState state, const char *message)>	DeviceStateChangedCallback
	Callback function for device status updates.

Public Member Functions
	Device (ob_device_t *impl)
	Describe the entity of the RGBD camera, representing a specific model of RGBD camera.
	Device (Device &&other) noexcept
Device &	operator= (Device &&other) noexcept
	Device (const Device &)=delete
Device &	operator= (const Device &)=delete
virtual	~Device () noexcept
ob_device_t *	getImpl () const
std::shared_ptr< DeviceInfo >	getDeviceInfo () const
	Get device information.
bool	isExtensionInfoExist (const std::string &infoKey) const
	Check if the extension information is exist.
const char *	getExtensionInfo (const std::string &infoKey) const
	Get information about extensions obtained from SDK supported by the device.
std::shared_ptr< SensorList >	getSensorList () const
	Get device sensor list.
std::shared_ptr< Sensor >	getSensor (OBSensorType type) const
	Get specific type of sensor if device not open, SDK will automatically open the connected device and return to the instance.
void	setIntProperty (OBPropertyID propertyId, int32_t value) const
	Set int type of device property.
void	setFloatProperty (OBPropertyID propertyId, float value) const
	Set float type of device property.
void	setBoolProperty (OBPropertyID propertyId, bool value) const
	Set bool type of device property.
int32_t	getIntProperty (OBPropertyID propertyId) const
	Get int type of device property.
float	getFloatProperty (OBPropertyID propertyId) const
	Get float type of device property.
bool	getBoolProperty (OBPropertyID propertyId) const
	Get bool type of device property.
OBIntPropertyRange	getIntPropertyRange (OBPropertyID propertyId) const
	Get int type device property range (including current value and default value).
OBFloatPropertyRange	getFloatPropertyRange (OBPropertyID propertyId) const
	Get float type device property range((including current value and default value).
OBBoolPropertyRange	getBoolPropertyRange (OBPropertyID propertyId) const
	Get bool type device property range (including current value and default value).
void	setStructuredData (OBPropertyID propertyId, const uint8_t *data, uint32_t dataSize) const
	Set the structured data type of a device property.
void	getStructuredData (OBPropertyID propertyId, uint8_t *data, uint32_t *dataSize) const
	Get the structured data type of a device property.
bool	isLicenseAuthorizationSupported () const
	Check whether the device supports license authorization.
void	writeLicenseInfo (const std::string &licenseInfo) const
	Write signed device license information.
void	clearLicenseInfo () const
	Clear license information stored on the device.
std::string	readLicenseInfo () const
	Read signed device license information as SDK license_info JSON.
void	writeCustomerData (const void *data, uint32_t dataSize)
	Set the customer data type of a device property.
void	readCustomerData (void *data, uint32_t *dataSize)
	Get the customer data type of a device property.
int	getSupportedPropertyCount () const
	Get the number of properties supported by the device.
OBPropertyItem	getSupportedProperty (uint32_t index) const
	Get the supported properties of the device.
bool	isPropertySupported (OBPropertyID propertyId, OBPermissionType permission) const
	Check if a property permission is supported.
bool	isGlobalTimestampSupported () const
	Check if the global timestamp is supported for the device.
void	enableGlobalTimestamp (bool enable)
	Enable or disable the global timestamp.
void	updateFirmware (const char *filePath, DeviceFwUpdateCallback callback, bool async=true)
	Update the device firmware.
void	updateFirmwareFromData (const uint8_t *firmwareData, uint32_t firmwareDataSize, DeviceFwUpdateCallback callback, bool async=true)
	Update the device firmware from data.
void	updateOptionalDepthPresets (const char filePathList[][OB_PATH_MAX], uint8_t pathCount, DeviceFwUpdateCallback callback)
	Update the device optional depth presets.
void	updateOptionalDepthPresets (const std::vector< std::vector< uint8_t > > &dataList, DeviceFwUpdateCallback callback)
	Update the device optional depth presets from data loaded in memory.
void	setDeviceStateChangedCallback (DeviceStateChangedCallback callback)
	Set the device state changed callbacks.
OBDepthWorkMode	getCurrentDepthWorkMode () const
	Get current depth work mode.
const char *	getCurrentDepthModeName ()
	Get current depth mode name.
OBStatus	switchDepthWorkMode (const OBDepthWorkMode &workMode) const
	Switch depth work mode by OBDepthWorkMode. Prefer invoke switchDepthWorkMode(const char *modeName) to switch depth mode when known the complete name of depth work mode.
OBStatus	switchDepthWorkMode (const char *modeName) const
	Switch depth work mode by work mode name.
std::shared_ptr< OBDepthWorkModeList >	getDepthWorkModeList () const
	Request support depth work mode list.
bool	isColorPresetSupported () const
	Check if the device supports color preset.
const char *	getCurrentColorPresetName () const
	Get the current color preset name.
void	switchColorPreset (const char *presetName) const
	Switch the color preset by name.
std::shared_ptr< ColorPresetList >	getColorPresetList () const
	Get the available color preset list.
void	reboot () const
	Device restart.
void	reboot (uint32_t delayMs) const
	Device restart delay mode.
bool	syncDeviceHardwarePPSTime (uint64_t hardwarePPSTime) const
	synchronization the device time (synchronize hardwarePPS time to device)
void	enableHeartbeat (bool enable) const
	Enable or disable the device heartbeat.
void	enableFirmwareLog (bool enable) const
	Enable or disable the device firmware log. If the device does not support firmware log, an exception is thrown.
bool	isFirmwareLogEnabled () const
	Check whether the device firmware log is enabled.
void	setMonitorPollInterval (uint32_t intervalMs) const
	Set the device monitor polling interval.
uint32_t	getMonitorPollInterval () const
	Get the device monitor polling interval.
uint16_t	getSupportedMultiDeviceSyncModeBitmap () const
	Get the supported multi device sync mode bitmap of the device.
void	setMultiDeviceSyncConfig (const OBMultiDeviceSyncConfig &config) const
	set the multi device sync configuration of the device.
OBMultiDeviceSyncConfig	getMultiDeviceSyncConfig () const
	get the multi device sync configuration of the device.
void	triggerCapture () const
	send the capture command to the device.
void	setTimestampResetConfig (const OBDeviceTimestampResetConfig &config) const
	set the timestamp reset configuration of the device.
OBDeviceTimestampResetConfig	getTimestampResetConfig () const
	get the timestamp reset configuration of the device.
void	timestampReset () const
	send the timestamp reset command to the device.
void	timerReset () const
	Alias for timestampReset() since it is more accurate.
void	timerSyncWithHost () const
	synchronize the timer of the device with the host.
const char *	getCurrentPresetName () const
	Get current preset name.
void	loadPreset (const char *presetName) const
	load the preset according to the preset name.
void	loadPreset (const char *presetName, const char *version) const
	load the preset by preset name and the target depth work mode version. The version is forwarded to the depth work mode switch when loading the preset.
const char *	getCurrentPresetDepthWorkModeVersion () const
	Get the version of the current depth work mode.
std::shared_ptr< DevicePresetList >	getAvailablePresetList () const
	Get available preset list.
void	loadPresetFromJsonFile (const char *filePath) const
	Load custom preset from file.
void	loadPresetFromJsonData (const char *presetName, const uint8_t *data, uint32_t size)
	Load custom preset from data.
void	exportSettingsAsPresetJsonData (const char *presetName, const uint8_t **data, uint32_t *dataSize)
	Export current device settings as a preset json data.
void	exportSettingsAsPresetJsonFile (const char *filePath) const
	Export current device settings as a preset json file.
OBDeviceState	getDeviceState ()
	Get the current device status.
void	sendAndReceiveData (const uint8_t *sendData, uint32_t sendDataSize, uint8_t *receiveData, uint32_t *receiveDataSize) const
	Send data to the device and receive data from the device.
bool	isFrameInterleaveSupported () const
	Check if the device supports the frame interleave feature.
void	loadFrameInterleave (const char *frameInterleaveName) const
	load the frame interleave according to frame interleave name.
OB_EXPORT const char *	getCurrentFrameInterleaveName () const
	Get current frame interleave name.
std::shared_ptr< DeviceFrameInterleaveList >	getAvailableFrameInterleaveList () const
	Get available frame interleave list.
std::shared_ptr< PresetResolutionConfigList >	getAvailablePresetResolutionConfigList () const
	Get the available preset resolution config list.
void	deviceUpgrade (const char *filePath, DeviceFwUpdateCallback callback, bool async=true)
void	deviceUpgradeFromData (const uint8_t *firmwareData, uint32_t firmwareDataSize, DeviceFwUpdateCallback callback, bool async=true)
std::shared_ptr< CameraParamList >	getCalibrationCameraParamList ()
void	loadDepthFilterConfig (const char *filePath)

Static Public Member Functions
static void	deviceStateChangedCallback (OBDeviceState state, const char *message, void *userData)

Protected Attributes
ob_device *	impl_ = nullptr
DeviceStateChangedCallback	deviceStateChangeCallback_
DeviceFwUpdateCallback	fwUpdateCallback_

Detailed Description

Definition at line 36 of file Device.hpp.

Member Typedef Documentation

DeviceFwUpdateCallback

typedef std::function<void(OBFwUpdateState state, const char *message, uint8_t percent)> ob::Device::DeviceFwUpdateCallback

Callback function for device firmware update progress.

Parameters

[in]	state	The device firmware update status.
[in]	message	Status information.
[in]	percent	The percentage of the update progress.

Definition at line 45 of file Device.hpp.

DeviceStateChangedCallback

typedef std::function<void(OBDeviceState state, const char *message)> ob::Device::DeviceStateChangedCallback

Callback function for device status updates.

Parameters

[in]	state	The device status.
[in]	message	Status information.

Definition at line 53 of file Device.hpp.

Constructor & Destructor Documentation

Device() [1/3]

ob::Device::Device ( ob_device_t * impl )

inlineexplicit

Describe the entity of the RGBD camera, representing a specific model of RGBD camera.

Definition at line 64 of file Device.hpp.

Referenced by Device(), Device(), deviceStateChangedCallback(), operator=(), operator=(), ob::PlaybackDevice::PlaybackDevice(), and ob::PlaybackDevice::PlaybackDevice().

Device() [2/3]

ob::Device::Device ( Device && other )

inlinenoexcept

Definition at line 66 of file Device.hpp.

Device() [3/3]

ob::Device::Device ( const Device & )

delete

~Device()

virtual ob::Device::~Device ( )

inlinevirtualnoexcept

Definition at line 84 of file Device.hpp.

Member Function Documentation

operator=() [1/2]

Device & ob::Device::operator= ( Device && other )

inlinenoexcept

Definition at line 70 of file Device.hpp.

Referenced by ob::PlaybackDevice::operator=().

operator=() [2/2]

Device & ob::Device::operator= ( const Device & )

delete

getImpl()

ob_device_t * ob::Device::getImpl ( ) const

inline

Definition at line 90 of file Device.hpp.

getDeviceInfo()

std::shared_ptr< DeviceInfo > ob::Device::getDeviceInfo ( ) const

inline

Get device information.

Returns

std::shared_ptr<DeviceInfo> return device information

Definition at line 99 of file Device.hpp.

isExtensionInfoExist()

bool ob::Device::isExtensionInfoExist ( const std::string & infoKey ) const

inline

Check if the extension information is exist.

Parameters

[in]

infoKey

The key of the extension information

Returns

bool Whether the extension information exists

Definition at line 113 of file Device.hpp.

getExtensionInfo()

const char * ob::Device::getExtensionInfo ( const std::string & infoKey ) const

inline

Get information about extensions obtained from SDK supported by the device.

Parameters

[in]

infoKey

The key of the extension information

Returns

const char* Returns extended information about the device

Definition at line 127 of file Device.hpp.

getSensorList()

std::shared_ptr< SensorList > ob::Device::getSensorList ( ) const

inline

Get device sensor list.

Returns

std::shared_ptr<SensorList> return the sensor list

Definition at line 139 of file Device.hpp.

getSensor()

std::shared_ptr< Sensor > ob::Device::getSensor ( OBSensorType type ) const

inline

Get specific type of sensor if device not open, SDK will automatically open the connected device and return to the instance.

Returns

std::shared_ptr<Sensor> return the sensor example, if the device does not have the device,return nullptr

Definition at line 152 of file Device.hpp.

setIntProperty()

void ob::Device::setIntProperty ( OBPropertyID propertyId, int32_t value ) const

inline

Set int type of device property.

Parameters

[in]	propertyId	Property id
[in]	value	Property value to be set

Definition at line 165 of file Device.hpp.

Referenced by reboot().

setFloatProperty()

void ob::Device::setFloatProperty ( OBPropertyID propertyId, float value ) const

inline

Set float type of device property.

Parameters

[in]	propertyId	Property id
[in]	value	Property value to be set

Definition at line 177 of file Device.hpp.

setBoolProperty()

void ob::Device::setBoolProperty ( OBPropertyID propertyId, bool value ) const

inline

Set bool type of device property.

Parameters

[in]	propertyId	Property id
[in]	value	Property value to be set

Definition at line 189 of file Device.hpp.

getIntProperty()

int32_t ob::Device::getIntProperty ( OBPropertyID propertyId ) const

inline

Get int type of device property.

Parameters

[in]

propertyId

Property id

Returns

int32_t Property to get

Definition at line 202 of file Device.hpp.

getFloatProperty()

float ob::Device::getFloatProperty ( OBPropertyID propertyId ) const

inline

Get float type of device property.

Parameters

[in]

propertyId

Property id

Returns

float Property to get

Definition at line 216 of file Device.hpp.

getBoolProperty()

bool ob::Device::getBoolProperty ( OBPropertyID propertyId ) const

inline

Get bool type of device property.

Parameters

[in]

propertyId

Property id

Returns

bool Property to get

Definition at line 230 of file Device.hpp.

getIntPropertyRange()

OBIntPropertyRange ob::Device::getIntPropertyRange ( OBPropertyID propertyId ) const

inline

Get int type device property range (including current value and default value).

Parameters

[in]

propertyId

Property id

Returns

OBIntPropertyRange Property range

Definition at line 244 of file Device.hpp.

getFloatPropertyRange()

OBFloatPropertyRange ob::Device::getFloatPropertyRange ( OBPropertyID propertyId ) const

inline

Get float type device property range((including current value and default value).

Parameters

[in]

propertyId

Property id

Returns

OBFloatPropertyRange Property range

Definition at line 258 of file Device.hpp.

getBoolPropertyRange()

OBBoolPropertyRange ob::Device::getBoolPropertyRange ( OBPropertyID propertyId ) const

inline

Get bool type device property range (including current value and default value).

Parameters

[in]

propertyId

The ID of the property

Returns

OBBoolPropertyRange The range of the property

Definition at line 272 of file Device.hpp.

setStructuredData()

void ob::Device::setStructuredData ( OBPropertyID propertyId, const uint8_t * data, uint32_t dataSize ) const

inline

Set the structured data type of a device property.

Parameters

[in]	propertyId	The ID of the property
[in]	data	The data to set
[in]	dataSize	The size of the data to set

Definition at line 286 of file Device.hpp.

getStructuredData()

void ob::Device::getStructuredData ( OBPropertyID propertyId, uint8_t * data, uint32_t * dataSize ) const

inline

Get the structured data type of a device property.

Parameters

[in]	propertyId	The ID of the property
[out]	data	The property data obtained
[out]	dataSize	The size of the data obtained

Definition at line 299 of file Device.hpp.

isLicenseAuthorizationSupported()

bool ob::Device::isLicenseAuthorizationSupported ( ) const

inline

Check whether the device supports license authorization.

Returns

true if the device supports license authorization, false otherwise.

Definition at line 310 of file Device.hpp.

writeLicenseInfo()

void ob::Device::writeLicenseInfo ( const std::string & licenseInfo ) const

inline

Write signed device license information.

Parameters

[in]

licenseInfo

SDK license_info JSON string

Definition at line 322 of file Device.hpp.

clearLicenseInfo()

void ob::Device::clearLicenseInfo ( ) const

inline

Clear license information stored on the device.

Definition at line 331 of file Device.hpp.

readLicenseInfo()

std::string ob::Device::readLicenseInfo ( ) const

inline

Read signed device license information as SDK license_info JSON.

Returns

std::string SDK license_info JSON string

Definition at line 342 of file Device.hpp.

writeCustomerData()

void ob::Device::writeCustomerData ( const void * data, uint32_t dataSize )

inline

Set the customer data type of a device property.

Parameters

[in]	data	The data to set
[in]	dataSize	The size of the data to set,the maximum length cannot exceed 65532 bytes.

Definition at line 356 of file Device.hpp.

readCustomerData()

void ob::Device::readCustomerData ( void * data, uint32_t * dataSize )

inline

Get the customer data type of a device property.

Parameters

[in]	data	The property data obtained
[in]	dataSize	The size of the data obtained

Definition at line 368 of file Device.hpp.

getSupportedPropertyCount()

int ob::Device::getSupportedPropertyCount ( ) const

inline

Get the number of properties supported by the device.

Returns

The number of supported properties

Definition at line 379 of file Device.hpp.

getSupportedProperty()

OBPropertyItem ob::Device::getSupportedProperty ( uint32_t index ) const

inline

Get the supported properties of the device.

Parameters

[in]

index

The index of the property

Returns

The type of supported property

Definition at line 393 of file Device.hpp.

isPropertySupported()

bool ob::Device::isPropertySupported ( OBPropertyID propertyId, OBPermissionType permission ) const

inline

Check if a property permission is supported.

Parameters

[in]	propertyId	The ID of the property
[in]	permission	The read and write permissions to check

Returns

Whether the property permission is supported

Definition at line 408 of file Device.hpp.

isGlobalTimestampSupported()

bool ob::Device::isGlobalTimestampSupported ( ) const

inline

Check if the global timestamp is supported for the device.

Returns

Whether the global timestamp is supported

Definition at line 420 of file Device.hpp.

enableGlobalTimestamp()

void ob::Device::enableGlobalTimestamp ( bool enable )

inline

Enable or disable the global timestamp.

Parameters

[in]

enable

Whether to enable the global timestamp

Definition at line 432 of file Device.hpp.

updateFirmware()

void ob::Device::updateFirmware ( const char * filePath, DeviceFwUpdateCallback callback, bool async = true )

inline

Update the device firmware.

Attention

Only one firmware/preset update may run per device at a time

Parameters

[in]	filePath	Firmware path
[in]	callback	Firmware Update progress and status callback
[in]	async	Whether to execute asynchronously

Definition at line 447 of file Device.hpp.

Referenced by deviceUpgrade().

updateFirmwareFromData()

void ob::Device::updateFirmwareFromData ( const uint8_t * firmwareData, uint32_t firmwareDataSize, DeviceFwUpdateCallback callback, bool async = true )

inline

Update the device firmware from data.

Attention

Only one firmware/preset update may run per device at a time

Parameters

[in]	firmwareData	Firmware data
[in]	firmwareDataSize	Firmware data size
[in]	callback	Firmware Update progress and status callback
[in]	async	Whether to execute asynchronously

Definition at line 464 of file Device.hpp.

Referenced by deviceUpgradeFromData().

updateOptionalDepthPresets() [1/2]

void ob::Device::updateOptionalDepthPresets ( const char filePathList[][OB_PATH_MAX], uint8_t pathCount, DeviceFwUpdateCallback callback )

inline

Update the device optional depth presets.

Attention

Only one firmware/preset update may run per device at a time

Parameters

[in]	filePathList	A list(2D array) of preset file paths, each up to OB_PATH_MAX characters.
[in]	pathCount	The number of the preset file paths.
[in]	callback	Preset update progress and status callback

Definition at line 480 of file Device.hpp.

updateOptionalDepthPresets() [2/2]

void ob::Device::updateOptionalDepthPresets ( const std::vector< std::vector< uint8_t > > & dataList, DeviceFwUpdateCallback callback )

inline

Update the device optional depth presets from data loaded in memory.

Attention

Only one firmware/preset update may run per device at a time

Parameters

[in]	dataList	A list of preset data blocks, each holding the raw bytes of one preset.
[in]	callback	Preset update progress and status callback

Definition at line 495 of file Device.hpp.

setDeviceStateChangedCallback()

void ob::Device::setDeviceStateChangedCallback ( DeviceStateChangedCallback callback )

inline

Set the device state changed callbacks.

Parameters

[in]

callback

The callback function that is triggered when the device status changes (for example, the frame rate is automatically reduced or the stream is closed due to high temperature, etc.)

Definition at line 514 of file Device.hpp.

deviceStateChangedCallback()

void ob::Device::deviceStateChangedCallback ( OBDeviceState state, const char * message, void * userData )

inlinestatic

Definition at line 521 of file Device.hpp.

Referenced by setDeviceStateChangedCallback().

getCurrentDepthWorkMode()

OBDepthWorkMode ob::Device::getCurrentDepthWorkMode ( ) const

inline

Get current depth work mode.

Returns

ob_depth_work_mode Current depth work mode

Definition at line 531 of file Device.hpp.

getCurrentDepthModeName()

const char * ob::Device::getCurrentDepthModeName ( )

inline

Get current depth mode name.

According the current preset name to return current depth mode name

Returns

const char* return the current depth mode name.

Definition at line 544 of file Device.hpp.

switchDepthWorkMode() [1/2]

OBStatus ob::Device::switchDepthWorkMode ( const OBDepthWorkMode & workMode ) const

inline

Switch depth work mode by OBDepthWorkMode. Prefer invoke switchDepthWorkMode(const char *modeName) to switch depth mode when known the complete name of depth work mode.

Parameters

[in]

workMode

Depth work mode come from ob_depth_work_mode_list which return by ob_device_get_depth_work_mode_list

Definition at line 556 of file Device.hpp.

switchDepthWorkMode() [2/2]

OBStatus ob::Device::switchDepthWorkMode ( const char * modeName ) const

inline

Switch depth work mode by work mode name.

Parameters

[in]

modeName

Depth work mode name which equals to OBDepthWorkMode.name

Definition at line 568 of file Device.hpp.

getDepthWorkModeList()

std::shared_ptr< OBDepthWorkModeList > ob::Device::getDepthWorkModeList ( ) const

inline

Request support depth work mode list.

Returns

OBDepthWorkModeList list of ob_depth_work_mode

Definition at line 580 of file Device.hpp.

isColorPresetSupported()

bool ob::Device::isColorPresetSupported ( ) const

inline

Check if the device supports color preset.

Returns

bool Returns true if the device supports color preset.

Definition at line 592 of file Device.hpp.

getCurrentColorPresetName()

const char * ob::Device::getCurrentColorPresetName ( ) const

inline

Get the current color preset name.

Returns

const char* The current color preset name.

Definition at line 604 of file Device.hpp.

switchColorPreset()

void ob::Device::switchColorPreset ( const char * presetName ) const

inline

Switch the color preset by name.

Parameters

[in]

presetName

The color preset name.

Definition at line 616 of file Device.hpp.

getColorPresetList()

std::shared_ptr< ColorPresetList > ob::Device::getColorPresetList ( ) const

inline

Get the available color preset list.

Returns

std::shared_ptr<ColorPresetList> The color preset list.

Definition at line 627 of file Device.hpp.

reboot() [1/2]

void ob::Device::reboot ( ) const

inline

Device restart.

Attention

The device will be disconnected and reconnected. After the device is disconnected, the access to the Device object interface may be abnormal. Please delete the object directly and obtain it again after the device is reconnected.

Definition at line 639 of file Device.hpp.

Referenced by reboot().

reboot() [2/2]

void ob::Device::reboot ( uint32_t delayMs ) const

inline

Device restart delay mode.

Attention

The device will be disconnected and reconnected. After the device is disconnected, the access to the Device object interface may be abnormal. Please delete the object directly and obtain it again after the device is reconnected. Support devices: Gemini2 L

Parameters

[in]

delayMs

Time unit: ms. delayMs == 0: No delay; delayMs > 0, Delay millisecond connect to host device after reboot

Definition at line 653 of file Device.hpp.

syncDeviceHardwarePPSTime()

bool ob::Device::syncDeviceHardwarePPSTime ( uint64_t hardwarePPSTime ) const

inline

synchronization the device time (synchronize hardwarePPS time to device)

Parameters

[in]

hardwarePPSTime

unit:ms

Returns

Whether the synchronisation is successful

Definition at line 663 of file Device.hpp.

enableHeartbeat()

void ob::Device::enableHeartbeat ( bool enable ) const

inline

Enable or disable the device heartbeat.

When enabled, the SDK sends heartbeat signals at the device monitor polling interval. The default interval is 3000 ms and can be adjusted with setMonitorPollInterval. If the device does not support heartbeat, an exception is thrown.

Attention

If the device does not receive the heartbeat signal for a long time, it will be disconnected and rebooted.

Parameters

[in]

enable

Whether to enable the device heartbeat.

Definition at line 680 of file Device.hpp.

enableFirmwareLog()

void ob::Device::enableFirmwareLog ( bool enable ) const

inline

Enable or disable the device firmware log. If the device does not support firmware log, an exception is thrown.

Parameters

[in]

enable

Whether to enable the firmware log.

Definition at line 691 of file Device.hpp.

isFirmwareLogEnabled()

bool ob::Device::isFirmwareLogEnabled ( ) const

inline

Check whether the device firmware log is enabled.

Returns

bool Whether the firmware log is enabled.

Definition at line 702 of file Device.hpp.

setMonitorPollInterval()

void ob::Device::setMonitorPollInterval ( uint32_t intervalMs ) const

inline

Set the device monitor polling interval.

Parameters

[in]

intervalMs

The polling interval for device heartbeat and firmware log retrieval, in milliseconds. The valid range is [1000, 10000]; values outside this range are clamped to the nearest bound. If the device does not support device monitor polling, an exception is thrown.

Definition at line 715 of file Device.hpp.

getMonitorPollInterval()

uint32_t ob::Device::getMonitorPollInterval ( ) const

inline

Get the device monitor polling interval.

Returns

uint32_t The device monitor polling interval in milliseconds.

Exceptions

Error

If the device does not support device monitor polling.

Definition at line 727 of file Device.hpp.

getSupportedMultiDeviceSyncModeBitmap()

uint16_t ob::Device::getSupportedMultiDeviceSyncModeBitmap ( ) const

inline

Get the supported multi device sync mode bitmap of the device.

For example, if the return value is 0b00001100, it means the device supports OB_MULTI_DEVICE_SYNC_MODE_PRIMARY and OB_MULTI_DEVICE_SYNC_MODE_SECONDARY. User can check the supported mode by the code:

if(supported_mode_bitmap & OB_MULTI_DEVICE_SYNC_MODE_FREE_RUN){
//support OB_MULTI_DEVICE_SYNC_MODE_FREE_RUN
}
if(supported_mode_bitmap & OB_MULTI_DEVICE_SYNC_MODE_STANDALONE){
//support OB_MULTI_DEVICE_SYNC_MODE_STANDALONE
}
// and so on

Returns

uint16_t return the supported multi device sync mode bitmap of the device.

Definition at line 749 of file Device.hpp.

setMultiDeviceSyncConfig()

void ob::Device::setMultiDeviceSyncConfig ( const OBMultiDeviceSyncConfig & config ) const

inline

set the multi device sync configuration of the device.

Parameters

[in]

config

The multi device sync configuration.

Definition at line 761 of file Device.hpp.

getMultiDeviceSyncConfig()

OBMultiDeviceSyncConfig ob::Device::getMultiDeviceSyncConfig ( ) const

inline

get the multi device sync configuration of the device.

Returns

OBMultiDeviceSyncConfig return the multi device sync configuration of the device.

Definition at line 772 of file Device.hpp.

triggerCapture()

void ob::Device::triggerCapture ( ) const

inline

send the capture command to the device.

The device will start one time image capture after receiving the capture command when it is in the OB_MULTI_DEVICE_SYNC_MODE_SOFTWARE_TRIGGERING

Attention

The frequency of the user call this function multiplied by the number of frames per trigger should be less than the frame rate of the stream. The number of frames per trigger can be set by OBMultiDeviceSyncConfig::framesPerTrigger.

For some models, receive and execute the capture command will have a certain delay and performance consumption, so the frequency of calling this function should not be too high, please refer to the product manual for the specific supported frequency.

If the device is not in the OB_MULTI_DEVICE_SYNC_MODE_HARDWARE_TRIGGERING mode, device will ignore the capture command.

Definition at line 790 of file Device.hpp.

setTimestampResetConfig()

void ob::Device::setTimestampResetConfig ( const OBDeviceTimestampResetConfig & config ) const

inline

set the timestamp reset configuration of the device.

Definition at line 799 of file Device.hpp.

getTimestampResetConfig()

OBDeviceTimestampResetConfig ob::Device::getTimestampResetConfig ( ) const

inline

get the timestamp reset configuration of the device.

Returns

OBDeviceTimestampResetConfig return the timestamp reset configuration of the device.

Definition at line 810 of file Device.hpp.

timestampReset()

void ob::Device::timestampReset ( ) const

inline

send the timestamp reset command to the device.

The device will reset the timer for calculating the timestamp for output frames to 0 after receiving the timestamp reset command when the timestamp reset function is enabled. The timestamp reset function can be enabled by call ob_device_set_timestamp_reset_config.

Before calling this function, user should call ob_device_set_timestamp_reset_config to disable the timestamp reset function (It is not required for some models, but it is still recommended to do so for code compatibility).

Attention

If the stream of the device is started, the timestamp of the continuous frames output by the stream will jump once after the timestamp reset.

Due to the timer of device is not high-accuracy, the timestamp of the continuous frames output by the stream will drift after a long time. User can call this function periodically to reset the timer to avoid the timestamp drift, the recommended interval time is 60 minutes.

Definition at line 828 of file Device.hpp.

Referenced by timerReset().

timerReset()

void ob::Device::timerReset ( ) const

inline

Alias for timestampReset() since it is more accurate.

Definition at line 837 of file Device.hpp.

timerSyncWithHost()

void ob::Device::timerSyncWithHost ( ) const

inline

synchronize the timer of the device with the host.

After calling this function, the timer of the device will be synchronized with the host. User can call this function to multiple devices to synchronize all timers of the devices.

Attention

If the stream of the device is started, the timestamp of the continuous frames output by the stream will may jump once after the timer sync.

Due to the timer of device is not high-accuracy, the timestamp of the continuous frames output by the stream will drift after a long time. User can call this function periodically to synchronize the timer to avoid the timestamp drift, the recommended interval time is 60 minutes.

Definition at line 852 of file Device.hpp.

getCurrentPresetName()

const char * ob::Device::getCurrentPresetName ( ) const

inline

Get current preset name.

The preset mean a set of parameters or configurations that can be applied to the device to achieve a specific effect or function.

Returns

const char* return the current preset name, it should be one of the preset names returned by getAvailablePresetList.

Definition at line 864 of file Device.hpp.

loadPreset() [1/2]

void ob::Device::loadPreset ( const char * presetName ) const

inline

load the preset according to the preset name.

Attention

After loading the preset, the settings in the preset will set to the device immediately. Therefore, it is recommended to re-read the device settings to update the user program temporarily.

Parameters

[in]

presetName

The preset name to set. The name should be one of the preset names returned by getAvailablePresetList.

Definition at line 877 of file Device.hpp.

loadPreset() [2/2]

void ob::Device::loadPreset ( const char * presetName, const char * version ) const

inline

load the preset by preset name and the target depth work mode version. The version is forwarded to the depth work mode switch when loading the preset.

Parameters

[in]	presetName	The preset name to set. The name should be one of the preset names returned by getAvailablePresetList.
[in]	version	The target depth work mode version string, e.g. "1.2.3". Must not be empty.

Definition at line 889 of file Device.hpp.

getCurrentPresetDepthWorkModeVersion()

const char * ob::Device::getCurrentPresetDepthWorkModeVersion ( ) const

inline

Get the version of the current depth work mode.

Returns

const char* The version string, e.g. "1.2.3". Empty string when the device does not support versioned modes.

Definition at line 901 of file Device.hpp.

getAvailablePresetList()

std::shared_ptr< DevicePresetList > ob::Device::getAvailablePresetList ( ) const

inline

Get available preset list.

The available preset list usually defined by the device manufacturer and restores on the device.

User can load the custom preset by calling loadPresetFromJsonFile to append the available preset list.

Returns

DevicePresetList return the available preset list.

Definition at line 915 of file Device.hpp.

loadPresetFromJsonFile()

void ob::Device::loadPresetFromJsonFile ( const char * filePath ) const

inline

Load custom preset from file.

After loading the custom preset, the settings in the custom preset will set to the device immediately.

After loading the custom preset, the available preset list will be appended with the custom preset and named as the file name.

Attention

The user should ensure that the custom preset file is adapted to the device and the settings in the file are valid.

It is recommended to re-read the device settings to update the user program temporarily after successfully loading the custom preset.

Parameters

[in]

filePath

The path of the custom preset file.

Definition at line 932 of file Device.hpp.

Referenced by ob::PlaybackDevice::PlaybackDevice().

loadPresetFromJsonData()

void ob::Device::loadPresetFromJsonData ( const char * presetName, const uint8_t * data, uint32_t size )

inline

Load custom preset from data.

After loading the custom preset, the settings in the custom preset will set to the device immediately.

After loading the custom preset, the available preset list will be appended with the custom preset and named as the presetName.

Attention

The user should ensure that the custom preset data is adapted to the device and the settings in the data are valid.

It is recommended to re-read the device settings to update the user program temporarily after successfully loading the custom preset.

Parameters

[in]	presetName	The name of the custome preset.
[in]	data	The custom preset data.
[in]	size	The size of the custom preset data.

Definition at line 950 of file Device.hpp.

exportSettingsAsPresetJsonData()

void ob::Device::exportSettingsAsPresetJsonData ( const char * presetName, const uint8_t ** data, uint32_t * dataSize )

inline

Export current device settings as a preset json data.

After exporting the preset, a new preset named as the presetName will be added to the available preset list.

Attention

The memory of the data is allocated by the SDK, and will automatically be released by the SDK.

The memory of the data will be reused by the SDK on the next call, so the user should copy the data to a new buffer if it needs to be preserved.

Parameters

[in]	presetName	The name of the custome preset.
[out]	data	return the preset json data.
[out]	dataSize	return the size of the preset json data.

Definition at line 967 of file Device.hpp.

exportSettingsAsPresetJsonFile()

void ob::Device::exportSettingsAsPresetJsonFile ( const char * filePath ) const

inline

Export current device settings as a preset json file.

The exported preset file can be loaded by calling loadPresetFromJsonFile to restore the device setting.

After exporting the preset, a new preset named as the filePath will be added to the available preset list.

Parameters

[in]

filePath

The path of the preset file to be exported.

Definition at line 979 of file Device.hpp.

getDeviceState()

OBDeviceState ob::Device::getDeviceState ( )

inline

Get the current device status.

Returns

OBDeviceState The device state information.

Definition at line 990 of file Device.hpp.

sendAndReceiveData()

void ob::Device::sendAndReceiveData ( const uint8_t * sendData, uint32_t sendDataSize, uint8_t * receiveData, uint32_t * receiveDataSize ) const

inline

Send data to the device and receive data from the device.

This is a factory and debug function, which can be used to send and receive data from the device. The data format is secret and belongs to the device vendor.

Attention

The send and receive data buffer are managed by the caller, the receive data buffer should be allocated at 1024 bytes or larger.

Parameters

[in]	sendData	The data to be sent to the device.
[in]	sendDataSize	The size of the data to be sent to the device.
[out]	receiveData	The data received from the device.
[in,out]	receiveDataSize	The requeseted size of the data received from the device, and the actual size of the data received from the device.

Definition at line 1009 of file Device.hpp.

isFrameInterleaveSupported()

bool ob::Device::isFrameInterleaveSupported ( ) const

inline

Check if the device supports the frame interleave feature.

Returns

bool Returns true if the device supports the frame interleave feature.

Definition at line 1020 of file Device.hpp.

loadFrameInterleave()

void ob::Device::loadFrameInterleave ( const char * frameInterleaveName ) const

inline

load the frame interleave according to frame interleave name.

Parameters

[in]

frameInterleaveName

The frame interleave name to set. The name should be one of the frame interleave names returned by getAvailableFrameInterleaveList.

Definition at line 1032 of file Device.hpp.

getCurrentFrameInterleaveName()

OB_EXPORT const char * ob::Device::getCurrentFrameInterleaveName ( ) const

inline

Get current frame interleave name.

Parameters

[in]	device	The device object.
[out]	error	Pointer to an error object that will be set if an error occurs.

Returns

const char* return the current frame interleave name. Returns an empty string ("") if no interleave is loaded. Returns nullptr if an error occurs.

Definition at line 1049 of file Device.hpp.

getAvailableFrameInterleaveList()

std::shared_ptr< DeviceFrameInterleaveList > ob::Device::getAvailableFrameInterleaveList ( ) const

inline

Get available frame interleave list.

Returns

DeviceFrameInterleaveList return the available frame interleave list.

Definition at line 1061 of file Device.hpp.

getAvailablePresetResolutionConfigList()

std::shared_ptr< PresetResolutionConfigList > ob::Device::getAvailablePresetResolutionConfigList ( ) const

inline

Get the available preset resolution config list.

Returns

PresetResolutionConfigList return the available preset resolution config list.

Definition at line 1073 of file Device.hpp.

deviceUpgrade()

void ob::Device::deviceUpgrade ( const char * filePath, DeviceFwUpdateCallback callback, bool async = true )

inline

Definition at line 1090 of file Device.hpp.

deviceUpgradeFromData()

void ob::Device::deviceUpgradeFromData ( const uint8_t * firmwareData, uint32_t firmwareDataSize, DeviceFwUpdateCallback callback, bool async = true )

inline

Definition at line 1094 of file Device.hpp.

getCalibrationCameraParamList()

std::shared_ptr< CameraParamList > ob::Device::getCalibrationCameraParamList ( )

inline

Definition at line 1098 of file Device.hpp.

loadDepthFilterConfig()

void ob::Device::loadDepthFilterConfig ( const char * filePath )

inline

Definition at line 1105 of file Device.hpp.

Member Data Documentation

impl_

ob_device* ob::Device::impl_ = nullptr

protected

Definition at line 56 of file Device.hpp.

Referenced by clearLicenseInfo(), Device(), Device(), enableFirmwareLog(), enableGlobalTimestamp(), enableHeartbeat(), exportSettingsAsPresetJsonData(), exportSettingsAsPresetJsonFile(), getAvailableFrameInterleaveList(), getAvailablePresetList(), getAvailablePresetResolutionConfigList(), getBoolProperty(), getBoolPropertyRange(), getCalibrationCameraParamList(), getColorPresetList(), getCurrentColorPresetName(), getCurrentDepthModeName(), getCurrentDepthWorkMode(), getCurrentFrameInterleaveName(), getCurrentPresetDepthWorkModeVersion(), getCurrentPresetName(), getDepthWorkModeList(), getDeviceInfo(), getDeviceState(), ob::PlaybackDevice::getDuration(), getExtensionInfo(), getFloatProperty(), getFloatPropertyRange(), getImpl(), getIntProperty(), getIntPropertyRange(), getMonitorPollInterval(), getMultiDeviceSyncConfig(), ob::PlaybackDevice::getPlaybackStatus(), ob::PlaybackDevice::getPosition(), getSensor(), getSensorList(), getStructuredData(), getSupportedMultiDeviceSyncModeBitmap(), getSupportedProperty(), getSupportedPropertyCount(), getTimestampResetConfig(), isColorPresetSupported(), isExtensionInfoExist(), isFirmwareLogEnabled(), isFrameInterleaveSupported(), isGlobalTimestampSupported(), isLicenseAuthorizationSupported(), isPropertySupported(), loadFrameInterleave(), loadPreset(), loadPreset(), loadPresetFromJsonData(), loadPresetFromJsonFile(), operator=(), ob::PlaybackDevice::pause(), ob::PlaybackDevice::PlaybackDevice(), readCustomerData(), readLicenseInfo(), reboot(), ob::PlaybackDevice::resume(), ob::PlaybackDevice::seek(), sendAndReceiveData(), setBoolProperty(), setDeviceStateChangedCallback(), setFloatProperty(), setIntProperty(), setMonitorPollInterval(), setMultiDeviceSyncConfig(), ob::PlaybackDevice::setPlaybackRate(), ob::PlaybackDevice::setPlaybackStatusChangeCallback(), setStructuredData(), setTimestampResetConfig(), switchColorPreset(), switchDepthWorkMode(), switchDepthWorkMode(), syncDeviceHardwarePPSTime(), timerSyncWithHost(), timestampReset(), triggerCapture(), updateFirmware(), updateFirmwareFromData(), updateOptionalDepthPresets(), updateOptionalDepthPresets(), writeCustomerData(), writeLicenseInfo(), and ~Device().

deviceStateChangeCallback_

DeviceStateChangedCallback ob::Device::deviceStateChangeCallback_

protected

Definition at line 57 of file Device.hpp.

Referenced by setDeviceStateChangedCallback().

fwUpdateCallback_

DeviceFwUpdateCallback ob::Device::fwUpdateCallback_

protected

Definition at line 58 of file Device.hpp.

Referenced by updateFirmware(), updateFirmwareFromData(), updateOptionalDepthPresets(), and updateOptionalDepthPresets().

---

The documentation for this class was generated from the following file:

• Device.hpp