JSDoc: Class: Device

Constructor

new Device()

Source:

index.js, line 28

Members

first

Get the first sensor

Source:

index.js, line 72

isValid

Check if everything is OK, e.g. if the device object is connected to underlying hardware

Source:

index.js, line 39

Methods

destroy()

Release resources associated with the object

Source:

index.js, line 241

getCameraInfo(infoopt) → {CameraInfoObject|String|undefined}

Get camera information There are 2 acceptable forms of syntax:


 Syntax 1. getCameraInfo()
 Syntax 2. getCameraInfo(info)

Parameters:

Name	Type	Attributes	Description
`info`	String \| Integer	<optional>	the camera_info type, see camera_info for available values

Source:

index.js, line 122

Returns:

if no argument is provided, {CameraInfoObject} is returned. If a camera_info is provided, the specific camera info value string is returned.

Type: CameraInfoObject | String | undefined

querySensors() → {Array.<Sensor>}

get an array of adjacent sensors, sharing the same physical parent composite device

Source:

index.js, line 47

Returns:

Type: Array.<Sensor>

reset() → {undefined}

Send hardware reset request to the device.

Source:

index.js, line 234

Returns:

Type: undefined

supportsCameraInfo(info) → {Boolean|undefined}

Check if specific camera info is supported.

Parameters:

Name	Type	Description
`info`	String \| Integer	info type to query. See camera_info for available values

Source:

index.js, line 223

See:

enum camera_info

Returns:

Returns undefined if an invalid info type was specified.

Type: Boolean | undefined

Example

Example of 3 equivalent calls of the same query

device.supportsCameraInfo('name');
device.supportsCameraInfo(realsense2.camera_info.camera_info_name);
device.supportsCameraInfo(realsense2.camera_info.CAMERA_INFO_NAME);