Classes |
struct | rs_extrinsics |
| Cross-stream extrinsics: encode the topology describing how the different devices are connected. More...
|
struct | rs_intrinsics |
| Video stream intrinsics. More...
|
struct | rs_motion_data |
| Motion data from gyroscope and accelerometer from the microcontroller. More...
|
struct | rs_motion_device_intrinsic |
| Motion device intrinsics: scale, bias, and variances. More...
|
struct | rs_motion_intrinsics |
| Motion module intrinsics: includes accelerometer and gyroscope intrinsics structs of type rs_motion_device_intrinsic . More...
|
struct | rs_timestamp_data |
| Timestamp data from the motion microcontroller. More...
|
Defines |
#define | RS_API_MAJOR_VERSION 1 |
#define | RS_API_MINOR_VERSION 12 |
#define | RS_API_PATCH_VERSION 3 |
#define | RS_API_VERSION (((RS_API_MAJOR_VERSION) * 10000) + ((RS_API_MINOR_VERSION) * 100) + (RS_API_PATCH_VERSION)) |
#define | RS_API_VERSION_STR (VAR_ARG_STRING(RS_API_MAJOR_VERSION.RS_API_MINOR_VERSION.RS_API_PATCH_VERSION)) |
#define | STRINGIFY(arg) #arg |
#define | VAR_ARG_STRING(arg) STRINGIFY(arg) |
Typedefs |
typedef enum rs_blob_type | rs_blob_type |
| Proprietary formats for direct communication with device firmware.
|
typedef enum rs_camera_info | rs_camera_info |
| Read-only strings that can be queried from the device.
|
typedef enum rs_capabilities | rs_capabilities |
| Specifies various capabilities of a RealSense device.
|
typedef struct rs_context | rs_context |
typedef struct rs_device | rs_device |
typedef enum rs_distortion | rs_distortion |
| Distortion model: defines how pixel coordinates should be mapped to sensor coordinates.
|
typedef struct rs_error | rs_error |
typedef enum rs_event_source | rs_event_source |
| Source device that triggered a specific timestamp event from the motion module.
|
typedef struct rs_extrinsics | rs_extrinsics |
| Cross-stream extrinsics: encode the topology describing how the different devices are connected.
|
typedef enum rs_format | rs_format |
| Formats: defines how each stream can be encoded.
|
typedef struct rs_frame_callback | rs_frame_callback |
typedef void(* | rs_frame_callback_ptr )(rs_device *dev, rs_frame_ref *frame, void *user) |
typedef enum rs_frame_metadata | rs_frame_metadata |
| Types of value provided from the device with each frame.
|
typedef struct rs_frame_ref | rs_frame_ref |
typedef struct rs_frameset | rs_frameset |
typedef struct rs_intrinsics | rs_intrinsics |
| Video stream intrinsics.
|
typedef enum rs_ivcam_preset | rs_ivcam_preset |
| For SR300 devices: provides optimized settings (presets) for specific types of usage.
|
typedef struct rs_log_callback | rs_log_callback |
typedef void(* | rs_log_callback_ptr )(rs_log_severity min_severity, const char *message, void *user) |
typedef enum rs_log_severity | rs_log_severity |
| Severity of the librealsense logger.
|
typedef struct rs_motion_callback | rs_motion_callback |
typedef void(* | rs_motion_callback_ptr )(rs_device *, rs_motion_data, void *) |
typedef struct rs_motion_data | rs_motion_data |
| Motion data from gyroscope and accelerometer from the microcontroller.
|
typedef struct
rs_motion_device_intrinsic | rs_motion_device_intrinsic |
| Motion device intrinsics: scale, bias, and variances.
|
typedef struct rs_motion_intrinsics | rs_motion_intrinsics |
| Motion module intrinsics: includes accelerometer and gyroscope intrinsics structs of type rs_motion_device_intrinsic .
|
typedef enum rs_option | rs_option |
| Defines general configuration controls.
|
typedef enum
rs_output_buffer_format | rs_output_buffer_format |
| Output buffer format: sets how librealsense works with frame memory.
|
typedef enum rs_preset | rs_preset |
| Presets: general preferences that are translated by librealsense into concrete resolution and FPS.
|
typedef enum rs_source | rs_source |
| Source: allows you to choose between available hardware subdevices.
|
typedef enum rs_stream | rs_stream |
| Streams are different types of data provided by RealSense devices.
|
typedef struct
rs_timestamp_callback | rs_timestamp_callback |
typedef void(* | rs_timestamp_callback_ptr )(rs_device *, rs_timestamp_data, void *) |
typedef struct rs_timestamp_data | rs_timestamp_data |
| Timestamp data from the motion microcontroller.
|
typedef enum rs_timestamp_domain | rs_timestamp_domain |
| Specifies the clock in relation to which the frame timestamp was measured.
|
Enumerations |
enum | rs_blob_type { RS_BLOB_TYPE_MOTION_MODULE_FIRMWARE_UPDATE,
RS_BLOB_TYPE_COUNT
} |
| Proprietary formats for direct communication with device firmware. More...
|
enum | rs_camera_info {
RS_CAMERA_INFO_DEVICE_NAME,
RS_CAMERA_INFO_DEVICE_SERIAL_NUMBER,
RS_CAMERA_INFO_CAMERA_FIRMWARE_VERSION,
RS_CAMERA_INFO_ADAPTER_BOARD_FIRMWARE_VERSION,
RS_CAMERA_INFO_MOTION_MODULE_FIRMWARE_VERSION,
RS_CAMERA_INFO_CAMERA_TYPE,
RS_CAMERA_INFO_OEM_ID,
RS_CAMERA_INFO_ISP_FW_VERSION,
RS_CAMERA_INFO_CONTENT_VERSION,
RS_CAMERA_INFO_MODULE_VERSION,
RS_CAMERA_INFO_IMAGER_MODEL_NUMBER,
RS_CAMERA_INFO_BUILD_DATE,
RS_CAMERA_INFO_CALIBRATION_DATE,
RS_CAMERA_INFO_PROGRAM_DATE,
RS_CAMERA_INFO_FOCUS_ALIGNMENT_DATE,
RS_CAMERA_INFO_EMITTER_TYPE,
RS_CAMERA_INFO_FOCUS_VALUE,
RS_CAMERA_INFO_LENS_TYPE,
RS_CAMERA_INFO_3RD_LENS_TYPE,
RS_CAMERA_INFO_LENS_COATING__TYPE,
RS_CAMERA_INFO_3RD_LENS_COATING_TYPE,
RS_CAMERA_INFO_NOMINAL_BASELINE,
RS_CAMERA_INFO_3RD_NOMINAL_BASELINE,
RS_CAMERA_INFO_COUNT
} |
| Read-only strings that can be queried from the device. More...
|
enum | rs_capabilities {
RS_CAPABILITIES_DEPTH,
RS_CAPABILITIES_COLOR,
RS_CAPABILITIES_INFRARED,
RS_CAPABILITIES_INFRARED2,
RS_CAPABILITIES_FISH_EYE,
RS_CAPABILITIES_MOTION_EVENTS,
RS_CAPABILITIES_MOTION_MODULE_FW_UPDATE,
RS_CAPABILITIES_ADAPTER_BOARD,
RS_CAPABILITIES_ENUMERATION,
RS_CAPABILITIES_COUNT
} |
| Specifies various capabilities of a RealSense device. More...
|
enum | rs_distortion {
RS_DISTORTION_NONE,
RS_DISTORTION_MODIFIED_BROWN_CONRADY,
RS_DISTORTION_INVERSE_BROWN_CONRADY,
RS_DISTORTION_FTHETA,
RS_DISTORTION_COUNT
} |
| Distortion model: defines how pixel coordinates should be mapped to sensor coordinates. More...
|
enum | rs_event_source {
RS_EVENT_IMU_ACCEL,
RS_EVENT_IMU_GYRO,
RS_EVENT_IMU_DEPTH_CAM,
RS_EVENT_IMU_MOTION_CAM,
RS_EVENT_G0_SYNC,
RS_EVENT_G1_SYNC,
RS_EVENT_G2_SYNC,
RS_EVENT_SOURCE_COUNT
} |
| Source device that triggered a specific timestamp event from the motion module. More...
|
enum | rs_format {
RS_FORMAT_ANY,
RS_FORMAT_Z16,
RS_FORMAT_DISPARITY16,
RS_FORMAT_XYZ32F,
RS_FORMAT_YUYV,
RS_FORMAT_RGB8,
RS_FORMAT_BGR8,
RS_FORMAT_RGBA8,
RS_FORMAT_BGRA8,
RS_FORMAT_Y8,
RS_FORMAT_Y16,
RS_FORMAT_RAW10,
RS_FORMAT_RAW16,
RS_FORMAT_RAW8,
RS_FORMAT_COUNT
} |
| Formats: defines how each stream can be encoded. More...
|
enum | rs_frame_metadata { RS_FRAME_METADATA_ACTUAL_EXPOSURE,
RS_FRAME_METADATA_ACTUAL_FPS,
RS_FRAME_METADATA_COUNT
} |
| Types of value provided from the device with each frame. More...
|
enum | rs_ivcam_preset {
RS_IVCAM_PRESET_SHORT_RANGE,
RS_IVCAM_PRESET_LONG_RANGE,
RS_IVCAM_PRESET_BACKGROUND_SEGMENTATION,
RS_IVCAM_PRESET_GESTURE_RECOGNITION,
RS_IVCAM_PRESET_OBJECT_SCANNING,
RS_IVCAM_PRESET_FACE_ANALYTICS,
RS_IVCAM_PRESET_FACE_LOGIN,
RS_IVCAM_PRESET_GR_CURSOR,
RS_IVCAM_PRESET_DEFAULT,
RS_IVCAM_PRESET_MID_RANGE,
RS_IVCAM_PRESET_IR_ONLY,
RS_IVCAM_PRESET_COUNT
} |
| For SR300 devices: provides optimized settings (presets) for specific types of usage. More...
|
enum | rs_log_severity {
RS_LOG_SEVERITY_DEBUG,
RS_LOG_SEVERITY_INFO,
RS_LOG_SEVERITY_WARN,
RS_LOG_SEVERITY_ERROR,
RS_LOG_SEVERITY_FATAL,
RS_LOG_SEVERITY_NONE,
RS_LOG_SEVERITY_COUNT
} |
| Severity of the librealsense logger. More...
|
enum | rs_option {
RS_OPTION_COLOR_BACKLIGHT_COMPENSATION,
RS_OPTION_COLOR_BRIGHTNESS,
RS_OPTION_COLOR_CONTRAST,
RS_OPTION_COLOR_EXPOSURE,
RS_OPTION_COLOR_GAIN,
RS_OPTION_COLOR_GAMMA,
RS_OPTION_COLOR_HUE,
RS_OPTION_COLOR_SATURATION,
RS_OPTION_COLOR_SHARPNESS,
RS_OPTION_COLOR_WHITE_BALANCE,
RS_OPTION_COLOR_ENABLE_AUTO_EXPOSURE,
RS_OPTION_COLOR_ENABLE_AUTO_WHITE_BALANCE,
RS_OPTION_F200_LASER_POWER,
RS_OPTION_F200_ACCURACY,
RS_OPTION_F200_MOTION_RANGE,
RS_OPTION_F200_FILTER_OPTION,
RS_OPTION_F200_CONFIDENCE_THRESHOLD,
RS_OPTION_F200_DYNAMIC_FPS,
RS_OPTION_SR300_AUTO_RANGE_ENABLE_MOTION_VERSUS_RANGE,
RS_OPTION_SR300_AUTO_RANGE_ENABLE_LASER,
RS_OPTION_SR300_AUTO_RANGE_MIN_MOTION_VERSUS_RANGE,
RS_OPTION_SR300_AUTO_RANGE_MAX_MOTION_VERSUS_RANGE,
RS_OPTION_SR300_AUTO_RANGE_START_MOTION_VERSUS_RANGE,
RS_OPTION_SR300_AUTO_RANGE_MIN_LASER,
RS_OPTION_SR300_AUTO_RANGE_MAX_LASER,
RS_OPTION_SR300_AUTO_RANGE_START_LASER,
RS_OPTION_SR300_AUTO_RANGE_UPPER_THRESHOLD,
RS_OPTION_SR300_AUTO_RANGE_LOWER_THRESHOLD,
RS_OPTION_R200_LR_AUTO_EXPOSURE_ENABLED,
RS_OPTION_R200_LR_GAIN,
RS_OPTION_R200_LR_EXPOSURE,
RS_OPTION_R200_EMITTER_ENABLED,
RS_OPTION_R200_DEPTH_UNITS,
RS_OPTION_R200_DEPTH_CLAMP_MIN,
RS_OPTION_R200_DEPTH_CLAMP_MAX,
RS_OPTION_R200_DISPARITY_MULTIPLIER,
RS_OPTION_R200_DISPARITY_SHIFT,
RS_OPTION_R200_AUTO_EXPOSURE_MEAN_INTENSITY_SET_POINT,
RS_OPTION_R200_AUTO_EXPOSURE_BRIGHT_RATIO_SET_POINT,
RS_OPTION_R200_AUTO_EXPOSURE_KP_GAIN,
RS_OPTION_R200_AUTO_EXPOSURE_KP_EXPOSURE,
RS_OPTION_R200_AUTO_EXPOSURE_KP_DARK_THRESHOLD,
RS_OPTION_R200_AUTO_EXPOSURE_TOP_EDGE,
RS_OPTION_R200_AUTO_EXPOSURE_BOTTOM_EDGE,
RS_OPTION_R200_AUTO_EXPOSURE_LEFT_EDGE,
RS_OPTION_R200_AUTO_EXPOSURE_RIGHT_EDGE,
RS_OPTION_R200_DEPTH_CONTROL_ESTIMATE_MEDIAN_DECREMENT,
RS_OPTION_R200_DEPTH_CONTROL_ESTIMATE_MEDIAN_INCREMENT,
RS_OPTION_R200_DEPTH_CONTROL_MEDIAN_THRESHOLD,
RS_OPTION_R200_DEPTH_CONTROL_SCORE_MINIMUM_THRESHOLD,
RS_OPTION_R200_DEPTH_CONTROL_SCORE_MAXIMUM_THRESHOLD,
RS_OPTION_R200_DEPTH_CONTROL_TEXTURE_COUNT_THRESHOLD,
RS_OPTION_R200_DEPTH_CONTROL_TEXTURE_DIFFERENCE_THRESHOLD,
RS_OPTION_R200_DEPTH_CONTROL_SECOND_PEAK_THRESHOLD,
RS_OPTION_R200_DEPTH_CONTROL_NEIGHBOR_THRESHOLD,
RS_OPTION_R200_DEPTH_CONTROL_LR_THRESHOLD,
RS_OPTION_FISHEYE_EXPOSURE,
RS_OPTION_FISHEYE_GAIN,
RS_OPTION_FISHEYE_STROBE,
RS_OPTION_FISHEYE_EXTERNAL_TRIGGER,
RS_OPTION_FISHEYE_ENABLE_AUTO_EXPOSURE,
RS_OPTION_FISHEYE_AUTO_EXPOSURE_MODE,
RS_OPTION_FISHEYE_AUTO_EXPOSURE_ANTIFLICKER_RATE,
RS_OPTION_FISHEYE_AUTO_EXPOSURE_PIXEL_SAMPLE_RATE,
RS_OPTION_FISHEYE_AUTO_EXPOSURE_SKIP_FRAMES,
RS_OPTION_FRAMES_QUEUE_SIZE,
RS_OPTION_HARDWARE_LOGGER_ENABLED,
RS_OPTION_TOTAL_FRAME_DROPS,
RS_OPTION_COUNT
} |
| Defines general configuration controls. More...
|
enum | rs_output_buffer_format { RS_OUTPUT_BUFFER_FORMAT_CONTINUOUS,
RS_OUTPUT_BUFFER_FORMAT_NATIVE,
RS_OUTPUT_BUFFER_FORMAT_COUNT
} |
| Output buffer format: sets how librealsense works with frame memory. More...
|
enum | rs_preset { RS_PRESET_BEST_QUALITY,
RS_PRESET_LARGEST_IMAGE,
RS_PRESET_HIGHEST_FRAMERATE,
RS_PRESET_COUNT
} |
| Presets: general preferences that are translated by librealsense into concrete resolution and FPS. More...
|
enum | rs_source { RS_SOURCE_VIDEO,
RS_SOURCE_MOTION_TRACKING,
RS_SOURCE_ALL,
RS_SOURCE_COUNT
} |
| Source: allows you to choose between available hardware subdevices. More...
|
enum | rs_stream {
RS_STREAM_DEPTH,
RS_STREAM_COLOR,
RS_STREAM_INFRARED,
RS_STREAM_INFRARED2,
RS_STREAM_FISHEYE,
RS_STREAM_POINTS,
RS_STREAM_RECTIFIED_COLOR,
RS_STREAM_COLOR_ALIGNED_TO_DEPTH,
RS_STREAM_INFRARED2_ALIGNED_TO_DEPTH,
RS_STREAM_DEPTH_ALIGNED_TO_COLOR,
RS_STREAM_DEPTH_ALIGNED_TO_RECTIFIED_COLOR,
RS_STREAM_DEPTH_ALIGNED_TO_INFRARED2,
RS_STREAM_COUNT
} |
| Streams are different types of data provided by RealSense devices. More...
|
enum | rs_timestamp_domain { RS_TIMESTAMP_DOMAIN_CAMERA,
RS_TIMESTAMP_DOMAIN_MICROCONTROLLER,
RS_TIMESTAMP_DOMAIN_COUNT
} |
| Specifies the clock in relation to which the frame timestamp was measured. More...
|
Functions |
const char * | rs_blob_type_to_string (rs_blob_type type) |
const char * | rs_camera_info_to_string (rs_camera_info info) |
const char * | rs_capabilities_to_string (rs_capabilities capability) |
rs_context * | rs_create_context (int api_version, rs_error **error) |
| Creates RealSense context that is required for the rest of the API.
|
void | rs_delete_context (rs_context *context, rs_error **error) |
| Frees the relevant context object.
|
int | rs_device_supports_option (const rs_device *device, rs_option option, rs_error **error) |
| Determines if the device allows a specific option to be queried and set.
|
void | rs_disable_motion_tracking (rs_device *device, rs_error **error) |
| Disables motion-tracking handlers.
|
void | rs_disable_stream (rs_device *device, rs_stream stream, rs_error **error) |
| Disables a specific stream.
|
const char * | rs_distortion_to_string (rs_distortion distortion) |
void | rs_enable_motion_tracking (rs_device *device, rs_motion_callback_ptr on_motion_event, void *motion_handler, rs_timestamp_callback_ptr on_timestamp_event, void *timestamp_handler, rs_error **error) |
| Enables and configures motion-tracking data handlers.
|
void | rs_enable_motion_tracking_cpp (rs_device *device, rs_motion_callback *motion_callback, rs_timestamp_callback *timestamp_callback, rs_error **error) |
| Enables and configures motion-tracking data handlers.
|
void | rs_enable_stream (rs_device *device, rs_stream stream, int width, int height, rs_format format, int framerate, rs_error **error) |
| Enables a specific stream and requests specific properties.
|
void | rs_enable_stream_ex (rs_device *device, rs_stream stream, int width, int height, rs_format format, int framerate, rs_output_buffer_format output_format, rs_error **error) |
| Enables a specific stream and requests specific properties.
|
void | rs_enable_stream_preset (rs_device *device, rs_stream stream, rs_preset preset, rs_error **error) |
| Enables a specific stream and requests properties using a preset.
|
const char * | rs_event_to_string (rs_event_source event) |
const char * | rs_format_to_string (rs_format format) |
const char * | rs_frame_metadata_to_string (rs_frame_metadata md) |
void | rs_free_error (rs_error *error) |
| Frees memory of an error object.
|
int | rs_get_api_version (rs_error **error) |
| Retrieves API version from the source code. Evaluate that the value is conformant to the established policies.
|
int | rs_get_detached_frame_bpp (const rs_frame_ref *frame, rs_error **error) |
| Retrieves frame bits per pixel.
|
const void * | rs_get_detached_frame_data (const rs_frame_ref *frame, rs_error **error) |
| Retrieves data from frame reference.
|
rs_format | rs_get_detached_frame_format (const rs_frame_ref *frame, rs_error **error) |
| Retrieves frame format.
|
int | rs_get_detached_frame_height (const rs_frame_ref *frame, rs_error **error) |
| Retrieves frame intrinsic height.
|
double | rs_get_detached_frame_metadata (const rs_frame_ref *frame, rs_frame_metadata frame_metadata, rs_error **error) |
| Retrieves metadata from a frame reference.
|
unsigned long long | rs_get_detached_frame_number (const rs_frame_ref *frame, rs_error **error) |
| Retrieves frame number from frame reference.
|
rs_stream | rs_get_detached_frame_stream_type (const rs_frame_ref *frame, rs_error **error) |
| Retrieves frame stream type.
|
int | rs_get_detached_frame_stride (const rs_frame_ref *frame, rs_error **error) |
| Retrieves frame stride, meaning the actual line width in memory in bytes (not the logical image width)
|
double | rs_get_detached_frame_timestamp (const rs_frame_ref *frame, rs_error **error) |
| Retrieves timestamp from frame reference.
|
rs_timestamp_domain | rs_get_detached_frame_timestamp_domain (const rs_frame_ref *frame, rs_error **error) |
| Retrieves timestamp domain from frame reference.
|
int | rs_get_detached_frame_width (const rs_frame_ref *frame, rs_error **error) |
| Retrieves frame intrinsic width in pixels.
|
int | rs_get_detached_framerate (const rs_frame_ref *frame, rs_error **error) |
| Retrieves frame intrinsic frame rate.
|
rs_device * | rs_get_device (rs_context *context, int index, rs_error **error) |
| Retrieves connected device by index.
|
int | rs_get_device_count (const rs_context *context, rs_error **error) |
| Determines number of connected devices.
|
float | rs_get_device_depth_scale (const rs_device *device, rs_error **error) |
| Retrieves mapping between the units of the depth image and meters.
|
void | rs_get_device_extrinsics (const rs_device *device, rs_stream from_stream, rs_stream to_stream, rs_extrinsics *extrin, rs_error **error) |
| Retrieves extrinsic transformation between the viewpoints of two different streams.
|
const char * | rs_get_device_firmware_version (const rs_device *device, rs_error **error) |
| Retrieves the version of the firmware currently installed on the device.
|
const char * | rs_get_device_info (const rs_device *device, rs_camera_info info, rs_error **error) |
| Retrieves camera specific information, such as versions of various internal componnents.
|
const char * | rs_get_device_name (const rs_device *device, rs_error **error) |
| Retrieves human-readable device model string.
|
double | rs_get_device_option (rs_device *device, rs_option option, rs_error **error) |
| Retrieves the current value of a single option.
|
const char * | rs_get_device_option_description (rs_device *device, rs_option option, rs_error **error) |
| Retrieves a static description of what a particular option does on given device.
|
void | rs_get_device_option_range (rs_device *device, rs_option option, double *min, double *max, double *step, rs_error **error) |
| Retrieves the available range of values for a supported option.
|
void | rs_get_device_option_range_ex (rs_device *device, rs_option option, double *min, double *max, double *step, double *def, rs_error **error) |
| Retrieves the available range of values for a supported option.
|
void | rs_get_device_options (rs_device *device, const rs_option *options, unsigned int count, double *values, rs_error **error) |
| Efficiently retrieves the value of an arbitrary number of options, using minimal hardware IO.
|
const char * | rs_get_device_serial (const rs_device *device, rs_error **error) |
| Retrieves unique serial number of the device.
|
const char * | rs_get_device_usb_port_id (const rs_device *device, rs_error **error) |
| Retrieves the USB port number of the device.
|
const char * | rs_get_error_message (const rs_error *error) |
| Returns static pointer to error message.
|
const char * | rs_get_failed_args (const rs_error *error) |
| Returns static pointer to arguments of a failing function in case of error.
|
const char * | rs_get_failed_function (const rs_error *error) |
| Returns static pointer to name of a failing function in case of error.
|
const void * | rs_get_frame_data (const rs_device *device, rs_stream stream, rs_error **error) |
| Retrieves the contents of the latest frame on a stream.
|
unsigned long long | rs_get_frame_number (const rs_device *device, rs_stream stream, rs_error **error) |
| Retrieves frame number.
|
double | rs_get_frame_timestamp (const rs_device *device, rs_stream stream, rs_error **error) |
| Retrieves time at which the latest frame on a stream was captured.
|
void | rs_get_motion_extrinsics_from (const rs_device *device, rs_stream from, rs_extrinsics *extrin, rs_error **error) |
| Retrieves extrinsic transformation between specific stream and the motion module.
|
void | rs_get_motion_intrinsics (const rs_device *device, rs_motion_intrinsics *intrinsic, rs_error **error) |
| Retrieves intrinsic camera parameters for a motion module.
|
rs_format | rs_get_stream_format (const rs_device *device, rs_stream stream, rs_error **error) |
| Retrieves the pixel format for a specific stream.
|
int | rs_get_stream_framerate (const rs_device *device, rs_stream stream, rs_error **error) |
| Retrieves the frame rate for a specific stream.
|
int | rs_get_stream_height (const rs_device *device, rs_stream stream, rs_error **error) |
| Retrieves the height in pixels of a specific stream, equivalent to the height field from the stream's intrinsic.
|
void | rs_get_stream_intrinsics (const rs_device *device, rs_stream stream, rs_intrinsics *intrin, rs_error **error) |
| Retrieves intrinsic camera parameters for a specific stream.
|
void | rs_get_stream_mode (const rs_device *device, rs_stream stream, int index, int *width, int *height, rs_format *format, int *framerate, rs_error **error) |
| Determines the properties of a specific streaming mode.
|
int | rs_get_stream_mode_count (const rs_device *device, rs_stream stream, rs_error **error) |
| Determines the number of streaming modes available for a given stream.
|
int | rs_get_stream_width (const rs_device *device, rs_stream stream, rs_error **error) |
| Retrieves the width in pixels of a specific stream, equivalent to the width field from the stream's intrinsic.
|
int | rs_is_device_streaming (const rs_device *device, rs_error **error) |
| Determines if the device is currently streaming.
|
int | rs_is_motion_tracking_active (rs_device *device, rs_error **error) |
| Checks if data acquisition is active.
|
int | rs_is_stream_enabled (const rs_device *device, rs_stream stream, rs_error **error) |
| Determines if a specific stream is enabled.
|
void | rs_log_to_callback (rs_log_severity min_severity, rs_log_callback_ptr on_log, void *user, rs_error **error) |
| Starts logging to user-provided callback (C version)
|
void | rs_log_to_callback_cpp (rs_log_severity min_severity, rs_log_callback *callback, rs_error **error) |
| Starts logging to user-provided callback.
|
void | rs_log_to_console (rs_log_severity min_severity, rs_error **error) |
| Starts logging to console.
|
void | rs_log_to_file (rs_log_severity min_severity, const char *file_path, rs_error **error) |
| Starts logging to file.
|
const char * | rs_option_to_string (rs_option option) |
int | rs_poll_for_frames (rs_device *device, rs_error **error) |
| Checks if new frames are available, without blocking.
|
const char * | rs_preset_to_string (rs_preset preset) |
void | rs_release_frame (rs_device *device, rs_frame_ref *frame, rs_error **error) |
| Releases frame handle.
|
void | rs_reset_device_options_to_default (rs_device *device, const rs_option *options, int count, rs_error **error) |
| Efficiently resets the value of an arbitrary number of options to default.
|
void | rs_send_blob_to_device (rs_device *device, rs_blob_type type, void *data, int size, rs_error **error) |
| Sends arbitrary binary data to the device.
|
void | rs_set_device_option (rs_device *device, rs_option option, double value, rs_error **error) |
| Sets the current value of a single option.
|
void | rs_set_device_options (rs_device *device, const rs_option *options, unsigned int count, const double *values, rs_error **error) |
| Efficiently sets the value of an arbitrary number of options, using minimal hardware IO.
|
void | rs_set_frame_callback (rs_device *device, rs_stream stream, rs_frame_callback_ptr on_frame, void *user, rs_error **error) |
| Sets up a frame callback that is called immediately when an image is available, with no synchronization logic applied.
|
void | rs_set_frame_callback_cpp (rs_device *device, rs_stream stream, rs_frame_callback *callback, rs_error **error) |
| Sets up a frame callback that is called immediately when an image is available, with no synchronization logic applied.
|
const char * | rs_source_to_string (rs_source source) |
void | rs_start_device (rs_device *device, rs_error **error) |
| Begins streaming on all enabled streams for this device.
|
void | rs_start_source (rs_device *device, rs_source source, rs_error **error) |
| Begins streaming on all enabled streams for this device.
|
void | rs_stop_device (rs_device *device, rs_error **error) |
| Ends data acquisition for the specified source providers.
|
void | rs_stop_source (rs_device *device, rs_source source, rs_error **error) |
| Ends data acquisition for the specified source providers.
|
const char * | rs_stream_to_string (rs_stream stream) |
int | rs_supports (rs_device *device, rs_capabilities capability, rs_error **error) |
| Determines device capabilities.
|
int | rs_supports_camera_info (rs_device *device, rs_camera_info info_param, rs_error **error) |
| Returns true if given camera information parameter is supported by the device.
|
int | rs_supports_frame_metadata (const rs_frame_ref *frame, rs_frame_metadata frame_metadata, rs_error **error) |
| Determines device metadata.
|
const char * | rs_timestamp_domain_to_string (rs_timestamp_domain info) |
void | rs_wait_for_frames (rs_device *device, rs_error **error) |
| Blocks until new frames are available.
|