JSDoc: Global

Members

(constant) camera_info :String

Enum for camera info types

Type:

String

Properties:

Name	Type	Description
`camera_info_name`	String	String literal of `'name'`. Device friendly name. Equivalent to its uppercase counterpart.
`camera_info_serial_number`	String	String literal of `'serial-number'`. Serial number. Equivalent to its uppercase counterpart.
`camera_info_firmware_version`	String	String literal of `'firmware-version'`. Primary firmware version. Equivalent to its uppercase counterpart.
`camera_info_recommended_firmware_version`	String	String literal of `'recommended-firmware-version'`. Latest firmware version available. Equivalent to its uppercase counterpart.
`camera_info_physical_port`	String	String literal of `'port'`. Unique identifier of the port the device is connected to (platform specific). Equivalent to its uppercase counterpart.
`camera_info_debug_op_code`	String	String literal of `'debug-op-code'`. If device supports firmware logging, this is the command to send to get logs from firmware. Equivalent to its uppercase counterpart.
`camera_info_advanced_mode`	String	String literal of `'advanced-mode'`. True iff the device is in advanced mode. Equivalent to its uppercase counterpart.
`camera_info_product_id`	String	String literal of `'product-id'`. Product ID as reported in the USB descriptor. Equivalent to its uppercase counterpart.
`camera_info_camera_locked`	String	String literal of `'camera-locked'`. True if EEPROM is locked. Equivalent to its uppercase counterpart.
`camera_info_usb_type_descriptor`	String	String literal of `'usb-type-descriptor'`. Designated USB specification: USB2/USB3. Equivalent to its uppercase counterpart.
`CAMERA_INFO_NAME`	Integer	Device friendly name. Equivalent to its lowercase counterpart.
`CAMERA_INFO_SERIAL_NUMBER`	Integer	Device serial number. Equivalent to its lowercase counterpart.
`CAMERA_INFO_FIRMWARE_VERSION`	Integer	Primary firmware version. Equivalent to its lowercase counterpart.
`CAMERA_INFO_RECOMMENDED_FIRMWARE_VERSION`	Integer	Latest firmware version available. Equivalent to its lowercase counterpart.
`CAMERA_INFO_PHYSICAL_PORT`	Integer	Unique identifier of the port the device is connected to (platform specific). Equivalent to its lowercase counterpart.
`CAMERA_INFO_DEBUG_OP_CODE`	Integer	If device supports firmware logging, this is the command to send to get logs from firmware. Equivalent to its lowercase counterpart.
`CAMERA_INFO_ADVANCED_MODE`	Integer	True iff the device is in advanced mode. Equivalent to its lowercase counterpart.
`CAMERA_INFO_PRODUCT_ID`	Integer	Product ID as reported in the USB descriptor. Equivalent to its lowercase counterpart.
`CAMERA_INFO_CAMERA_LOCKED`	Integer	True if EEPROM is locked. Equivalent to its lowercase counterpart.
`CAMERA_INFO_USB_TYPE_DESCRIPTOR`	Integer	Designated USB specification: USB2/USB3. Equivalent to its lowercase counterpart.
`CAMERA_INFO_COUNT`	Integer	Number of enumeration values. Not a valid input: intended to be used in for-loops.
`cameraInfoToString`	String	Get the string representation out of the integer camera_info type

Source:

index.js, line 5331

See:

Device.supportsCameraInfo()

(constant) distortion :String

Enum for distortion types

Type:

String

Properties:

Name	Type	Description
`distortion_none`	String	String literal of `'none'`. Rectilinear images. No distortion compensation required. Equivalent to its uppercase counterpart.
`distortion_modified_brown_conrady`	String	String literal of `'modified-brown-conrady'`. Equivalent to Brown-Conrady distortion, except that tangential distortion is applied to radially distorted points Equivalent to its uppercase counterpart.
`distortion_inverse_brown_conrady`	String	String literal of `'inverse-brown-conrady'`. Equivalent to Brown-Conrady distortion, except undistorts image instead of distorting it Equivalent to its uppercase counterpart.
`distortion_ftheta`	String	String literal of `'ftheta'`. F-Theta fish-eye distortion model Equivalent to its uppercase counterpart.
`distortion_brown_conrady`	String	String literal of `'brown-conrady'`. Unmodified Brown-Conrady distortion model Equivalent to its uppercase counterpart.
`DISTORTION_NONE`	Integer	Rectilinear images. No distortion compensation required. Equivalent to its lowercase counterpart
`DISTORTION_MODIFIED_BROWN_CONRADY`	Integer	Equivalent to Brown-Conrady distortion, except that tangential distortion is applied to radially distorted points Equivalent to its lowercase counterpart
`DISTORTION_INVERSE_BROWN_CONRADY`	Integer	Equivalent to Brown-Conrady distortion, except undistorts image instead of distorting it Equivalent to its lowercase counterpart
`DISTORTION_FTHETA`	Integer	F-Theta fish-eye distortion model Equivalent to its lowercase counterpart
`DISTORTION_BROWN_CONRADY`	Integer	Unmodified Brown-Conrady distortion model Equivalent to its lowercase counterpart
`DISTORTION_COUNT`	Integer	Number of enumeration values. Not a valid input: intended to be used in for-loops.
`distortionToString`	String	Get the string representation out of the integer distortion type

Source:

index.js, line 5906

(constant) format :String

Enum for format values.

Type:

String

Properties:

Name	Type	Description
`format_any`	String	String literal of `'any'`. When passed to enable stream, librealsense will try to provide best suited format. Equivalent to its uppercase counterpart.
`format_z16`	String	String literal of `'z16'`. 16-bit linear depth values. The depth is meters is equal to depth scale * pixel value. Equivalent to its uppercase counterpart.
`format_disparity16`	String	String literal of `'disparity16'`. 16-bit linear disparity values. The depth in meters is equal to depth scale / pixel value. Equivalent to its uppercase counterpart.
`format_xyz32f`	String	String literal of `'xyz32f'`. 32-bit floating point 3D coordinates. Equivalent to its uppercase counterpart.
`format_yuyv`	String	String literal of `'yuyv'`. 32-bit y0, u, y1, v data for every two pixels. Similar to YUV422 but packed in a different order - https://en.wikipedia.org/wiki/YUV Equivalent to its uppercase counterpart.
`format_rgb8`	String	String literal of `'rgb8'`. 8-bit red, green and blue channels. Equivalent to its uppercase counterpart.
`format_bgr8`	String	String literal of `'bgr8'`. 8-bit blue, green, and red channels -- suitable for OpenCV. Equivalent to its uppercase counterpart.
`format_rgba8`	String	String literal of `'rgba8'`. 8-bit red, green and blue channels + constant alpha channel equal to FF. Equivalent to its uppercase counterpart.
`format_bgra8`	String	String literal of `'bgra8'`. 8-bit blue, green, and red channels + constant alpha channel equal to FF. Equivalent to its uppercase counterpart.
`format_y8`	String	String literal of `'y8'`. 8-bit per-pixel grayscale image. Equivalent to its uppercase counterpart.
`format_y16`	String	String literal of `'y16'`. 16-bit per-pixel grayscale image. Equivalent to its uppercase counterpart.
`format_raw10`	String	String literal of `'raw10'`. Four 10-bit luminance values encoded into a 5-byte macropixel. Equivalent to its uppercase counterpart.
`format_raw16`	String	String literal of `'raw16'`. 16-bit raw image. Equivalent to its uppercase counterpart.
`format_raw8`	String	String literal of `'raw8'`. 8-bit raw image. Equivalent to its uppercase counterpart.
`format_uyvy`	String	String literal of `'uyvy'`. Similar to the standard YUYV pixel format, but packed in a different order. Equivalent to its uppercase counterpart.
`format_motion_raw`	String	String literal of `'motion_raw'`. Raw data from the motion sensor. Equivalent to its uppercase counterpart.
`format_motion_xyz32f`	String	String literal of `'motion_xyz32f'`. Motion data packed as 3 32-bit float values, for X, Y, and Z axis. Equivalent to its uppercase counterpart.
`format_gpio_raw`	String	String literal of `'gpio-raw'`. Raw data from the external sensors hooked to one of the GPIO's. Equivalent to its uppercase counterpart.
`format_6dof`	String	String literal of `'6dof'`. Pose data packed as floats array, containing translation vector, rotation quaternion and prediction velocities and accelerations vectors Equivalent to its uppercase counterpart.
`format_disparity32`	String	String literal of `'disparity32'`. 32-bit float-point disparity values. Depth->Disparity conversion : Disparity = Baseline*FocalLength/Depth. Equivalent to its uppercase counterpart.
`format_mjpeg`	String	String literal of `'mjpeg'`. Bitstream encoding for video in which an image of each frame is encoded as JPEG-DIB.
`format_y8i`	String	String literal of `'y8i'`. 8-bit per pixel interleaved. 8-bit left, 8-bit right.
`format_y12i`	String	String literal of `'y12i'`. 12-bit per pixel interleaved. 12-bit left, 12-bit right. Each pixel is stored in a 24-bit word in little-endian order.
`format_inzi`	String	String literal of `'inzi'`. multi-planar Depth 16bit + IR 10bit.
`format_invi`	String	String literal of `'invi'`. 8-bit IR stream
`format_w10`	String	String literal of `'w10'`. Grey-scale image as a bit-packed array. 4 pixel data stream taking 5 bytes
`FORMAT_ANY`	Integer	When passed to enable stream, librealsense will try to provide best suited format. Equivalent to its lowercase counterpart.
`FORMAT_Z16`	Integer	16-bit linear depth values. The depth is meters is equal to depth scale * pixel value. Equivalent to its lowercase counterpart.
`FORMAT_DISPARITY16`	Integer	16-bit linear disparity values. The depth in meters is equal to depth scale / pixel value. Equivalent to its lowercase counterpart.
`FORMAT_XYZ32F`	Integer	32-bit floating point 3D coordinates. Equivalent to its lowercase counterpart.
`FORMAT_YUYV`	Integer	32-bit y0, u, y1, v data for every two pixels. Similar to YUV422 but packed in a different order - https://en.wikipedia.org/wiki/YUV. Equivalent to its lowercase counterpart.
`FORMAT_RGB8`	Integer	8-bit red, green and blue channels. Equivalent to its lowercase counterpart.
`FORMAT_BGR8`	Integer	8-bit blue, green, and red channels -- suitable for OpenCV. Equivalent to its lowercase counterpart.
`FORMAT_RGBA8`	Integer	8-bit red, green and blue channels + constant alpha channel equal to FF. Equivalent to its lowercase counterpart.
`FORMAT_BGRA8`	Integer	8-bit blue, green, and red channels + constant alpha channel equal to FF. Equivalent to its lowercase counterpart.
`FORMAT_Y8`	Integer	8-bit per-pixel grayscale image. Equivalent to its lowercase counterpart.
`FORMAT_Y16`	Integer	16-bit per-pixel grayscale image. Equivalent to its lowercase counterpart.
`FORMAT_RAW10`	Integer	Four 10-bit luminance values encoded into a 5-byte macropixel. Equivalent to its lowercase counterpart.
`FORMAT_RAW16`	Integer	16-bit raw image. Equivalent to its lowercase counterpart.
`FORMAT_RAW8`	Integer	8-bit raw image. Equivalent to its lowercase counterpart.
`FORMAT_UYVY`	Integer	Similar to the standard YUYV pixel format, but packed in a different order. Equivalent to its lowercase counterpart.
`FORMAT_MOTION_RAW`	Integer	Raw data from the motion sensor. Equivalent to its lowercase counterpart.
`FORMAT_MOTION_XYZ32F`	Integer	Motion data packed as 3 32-bit float values, for X, Y, and Z axis. Equivalent to its lowercase counterpart.
`FORMAT_GPIO_RAW`	Integer	Raw data from the external sensors hooked to one of the GPIO's. Equivalent to its lowercase counterpart.
`FORMAT_6DOF`	Integer	Pose data packed as floats array, containing translation vector, rotation quaternion and prediction velocities and accelerations vectors Equivalent to its lowercase counterpart.
`FORMAT_DISPARITY32`	Integer	32-bit float-point disparity values. Depth->Disparity conversion : Disparity = Baseline*FocalLength/Depth. Equivalent to its lowercase counterpart.
`FORMAT_MJPEG`	Integer	Bitstream encoding for video in which an image of each frame is encoded as JPEG-DIB.
`FORMAT_Y8I`	Integer	8-bit per pixel interleaved. 8-bit left, 8-bit right.
`FORMAT_Y12I`	Integer	12-bit per pixel interleaved. 12-bit left, 12-bit right. Each pixel is stored in a 24-bit word in little-endian order.
`FORMAT_INZI`	Integer	multi-planar Depth 16bit + IR 10bit.
`FORMAT_INVI`	Integer	8-bit IR stream.
`FORMAT_W10`	Integer	Grey-scale image as a bit-packed array. 4 pixel data stream taking 5 bytes.
`FORMAT_COUNT`	Integer	Number of enumeration values. Not a valid input: intended to be used in for-loops. Equivalent to its lowercase counterpart.
`formatToString`	String	Get the string representation out of the integer format type

Source:

index.js, line 4073

(constant) frame_metadata :String

Enum for frame metadata types

Type:

String

Properties:

Name	Type	Description
`frame_metadata_frame_counter`	String	String literal of `'frame-counter'`. A sequential index managed per-stream. Integer value Equivalent to its uppercase counterpart
`frame_metadata_frame_timestamp`	String	String literal of `'frame-timestamp'`. Timestamp set by device clock when data readout and transmit commence. usec Equivalent to its uppercase counterpart
`frame_metadata_sensor_timestamp`	String	String literal of `'sensor-timestamp'`. Timestamp of the middle of sensor's exposure calculated by device. usec Equivalent to its uppercase counterpart
`frame_metadata_actual_exposure`	String	String literal of `'actual-exposure'`. Sensor's exposure width. When Auto Exposure (AE) is on the value is controlled by firmware. usec Equivalent to its uppercase counterpart
`frame_metadata_gain_level`	String	String literal of `'gain-level'`. A relative value increasing which will increase the Sensor's gain factor. When AE is set On, the value is controlled by firmware. Integer value Equivalent to its uppercase counterpart
`frame_metadata_auto_exposure`	String	String literal of `'auto-exposure'`. Auto Exposure Mode indicator. Zero corresponds to AE switched off. Equivalent to its uppercase counterpart
`frame_metadata_white_balance`	String	String literal of `'white-balance'`. White Balance setting as a color temperature. Kelvin degrees Equivalent to its uppercase counterpart
`frame_metadata_time_of_arrival`	String	String literal of `'time-of-arrival'`. Time of arrival in system clock Equivalent to its uppercase counterpart
`frame_metadata_temperature`	String	Temperature of the device, measured at the time of the frame capture. Celsius degrees Equivalent to its uppercase counterpart
`frame_metadata_backend_timestamp`	String	Timestamp get from uvc driver. usec Equivalent to its uppercase counterpart
`frame_metadata_actual_fps`	String	Actual fps Equivalent to its uppercase counterpart
`frame_metadata_frame_laser_power`	String	Laser power value 0-360. Equivalent to its uppercase counterpart
`frame_metadata_frame_laser_power_mode`	String	Laser power mode. Zero corresponds to Laser power switched off and one for switched on. Equivalent to its uppercase counterpart
`frame_metadata_exposure_priority`	String	Exposure priority. Equivalent to its uppercase counterpart
`frame_metadata_exposure_roi_left`	String	Left region of interest for the auto exposure Algorithm. Equivalent to its uppercase counterpart
`frame_metadata_exposure_roi_right`	String	Right region of interest for the auto exposure Algorithm. Equivalent to its uppercase counterpart
`frame_metadata_exposure_roi_top`	String	Top region of interest for the auto exposure Algorithm. Equivalent to its uppercase counterpart
`frame_metadata_exposure_roi_bottom`	String	Bottom region of interest for the auto exposure Algorithm. Equivalent to its uppercase counterpart
`frame_metadata_brightness`	String	Color image brightness. Equivalent to its uppercase counterpart
`frame_metadata_contrast`	String	Color image contrast. Equivalent to its uppercase counterpart
`frame_metadata_saturation`	String	Color image saturation. Equivalent to its uppercase counterpart
`frame_metadata_sharpness`	String	Color image sharpness. Equivalent to its uppercase counterpart
`frame_metadata_auto_white_balance_temperature`	String	Auto white balance temperature Mode indicator. Zero corresponds to automatic mode switched off. Equivalent to its uppercase counterpart
`frame_metadata_backlight_compensation`	String	Color backlight compensation. Zero corresponds to switched off. Equivalent to its uppercase counterpart
`frame_metadata_hue`	String	Color image hue. Equivalent to its uppercase counterpart
`frame_metadata_gamma`	String	Color image gamma. Equivalent to its uppercase counterpart
`frame_metadata_manual_white_balance`	String	Color image white balance. Equivalent to its uppercase counterpart
`frame_metadata_power_line_frequency`	String	Power Line Frequency for anti-flickering Off/50Hz/60Hz/Auto. Equivalent to its uppercase counterpart
`frame_metadata_low_light_compensation`	String	Color lowlight compensation. Zero corresponds to switched off. Equivalent to its uppercase counterpart
`FRAME_METADATA_FRAME_COUNTER`	Integer	A sequential index managed per-stream. Integer value Equivalent to its lowercase counterpart.
`FRAME_METADATA_FRAME_TIMESTAMP`	Integer	Timestamp set by device clock when data readout and transmit commence. usec Equivalent to its lowercase counterpart.
`FRAME_METADATA_SENSOR_TIMESTAMP`	Integer	Timestamp of the middle of sensor's exposure calculated by device. usec Equivalent to its lowercase counterpart.
`FRAME_METADATA_ACTUAL_EXPOSURE`	Integer	Sensor's exposure width. When Auto Exposure (AE) is on the value is controlled by firmware. usec Equivalent to its lowercase counterpart.
`FRAME_METADATA_GAIN_LEVEL`	Integer	A relative value increasing which will increase the Sensor's gain factor. When AE is set On, the value is controlled by firmware. Integer value Equivalent to its lowercase counterpart.
`FRAME_METADATA_AUTO_EXPOSURE`	Integer	Auto Exposure Mode indicator. Zero corresponds to AE switched off. Equivalent to its lowercase counterpart.
`FRAME_METADATA_WHITE_BALANCE`	Integer	White Balance setting as a color temperature. Kelvin degrees Equivalent to its lowercase counterpart.
`FRAME_METADATA_TIME_OF_ARRIVAL`	Integer	Time of arrival in system clock Equivalent to its lowercase counterpart.
`FRAME_METADATA_TEMPERATURE`	Integer	Temperature of the device, measured at the time of the frame capture. Celsius degrees Equivalent to its lowercase counterpart
`FRAME_METADATA_BACKEND_TIMESTAMP`	Integer	Timestamp get from uvc driver. usec Equivalent to its lowercase counterpart
`FRAME_METADATA_ACTUAL_FPS`	Integer	Actual fps Equivalent to its lowercase counterpart
`FRAME_METADATA_FRAME_LASER_POWER`	Integer	Laser power value 0-360. Equivalent to its lowercase counterpart
`FRAME_METADATA_FRAME_LASER_POWER_MODE`	Integer	Laser power mode. Zero corresponds to Laser power switched off and one for switched on. Equivalent to its lowercase counterpart
`FRAME_METADATA_EXPOSURE_PRIORITY`	Integer	Exposure priority. Equivalent to its lowercase counterpart
`FRAME_METADATA_EXPOSURE_ROI_LEFT`	Integer	Left region of interest for the auto exposure Algorithm. Equivalent to its lowercase counterpart
`FRAME_METADATA_EXPOSURE_ROI_RIGHT`	Integer	Right region of interest for the auto exposure Algorithm. Equivalent to its lowercase counterpart
`FRAME_METADATA_EXPOSURE_ROI_TOP`	Integer	Top region of interest for the auto exposure Algorithm. Equivalent to its lowercase counterpart
`FRAME_METADATA_EXPOSURE_ROI_BOTTOM`	Integer	Bottom region of interest for the auto exposure Algorithm. Equivalent to its lowercase counterpart
`FRAME_METADATA_BRIGHTNESS`	Integer	Color image brightness. Equivalent to its lowercase counterpart
`FRAME_METADATA_CONTRAST`	Integer	Color image contrast. Equivalent to its lowercase counterpart
`FRAME_METADATA_SATURATION`	Integer	Color image saturation. Equivalent to its lowercase counterpart
`FRAME_METADATA_SHARPNESS`	Integer	Color image sharpness. Equivalent to its lowercase counterpart
`FRAME_METADATA_AUTO_WHITE_BALANCE_TEMPERATURE`	Integer	Auto white balance temperature Mode indicator. Zero corresponds to automatic mode switched off. Equivalent to its lowercase counterpart
`FRAME_METADATA_BACKLIGHT_COMPENSATION`	Integer	Color backlight compensation. Zero corresponds to switched off. Equivalent to its lowercase counterpart
`FRAME_METADATA_HUE`	Integer	Color image hue. Equivalent to its lowercase counterpart
`FRAME_METADATA_GAMMA`	Integer	Color image gamma. Equivalent to its lowercase counterpart
`FRAME_METADATA_MANUAL_WHITE_BALANCE`	Integer	Color image white balance. Equivalent to its lowercase counterpart
`FRAME_METADATA_POWER_LINE_FREQUENCY`	Integer	Power Line Frequency for anti-flickering Off/50Hz/60Hz/Auto. Equivalent to its lowercase counterpart
`FRAME_METADATA_LOW_LIGHT_COMPENSATION`	Integer	Color lowlight compensation. Zero corresponds to switched off. Equivalent to its lowercase counterpart
`FRAME_METADATA_COUNT`	Integer	Number of enumeration values. Not a valid input: intended to be used in for-loops.
`frameMetadataToString`	String	Get the string representation out of the integer frame metadata type

Source:

index.js, line 5487

See:

Frame.supportsFrameMetadata()

(constant) log_severity :String

Enum for notification severity

Type:

String

Properties:

Name	Type	Description
`log_severity_debug`	String	String literal of `'debug'`. Detailed information about ordinary operations. Equivalent to its uppercase counterpart.
`log_severity_info`	String	String literal of `'info'`. Terse information about ordinary operations. Equivalent to its uppercase counterpart.
`log_severity_warn`	String	String literal of `'warn'`. Indication of possible failure. Equivalent to its uppercase counterpart.
`log_severity_error`	String	String literal of `'error'`. Indication of definite failure. Equivalent to its uppercase counterpart.
`log_severity_fatal`	String	String literal of `'fatal'`. Indication of unrecoverable failure. Equivalent to its uppercase counterpart.
`log_severity_none`	String	String literal of `'none'`. No logging will occur. Equivalent to its uppercase counterpart.
`LOG_SEVERITY_DEBUG`	Integer	Detailed information about ordinary operations. Equivalent to its lowercase counterpart.
`LOG_SEVERITY_INFO`	Integer	Terse information about ordinary operations. Equivalent to its lowercase counterpart.
`LOG_SEVERITY_WARN`	Integer	Indication of possible failure. Equivalent to its lowercase counterpart.
`LOG_SEVERITY_ERROR`	Integer	Indication of definite failure. Equivalent to its lowercase counterpart.
`LOG_SEVERITY_FATAL`	Integer	Indication of unrecoverable failure. Equivalent to its lowercase counterpart.
`LOG_SEVERITY_NONE`	Integer	No logging will occur. Equivalent to its lowercase counterpart.
`LOG_SEVERITY_COUNT`	Integer	Number of enumeration values. Not a valid input: intended to be used in for-loops.
`logSeverityToString`	String	Get the string representation out of the integer log_severity type

Source:

index.js, line 5993

(constant) notification_category :String

Enum for notification category

Type:

String

Properties:

Name	Type	Description
`notification_category_frames_timeout`	String	String literal of `'frames-timeout'`. Frames didn't arrived within 5 seconds Equivalent to its uppercase counterpart.
`notification_category_frame_corrupted`	String	String literal of `'frame-corrupted'`. Received partial/incomplete frame Equivalent to its uppercase counterpart.
`notification_category_hardware_error`	String	String literal of `'hardware-error'`. Error reported from the device Equivalent to its uppercase counterpart.
`notification_category_hardware_event`	String	String literal of `'hardware-event'`. General hardware notification reported from the sensor Equivalent to its uppercase counterpart.
`notification_category_unknown_error`	String	String literal of `'unknown-error'`. Received unknown error from the device Equivalent to its uppercase counterpart.
`notification_category_firmware_update_recommended`	String	String literal of `'firmware-update-recommended'`. Current firmware version installed is not the latest available. Equivalent to its uppercase counterpart.
`NOTIFICATION_CATEGORY_FRAMES_TIMEOUT`	Integer	Frames didn't arrived within 5 seconds Equivalent to its lowercase counterpart
`NOTIFICATION_CATEGORY_FRAME_CORRUPTED`	Integer	Received partial/incomplete frame Equivalent to its lowercase counterpart
`NOTIFICATION_CATEGORY_HARDWARE_ERROR`	Integer	Error reported from the device Equivalent to its lowercase counterpart
`NOTIFICATION_CATEGORY_HARDWARE_EVENT`	Integer	General hardware notification reported from the sensor Equivalent to its lowercase counterpart
`NOTIFICATION_CATEGORY_UNKNOWN_ERROR`	Integer	Received unknown error from the device Equivalent to its lowercase counterpart
`NOTIFICATION_CATEGORY_FIRMWARE_UPDATE_RECOMMENDED`	Integer	Current firmware version installed is not the latest available Equivalent to its lowercase counterpart
`NOTIFICATION_CATEGORY_COUNT`	Integer	Number of enumeration values. Not a valid input: intended to be used in for-loops.
`notificationCategoryToString`	String	Get the string representation out of the integer notification_category type

Source:

index.js, line 6091

(constant) option :String

Enum for option values.

Type:

String

Properties:

Name	Type	Description
`option_backlight_compensation`	String	String literal of `'backlight-compensation'`. Enable / disable color backlight compensation. Equivalent to its uppercase counterpart.
`option_brightness`	String	String literal of `'brightness'`. Color image brightness. Equivalent to its uppercase counterpart.
`option_contrast`	String	String literal of `'contrast'`. Color image contrast. Equivalent to its uppercase counterpart.
`option_exposure`	String	String literal of `'exposure'`. Controls exposure time of color camera . Setting any value will disable auto exposure. Equivalent to its uppercase counterpart.
`option_gain`	String	String literal of `'gain'`. Color image gain. Equivalent to its uppercase counterpart.
`option_gamma`	String	String literal of `'gamma'`. Color image gamma setting. Equivalent to its uppercase counterpart.
`option_hue`	String	String literal of `'hue'`. Color image hue. Equivalent to its uppercase counterpart.
`option_saturation`	String	String literal of `'saturation'`. Color image saturation setting. Equivalent to its uppercase counterpart.
`option_sharpness`	String	String literal of `'sharpness'`. Color image sharpness setting. Equivalent to its uppercase counterpart.
`option_white_balance`	String	String literal of `'white-balance'`. Controls white balance of color image. Setting any value will disable auto white balance. Equivalent to its uppercase counterpart.
`option_enable_auto_exposure`	String	String literal of `'enable-auto-exposure'`. Enable / disable color image auto-exposure. Equivalent to its uppercase counterpart.
`option_enable_auto_white_balance`	String	String literal of `'enable-auto-white-balance'`. Enable / disable color image auto-white-balance. Equivalent to its uppercase counterpart.
`option_visual_preset`	String	String literal of `'visual-preset'`. Provide access to several recommend sets of option presets for the depth camera . Equivalent to its uppercase counterpart.
`option_laser_power`	String	String literal of `'laser-power'`. Power of the F200 / SR300 projector , with 0 meaning projector off. Equivalent to its uppercase counterpart.
`option_accuracy`	String	String literal of `'accuracy'`. Set the number of patterns projected per frame. The higher the accuracy value the more patterns projected. Increasing the number of patterns help to achieve better accuracy. Note that this control is affecting the Depth FPS. Equivalent to its uppercase counterpart.
`option_motion_range`	String	String literal of `'motion-range'`. Motion vs. Range trade-off, with lower values allowing for better motion sensitivity and higher values allowing for better depth range. Equivalent to its uppercase counterpart.
`option_filter_option`	String	String literal of `'filter-option'`. Set the filter to apply to each depth frame. Each one of the filter is optimized per the application requirements. Equivalent to its uppercase counterpart.
`option_confidence_threshold`	String	String literal of `'confidence-threshold'`. The confidence level threshold used by the Depth algorithm pipe to set whether a pixel will get a valid range or will be marked with invalid range. Equivalent to its uppercase counterpart.
`option_emitter_enabled`	String	String literal of `'emitter-enabled'`. Laser Emitter enabled . Equivalent to its uppercase counterpart.
`option_frames_queue_size`	String	String literal of `'frames-queue-size'`. Number of frames the user is allowed to keep per stream. Trying to hold-on to more frames will cause frame-drops. Equivalent to its uppercase counterpart.
`option_total_frame_drops`	String	String literal of `'total-frame-drops'`. Total number of detected frame drops from all streams . Equivalent to its uppercase counterpart.
`option_auto_exposure_mode`	String	String literal of `'auto-exposure-mode'`. Auto-Exposure modes: Static , Anti-Flicker and Hybrid . Equivalent to its uppercase counterpart.
`option_power_line_frequency`	String	String literal of `'power-line-frequency'`. Power Line Frequency control for anti-flickering, Off/50Hz/60Hz/Auto. Equivalent to its uppercase counterpart.
`option_asic_temperature`	String	String literal of `'asic-temperature'`. Current Asic Temperature . Equivalent to its uppercase counterpart.
`option_error_polling_enabled`	String	String literal of `'error-polling-enabled'`. disable error handling . Equivalent to its uppercase counterpart.
`option_projector_temperature`	String	String literal of `'projector-temperature'`. Current Projector Temperature . Equivalent to its uppercase counterpart.
`option_output_trigger_enabled`	String	String literal of `'output-trigger-enabled'`. Enable / disable trigger to be outputed from the camera to any external device on every depth frame. Equivalent to its uppercase counterpart.
`option_motion_module_temperature`	String	String literal of `'motion-module-temperature'`. Current Motion-Module Temperature . Equivalent to its uppercase counterpart.
`option_depth_units`	String	String literal of `'depth-units'`. Number of meters represented by a single depth unit . Equivalent to its uppercase counterpart.
`option_enable_motion_correction`	String	String literal of `'enable-motion-correction'`. Enable/Disable automatic correction of the motion data . Equivalent to its uppercase counterpart.
`option_auto_exposure_priority`	String	String literal of `'auto-exposure-priority'`. Allows sensor to dynamically ajust the frame rate depending on lighting conditions Equivalent to its uppercase counterpart
`option_color_scheme`	String	String literal of `''color-scheme'`. Color scheme for data visualization Equivalent to its uppercase counterpart
`option_histogram_equalization_enabled`	String	String literal of `''histogram-equalization-enabled'`. Perform histogram equalization post-processing on the depth data Equivalent to its uppercase counterpart
`option_min_distance`	String	String literal of `''min-distance'`. Minimal distance to the target Equivalent to its uppercase counterpart
`option_max_distance`	String	String literal of `''max-distance'`. Maximum distance to the target Equivalent to its uppercase counterpart
`option_texture_source`	String	String literal of `'texture-source'`. Texture mapping stream unique ID Equivalent to its uppercase counterpart.
`option_filter_magnitude`	String	String literal of `'filter-magnitude'`. The 2D-filter effect. The specific interpretation is given within the context of the filter Equivalent to its uppercase counterpart.
`option_filter_smooth_alpha`	String	String literal of `'filter-smooth-alpha'`. 2D-filter parameter controls the weight/radius for smoothing. Equivalent to its uppercase counterpart.
`option_filter_smooth_delta`	String	String literal of `'filter-smooth-delta'`. 2D-filter range/validity threshold Equivalent to its uppercase counterpart.
`option_holes_fill`	String	String literal of `'holes-fill'`. Enhance depth data post-processing with holes filling where appropriate Equivalent to its uppercase counterpart.
`option_stereo_baseline`	String	String literal of `'stereo-baseline'`. The distance in mm between the first and the second imagers in stereo-based depth cameras Equivalent to its uppercase counterpart.
`option_auto_exposure_converge_step`	String	String literal of `'auto-exposure-converage-step'`. Allows dynamically ajust the converge step value of the target exposure in Auto-Exposure algorithm Equivalent to its uppercase counterpart.
`option_inter_cam_sync_mode`	String	String literal of `'inter-cam-sync-mode'. Impose Inter-camera HW synchronization mode. Applicable for D400/Rolling Shutter SKUs Equivalent to its uppercase counterpart.`
`option_stream_filter`	String
`option_stream_format_filter`	String
`option_stream_index_filter`	String
`option_emitter_on_off`	String
`option_zero_order_point_x`	String
`option_zero_order_point_y`	String
`option_lld_temperature`	String
`option_mc_temperature`	String
`option_ma_temperature`	String
`option_apd_temperature`	String
`option_hardware_preset`	String
`option_global_time_enabled`	String
`option_enable_mapping`	String
`option_enable_relocalization`	String
`option_enable_pose_jumping`	String
`option_enable_dynamic_calibration`	String
`option_depth_offset`	String
`option_led_power`	String
`option_zero_order_enabled`	String
`option_enable_map_preservation`	String
`OPTION_BACKLIGHT_COMPENSATION`	Integer	Enable / disable color backlight compensatio. Equivalent to its lowercase counterpart.
`OPTION_BRIGHTNESS`	Integer	Color image brightnes. Equivalent to its lowercase counterpart.
`OPTION_CONTRAST`	Integer	Color image contras. Equivalent to its lowercase counterpart.
`OPTION_EXPOSURE`	Integer	Controls exposure time of color camera. Setting any value will disable auto exposur. Equivalent to its lowercase counterpart.
`OPTION_GAIN`	Integer	Color image gai. Equivalent to its lowercase counterpart.
`OPTION_GAMMA`	Integer	Color image gamma settin. Equivalent to its lowercase counterpart.
`OPTION_HUE`	Integer	Color image hu. Equivalent to its lowercase counterpart.
`OPTION_SATURATION`	Integer	Color image saturation settin. Equivalent to its lowercase counterpart.
`OPTION_SHARPNESS`	Integer	Color image sharpness settin. Equivalent to its lowercase counterpart.
`OPTION_WHITE_BALANCE`	Integer	Controls white balance of color image. Setting any value will disable auto white balanc. Equivalent to its lowercase counterpart.
`OPTION_ENABLE_AUTO_EXPOSURE`	Integer	Enable / disable color image auto-exposur. Equivalent to its lowercase counterpart.
`OPTION_ENABLE_AUTO_WHITE_BALANCE`	Integer	Enable / disable color image auto-white-balanc. Equivalent to its lowercase counterpart.
`OPTION_VISUAL_PRESET`	Integer	Provide access to several recommend sets of option presets for the depth camera. Equivalent to its lowercase counterpart.
`OPTION_LASER_POWER`	Integer	Power of the F200 / SR300 projector, with 0 meaning projector of. Equivalent to its lowercase counterpart.
`OPTION_ACCURACY`	Integer	Set the number of patterns projected per frame. The higher the accuracy value the more patterns projected. Increasing the number of patterns help to achieve better accuracy. Note that this control is affecting the Depth FPS. Equivalent to its lowercase counterpart.
`OPTION_MOTION_RANGE`	Integer	Motion vs. Range trade-off, with lower values allowing for better motion sensitivity and higher values allowing for better depth rang. Equivalent to its lowercase counterpart.
`OPTION_FILTER_OPTION`	Integer	Set the filter to apply to each depth frame. Each one of the filter is optimized per the application requirement. Equivalent to its lowercase counterpart.
`OPTION_CONFIDENCE_THRESHOLD`	Integer	The confidence level threshold used by the Depth algorithm pipe to set whether a pixel will get a valid range or will be marked with invalid rang. Equivalent to its lowercase counterpart.
`OPTION_EMITTER_ENABLED`	Integer	Laser Emitter enabled. Equivalent to its lowercase counterpart.
`OPTION_FRAMES_QUEUE_SIZE`	Integer	Number of frames the user is allowed to keep per stream. Trying to hold-on to more frames will cause frame-drops. Equivalent to its lowercase counterpart.
`OPTION_TOTAL_FRAME_DROPS`	Integer	Total number of detected frame drops from all streams. Equivalent to its lowercase counterpart.
`OPTION_AUTO_EXPOSURE_MODE`	Integer	Auto-Exposure modes: Static, Anti-Flicker and Hybrid. Equivalent to its lowercase counterpart.
`OPTION_POWER_LINE_FREQUENCY`	Integer	Power Line Frequency control for anti-flickering, Off/50Hz/60Hz/Auto. Equivalent to its lowercase counterpart.
`OPTION_ASIC_TEMPERATURE`	Integer	Current Asic Temperature. Equivalent to its lowercase counterpart.
`OPTION_ERROR_POLLING_ENABLED`	Integer	disable error handling. Equivalent to its lowercase counterpart.
`OPTION_PROJECTOR_TEMPERATURE`	Integer	Current Projector Temperature. Equivalent to its lowercase counterpart.
`OPTION_OUTPUT_TRIGGER_ENABLED`	Integer	Enable / disable trigger to be outputed from the camera to any external device on every depth frame. Equivalent to its lowercase counterpart.
`OPTION_MOTION_MODULE_TEMPERATURE`	Integer	Current Motion-Module Temperature. Equivalent to its lowercase counterpart.
`OPTION_DEPTH_UNITS`	Integer	Number of meters represented by a single depth unit. Equivalent to its lowercase counterpart.
`OPTION_ENABLE_MOTION_CORRECTION`	Integer	Enable/Disable automatic correction of the motion data. Equivalent to its lowercase counterpart.
`OPTION_AUTO_EXPOSURE_PRIORITY`	Integer	Allows sensor to dynamically ajust the frame rate depending on lighting conditions. Equivalent to its lowercase counterpart
`OPTION_COLOR_SCHEME`	Integer	Color scheme for data visualization Equivalent to its lowercase counterpart
`OPTION_HISTOGRAM_EQUALIZATION_ENABLED`	Integer	Perform histogram equalization post-processing on the depth data. Equivalent to its lowercase counterpart
`OPTION_MIN_DISTANCE`	Integer	Minimal distance to the target Equivalent to its lowercase counterpart
`OPTION_MAX_DISTANCE`	Integer	Maximum distance to the target Equivalent to its lowercase counterpart
`OPTION_TEXTURE_SOURCE`	Integer	Texture mapping stream unique ID Equivalent to its lowercase counterpart
`OPTION_FILTER_MAGNITUDE`	Integer	The 2D-filter effect. The specific interpretation is given within the context of the filter Equivalent to its lowercase counterpart
`OPTION_FILTER_SMOOTH_ALPHA`	Integer	2D-filter parameter controls the weight/radius for smoothing. Equivalent to its lowercase counterpart
`OPTION_FILTER_SMOOTH_DELTA`	Integer	2D-filter range/validity threshold Equivalent to its lowercase counterpart
`OPTION_HOLES_FILL`	Integer	Enhance depth data post-processing with holes filling where appropriate Equivalent to its lowercase counterpart.
`OPTION_STEREO_BASELINE`	Integer	The distance in mm between the first and the second imagers in stereo-based depth cameras Equivalent to its lowercase counterpart
`OPTION_AUTO_EXPOSURE_CONVERGE_STEP`	Integer	Allows dynamically ajust the converge step value of the target exposure in Auto-Exposure algorithm Equivalent to its lowercase counterpart
`OPTION_INTER_CAM_SYNC_MODE`	Integer	Impose Inter-camera HW synchronization mode. Applicable for D400/Rolling Shutter SKUs Equivalent to its lowercase counterpart
`OPTION_STREAM_FILTER`	String
`OPTION_STREAM_FORMAT_FILTER`	String
`OPTION_STREAM_INDEX_FILTER`	String
`OPTION_EMITTER_ON_OFF`	String
`OPTION_ZERO_ORDER_POINT_X`	String
`OPTION_ZERO_ORDER_POINT_Y`	String
`OPTION_LLD_TEMPERATURE`	String
`OPTION_MC_TEMPERATURE`	String
`OPTION_MA_TEMPERATURE`	String
`OPTION_HARDWARE_PRESET`	String
`OPTION_GLOBAL_TIME_ENABLED`	String
`OPTION_APD_TEMPERATURE`	String
`OPTION_ENABLE_MAPPING`	String
`OPTION_ENABLE_RELOCALIZATION`	String
`OPTION_ENABLE_POSE_JUMPING`	String
`OPTION_ENABLE_DYNAMIC_CALIBRATION`	String
`OPTION_DEPTH_OFFSET`	String
`OPTION_LED_POWER`	String
`OPTION_ZERO_ORDER_ENABLED`	String
`OPTION_ENABLE_MAP_PRESERVATION`	String
`OPTION_FREEFALL_DETECTION_ENABLED`	String
`OPTION_EMITTER_ALWAYS_ON`	Integer	Enable Laser On constantly (GS SKU Only) Equivalent to its lowercase counterpart
`OPTION_COUNT`	Integer	Number of enumeration values. Not a valid input: intended to be used in for-loops.
`optionToString`	String	Get the string representation out of the integer option type

Source:

index.js, line 4641

See:

Sensor.isOptionReadOnly()
Sensor.getOption()
Sensor.getOptionRange()
Sensor.setOption()
Sensor.supportsOption()
Sensor.getOptionDescription()
Sensor.getOptionValueDescription()

(constant) preset_preference :String

util.preset_preference: The enum for preset preference values.

Type:

String

Properties:

Name	Type	Description
`best_quality`	String	String literal of `'best-quality'`. Prefers the best overall quality that is available in the camera. Equivalent to its uppercase counterpart.
`largest_image`	String	String literal of `'largest-image'`. Prefers the largest image dimension that is available in the camera. Equivalent to its uppercase counterpart.
`highest_framerate`	String	String literal of `'highest-framerate'`. Prefers the highest frame rate that is available in the camera. Equivalent to its uppercase counterpart.
`BEST_QUALITY`	Integer	Prefers the best overall quality that is available in the camera Equivalent to its lowercase counterpart.
`LARGEST_IMAGE`	Integer	Prefers the largest image dimension that is available in the camera Equivalent to its lowercase counterpart.
`HIGHEST_FRAMERATE`	Integer	Prefers the highest frame rate that is available in the camera Equivalent to its lowercase counterpart.
`PRESET_BEGIN`	String
`PRESET_END`	String

Source:

index.js, line 3391

(constant) recording_mode :String

Enum for recording options

Type:

String

Properties:

Name	Type	Description
`recording_mode_blank_frames`	String	String literal of `'blank-frames'`. Frame metadata will be recorded, but pixel data will be replaced with zeros to save space. Equivalent to its uppercase counterpart.
`recording_mode_compressed`	String	String literal of `'compressed'`. Frames will be encoded using a proprietary lossy encoding, aiming at x5 compression at some CPU expense. Equivalent to its uppercase counterpart.
`recording_mode_best_quality`	String	String literal of `'best-quality'`. Frames will not be compressed, but rather stored as-is. This gives best quality and low CPU overhead, but you might run out of memory. Equivalent to its uppercase counterpart.
`RECORDING_MODE_BLANK_FRAMES`	Integer	Frame metadata will be recorded, but pixel data will be replaced with zeros to save space. Equivalent to its lowercase counterpart.
`RECORDING_MODE_COMPRESSED`	Integer	Frames will be encoded using a proprietary lossy encoding, aiming at x5 compression at some CPU expense. Equivalent to its lowercase counterpart.
`RECORDING_MODE_BEST_QUALITY`	Integer	Frames will not be compressed, but rather stored as-is. This gives best quality and low CPU overhead, but you might run out of memory. Equivalent to its lowercase counterpart.
`RECORDING_MODE_COUNT`	Integer	Number of enumeration values. Not a valid input: intended to be used in for-loops.

Source:

index.js, line 4583

See:

See RecordingContext.constructor() for usage

(constant) rs400_visual_preset :String

Enum for visual preset of RS400 devices: provides optimized settings (presets) for specific types of usage.

Type:

String

Properties:

Name	Type	Description
`rs400_visual_preset_custom`	String	String literal of `'custom'`. Preset for custom. Equivalent to its uppercase counterpart
`rs400_visual_preset_default`	String	String literal of `'default'`. Preset for default. Equivalent to its uppercase counterpart
`rs400_visual_preset_hand`	String	String literal of `'hand'`. Preset for hand. Equivalent to its uppercase counterpart
`rs400_visual_preset_high_accuracy`	String	String literal of `'high-accuracy'`. Preset for high-accuracy. Equivalent to its uppercase counterpart
`rs400_visual_preset_high_density`	String	String literal of `'high-density'`. Preset for high-density. Equivalent to its uppercase counterpart
`rs400_visual_preset_medium_density`	String	String literal of `'medium-density'`. Preset for medium-density. Equivalent to its uppercase counterpart
`rs400_visual_preset_remove_ir_pattern`	String	String literal of `'remove-ir-pattern'`. Preset for remove-ir-pattern. Equivalent to its uppercase counterpart
`RS400_VISUAL_PRESET_CUSTOM`	Integer	Preset for custom Equivalent to its lowercase counterpart
`RS400_VISUAL_PRESET_DEFAULT`	Integer	Preset for default Equivalent to its lowercase counterpart
`RS400_VISUAL_PRESET_HAND`	Integer	Preset for hand Equivalent to its lowercase counterpart
`RS400_VISUAL_PRESET_HIGH_ACCURACY`	Integer	Preset for high_accuracy Equivalent to its lowercase counterpart
`RS400_VISUAL_PRESET_HIGH_DENSITY`	Integer	Preset for high-density Equivalent to its lowercase counterpart
`RS400_VISUAL_PRESET_MEDIUM_DENSITY`	Integer	Preset for medium-density Equivalent to its lowercase counterpart
`RS400_VISUAL_PRESET_REMOVE_IR_PATTERN`	Integer	Preset for remove-ir-pattern Equivalent to its lowercase counterpart
`RS400_VISUAL_PRESET_COUNT`	Integer	Number of enumeration values. Not a valid input: intended to be used in for-loops.
`rs400VisualPresetToString`	String	Get the string representation out of the integer rs400_visual_preset type

Source:

index.js, line 6444

(constant) sr300_visual_preset :String

Enum for visual preset of SR300 devices: provides optimized settings (presets) for specific types of usage.

Type:

String

Properties:

Name	Type	Description
`sr300_visual_preset_short_range`	String	String literal of `'short-range'`. Preset for short range. Equivalent to its uppercase counterpart
`sr300_visual_preset_long_range`	String	String literal of `'long-range'`. Preset for long range. Equivalent to its uppercase counterpart
`sr300_visual_preset_background_segmentation`	String	String literal of `'background-segmentation'`. Preset for background segmentation. Equivalent to its uppercase counterpart
`sr300_visual_preset_gesture_recognition`	String	String literal of `'gesture-recognition'`. Preset for gesture recognition. Equivalent to its uppercase counterpart
`sr300_visual_preset_object_scanning`	String	String literal of `'object-scanning'`. Preset for object scanning. Equivalent to its uppercase counterpart
`sr300_visual_preset_face_analytics`	String	String literal of `'face-analytics'`. Preset for face analytics. Equivalent to its uppercase counterpart
`sr300_visual_preset_face_login`	String	String literal of `'face-login'`. Preset for face login. Equivalent to its uppercase counterpart
`sr300_visual_preset_gr_cursor`	String	String literal of `'gr-cursor'`. Preset for GR cursor. Equivalent to its uppercase counterpart
`sr300_visual_preset_default`	String	String literal of `'default'`. Preset for default. Equivalent to its uppercase counterpart
`sr300_visual_preset_mid_range`	String	String literal of `'mid-range'`. Preset for mid-range. Equivalent to its uppercase counterpart
`sr300_visual_preset_ir_only`	String	String literal of `'ir-only'`. Preset for IR only. Equivalent to its uppercase counterpart
`SR300_VISUAL_PRESET_SHORT_RANGE`	Integer	Preset for short range Equivalent to its lowercase counterpart.
`SR300_VISUAL_PRESET_LONG_RANGE`	Integer	Preset for long range Equivalent to its lowercase counterpart.
`SR300_VISUAL_PRESET_BACKGROUND_SEGMENTATION`	Integer	Preset for background segmentation Equivalent to its lowercase counterpart.
`SR300_VISUAL_PRESET_GESTURE_RECOGNITION`	Integer	Preset for gesture recognition Equivalent to its lowercase counterpart.
`SR300_VISUAL_PRESET_OBJECT_SCANNING`	Integer	Preset for object scanning Equivalent to its lowercase counterpart.
`SR300_VISUAL_PRESET_FACE_ANALYTICS`	Integer	Preset for face analytics Equivalent to its lowercase counterpart.
`SR300_VISUAL_PRESET_FACE_LOGIN`	Integer	Preset for face login Equivalent to its lowercase counterpart.
`SR300_VISUAL_PRESET_GR_CURSOR`	Integer	Preset for GR cursor Equivalent to its lowercase counterpart.
`SR300_VISUAL_PRESET_DEFAULT`	Integer	Preset for default Equivalent to its lowercase counterpart.
`SR300_VISUAL_PRESET_MID_RANGE`	Integer	Preset for mid-range Equivalent to its lowercase counterpart.
`SR300_VISUAL_PRESET_IR_ONLY`	Integer	Preset for IR only Equivalent to its lowercase counterpart.
`SR300_VISUAL_PRESET_COUNT`	Integer	Number of enumeration values. Not a valid input: intended to be used in for-loops.
`sr300VisualPresetToString`	String	Get the string representation out of the integer sr300_visual_preset type

Source:

index.js, line 6264

(constant) stream :String

Enum for stream values.

Type:

String

Properties:

Name	Type	Description
`stream_any`	String	String literal of `'any'`. Any stream. Equivalent to its uppercase counterpart.
`stream_depth`	String	String literal of `'depth'`. Native stream of depth data produced by RealSense device . Equivalent to its uppercase counterpart.
`stream_color`	String	String literal of `'color'`. Native stream of color data captured by RealSense device . Equivalent to its uppercase counterpart.
`stream_infrared`	String	String literal of `'infrared'`. Native stream of infrared data captured by RealSense device . Equivalent to its uppercase counterpart.
`stream_fisheye`	String	String literal of `'fisheye'`. Native stream of fish-eye(wide) data captured from the dedicate motion camera . Equivalent to its uppercase counterpart.
`stream_gyro`	String	String literal of `'gyro'`. Native stream of gyroscope motion data produced by RealSense device . Equivalent to its uppercase counterpart.
`stream_accel`	String	String literal of `'accel'`. Native stream of accelerometer motion data produced by RealSense device . Equivalent to its uppercase counterpart.
`stream_gpio`	String	String literal of `'gpio'`. Signals from external device connected through GPIO . Equivalent to its uppercase counterpart.
`stream_pose`	String	String literal of `'pose'`. 6 Degrees of Freedom pose data, calculated by RealSense device. Equivalent to its uppercase counterpart.
`stream_confidence`	String	String literal of `'confidence'`. Confidence stream Equivalent to its uppercase counterpart.
`STREAM_ANY`	Integer	Any stream. Equivalent to its lowercase counterpart.
`STREAM_DEPTH`	Integer	Native stream of depth data produced by RealSense device. Equivalent to its lowercase counterpart.
`STREAM_COLOR`	Integer	Native stream of color data captured by RealSense device. Equivalent to its lowercase counterpart.
`STREAM_INFRARED`	Integer	Native stream of infrared data captured by RealSense device. Equivalent to its lowercase counterpart.
`STREAM_FISHEYE`	Integer	Native stream of fish-eye (wide) data captured from the dedicate motion camera. Equivalent to its lowercase counterpart.
`STREAM_GYRO`	Integer	Native stream of gyroscope motion data produced by RealSense device. Equivalent to its lowercase counterpart.
`STREAM_ACCEL`	Integer	Native stream of accelerometer motion data produced by RealSense device. Equivalent to its lowercase counterpart.
`STREAM_GPIO`	Integer	Signals from external device connected through GPIO. Equivalent to its lowercase counterpart.
`STREAM_POSE`	Integer	6 Degrees of Freedom pose data, calculated by RealSense device. Equivalent to its lowercase counterpart.
`STREAM_CONFIDENCE`	Integer	Confidence stream. Equivalent to its lowercase counterpart.
`STREAM_COUNT`	Integer	Number of enumeration values. Not a valid input: intended to be used in for-loops.
`streamToString`	String	Get the string representation out of the integer stream type

Source:

index.js, line 4427

(constant) timestamp_domain :String

Enum for timestamp domain.

Type:

String

Properties:

Name	Type	Description
`timestamp_domain_hardware_clock`	String	String literal of `'hardware-clock'`. Frame timestamp was measured in relation to the camera clock Equivalent to its uppercase counterpart.
`timestamp_domain_system_time`	String	String literal of `'system-time'`. Frame timestamp was measured in relation to the OS system clock Equivalent to its uppercase counterpart.
`TIMESTAMP_DOMAIN_HARDWARE_CLOCK`	Integer	Frame timestamp was measured in relation to the camera clock Equivalent to its lowercase counterpart.
`TIMESTAMP_DOMAIN_SYSTEM_TIME`	Integer	Frame timestamp was measured in relation to the OS system clock Equivalent to its lowercase counterpart.
`TIMESTAMP_DOMAIN_COUNT`	Integer	Number of enumeration values. Not a valid input: intended to be used in for-loops.
`timestampDomainToString`	String	Get the string representation out of the integer timestamp_domain type

Source:

index.js, line 6202

Methods

cleanup()

Cleanup resources

Source:

index.js, line 6713

frameMetadataContent(frame) → {String}

Get all the frame metadata representation as a string

Parameters:

Name	Type	Description
`frame`	frame	frame to be saved

Source:

index.js, line 4006

Returns:

the string representation of all supported frame metadata.

Type: String

getError() → {ErrorInfoObject|undefined}

Get the error info User could call this method to get the detailed error info if the previous API failed.

Source:

index.js, line 6733

Returns:

If there is no error, undefined is returned

Type: ErrorInfoObject | undefined

Type Definitions

CameraInfoObject

Information that can be queried from the device. Not all information attributes are available on all camera types. This information is mainly available for camera debug and troubleshooting and should not be used in applications.

Type:

Object

Properties:

Name	Type	Description
`name`	String \| undefined	Device friendly name. undefined is not supported.
`serialNumber`	String \| undefined	Device serial number. undefined is not supported.
`firmwareVersion`	String \| undefined	Primary firmware version. undefined is not supported.
`physicalPort`	String \| undefined	Unique identifier of the port the device is connected to (platform specific). undefined is not supported.
`debugOpCode`	String \| undefined	If device supports firmware logging, this is the command to send to get logs from firmware. undefined is not supported.
`advancedMode`	String \| undefined	True if the device is in advanced mode. undefined is not supported.
`productId`	String \| undefined	Product ID as reported in the USB descriptor. undefined is not supported.
`cameraLocked`	Boolean \| undefined	True if EEPROM is locked. undefined is not supported.
`usbTypeDescriptor`	String \| undefined	Designated USB specification: USB2/USB3. undefined is not supported.
`recommendedFirmwareVersion`	String \| undefined	Latest firmware version. undefined is not supported.

Source:

index.js, line 80

See:

Device.getCameraInfo()

devicesChangedCallback(removed, added)

This callback is called when number of devices is changed

Parameters:

Name	Type	Description
`removed`	DeviceList	The devices removed from the system
`added`	DeviceList	The devices added to the system

Source:

index.js, line 1332

See:

Context.setDevicesChangedCallback

ErrorInfoObject

Error Information returned from native SDK

Type:

Object

Properties:

Name	Type	Description
`recoverable`	Boolean	True if the error is a recoverable error
`description`	String	Detailed description of the error
`nativeFunction`	String	Native function that triggered the error

Source:

index.js, line 6718

See:

getError()

ExtrinsicsObject

Extrinsics:

Type:

Object

Properties:

Name	Type	Description
`rotation`	Array.<Float32>	Array(9), Column-major 3x3 rotation matrix
`translation`	Array.<Float32>	Array(3), Three-element translation vector, in meters

Source:

index.js, line 362

See:

StreamProfile.getExtrinsicsTo()

FOVObject

Field of view (FOV) info:

Type:

Object

Properties:

Name	Type	Description
`h`	Float32	horizontal field of view
`v`	Float32	vertical field of view

Source:

index.js, line 3938

See:

util.fov

FrameCallback(frame)

This callback is called when a frame is captured

Parameters:

Name	Type	Description
`frame`	Frame	The captured frame

Source:

index.js, line 836

See:

Sensor.start

IntrinsicsObject

Stream intrinsics:

Type:

Object

Properties:

Name	Type	Description
`width`	Integer	Width of the image in pixels
`height`	Integer	Height of the image in pixels
`ppx`	Float32	Horizontal coordinate of the principal point of the image, as a pixel offset from the left edge
`ppy`	Float32	Vertical coordinate of the principal point of the image, as a pixel offset from the top edge
`fx`	Float32	Focal length of the image plane, as a multiple of pixel width
`fy`	Float32	Focal length of the image plane, as a multiple of pixel height
`model`	Integer	Distortion model of the image, see
`coeffs`	Array.<Float32>	Array(5), Distortion coefficients

Source:

index.js, line 546

See:

StreamProfile.getIntrinsics()

MotionIntrinsics

Motion intrinsics: scale, bias, and variances.

Type:

Object

Properties:

Name	Type	Description
`data`	Array.<Float32>	Array(12), Interpret data array values. Indices are: [0 - Scale X, 1 - cross axis, 2 - cross axis, 3 - Bias X, 4 - cross axis, 5 - Scale Y, 6 - cross axis, 7 - Bias Y, 8 - cross axis, 9 - cross axis, 10 - Scale Z, 11 - Bias Z]
`noiseVariances`	Array.<Float32>	Array(3), Variance of noise for X, Y, and Z axis
`biasVariances`	Array.<Float32>	Array(3), Variance of bias for X, Y, and Z axis

Source:

index.js, line 401

See:

MotionStreamProfile.getMotionIntrinsics()

NotificationCallback(info)

This callback is called when there is a device notification

Parameters:

Name Type Description

info

NotificationEventObject

Properties

Name	Type	Description
`descr`	String	See NotificationEventObject for details
`timestamp`	Float	See NotificationEventObject for details
`severity`	String	See NotificationEventObject for details
`category`	String	See NotificationEventObject for details
`serializedData`	String	See NotificationEventObject for details

Source:

index.js, line 934

See:

NotificationEventObject

Type:

Object

Properties:

Name	Type	Description
`descr`	String	The human readable literal description of the notification
`timestamp`	Float	The timestamp of the notification
`severity`	String	The severity of the notification
`category`	String	The category of the notification
`serializedData`	String	The serialized data of the notification

Source:

index.js, line 925

OptionRangeObject

Type:

Object

Properties:

Name	Type	Description
`minValue`	Float32	the minimum value which will be accepted for this option
`maxValue`	Float32	the maximum value which will be accepted for this option
`defaultValue`	Float32	the default value of the option
`step`	Float32	the granularity of options which accept discrete values, or zero if the option accepts continuous values

Source:

index.js, line 613

See:

Sensor.getOptionRange()

PlaybackStatusObject

Type:

Object

Properties:

Name	Type	Description
`status`	Integer	The status of the notification, see playback_status for details
`description`	String	The human readable literal description of the status

Source:

index.js, line 1732

PoseData

Type:

Object

Properties:

Name	Type	Description
`translation`	Vector	X, Y, Z values of translation, in meters (relative to initial position)
`velocity`	Vector	X, Y, Z values of velocity, in meter/sec
`acceleration`	Vector	X, Y, Z values of acceleration, in meter/sec^2
`rotation`	Quaternion	Qi, Qj, Qk, Qr components of rotation as represented in quaternion rotation (relative to initial position)
`angularVelocity`	Vector	X, Y, Z values of angular velocity, in radians/sec
`angularAcceleration`	Vector	X, Y, Z values of angular acceleration, in radians/sec^2
`trackerConfidence`	Integer	pose data confidence 0 - Failed, 1 - Low, 2 - Medium, 3 - High
`mapperConfidence`	Integer	pose data confidence 0 - Failed, 1 - Low, 2 - Medium, 3 - High

Source:

index.js, line 2458

See:

PoseFrame.getPoseData()

Quaternion

Quaternion used to represent rotation

Type:

Object

Properties:

Name	Type	Description
`x`	Float32
`y`	Float32
`z`	Float32
`w`	Float32

Source:

index.js, line 2429

See:

PoseFrame.getPoseData()

RegionOfInterestObject

Type:

Object

Properties:

Name	Type	Description
`minX`	Float32	lower horizontal bound in pixels
`minY`	Float32	lower vertical bound in pixels
`maxX`	Float32	upper horizontal bound in pixels
`maxY`	Float32	upper vertical bound in pixels