Enum rs2_frame_metadata_value

• Defined in File rs_frame.h

Enum Documentation

enum rs2_frame_metadata_value

Per-Frame-Metadata is the set of read-only properties that might be exposed for each individual frame.

Values:

enumerator RS2_FRAME_METADATA_FRAME_COUNTER

A sequential index managed per-stream. Integer value

enumerator RS2_FRAME_METADATA_FRAME_TIMESTAMP

Timestamp set by device clock when data readout and transmit commence. usec

enumerator RS2_FRAME_METADATA_SENSOR_TIMESTAMP

Timestamp of the middle of sensor’s exposure calculated by device. usec

enumerator RS2_FRAME_METADATA_ACTUAL_EXPOSURE

Sensor’s exposure width. When Auto Exposure (AE) is on the value is controlled by firmware. usec

enumerator RS2_FRAME_METADATA_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

enumerator RS2_FRAME_METADATA_AUTO_EXPOSURE

Auto Exposure Mode indicator. Zero corresponds to AE switched off.

enumerator RS2_FRAME_METADATA_WHITE_BALANCE

White Balance setting as a color temperature. Kelvin degrees

enumerator RS2_FRAME_METADATA_TIME_OF_ARRIVAL

Time of arrival in system clock

enumerator RS2_FRAME_METADATA_TEMPERATURE

Temperature of the device, measured at the time of the frame capture. Celsius degrees

enumerator RS2_FRAME_METADATA_BACKEND_TIMESTAMP

Timestamp get from uvc driver. usec

enumerator RS2_FRAME_METADATA_ACTUAL_FPS

Actual fps, times 1000 (30.1 fps would be 30100 in the metadata)

enumerator RS2_FRAME_METADATA_FRAME_LASER_POWER

Laser power value 0-360.

enumerator RS2_FRAME_METADATA_FRAME_LASER_POWER_MODE

Laser power mode. Zero corresponds to Laser power switched off and one for switched on. deprecated, replaced by RS2_FRAME_METADATA_FRAME_EMITTER_MODE

enumerator RS2_FRAME_METADATA_EXPOSURE_PRIORITY

Exposure priority.

enumerator RS2_FRAME_METADATA_EXPOSURE_ROI_LEFT

Left region of interest for the auto exposure Algorithm.

enumerator RS2_FRAME_METADATA_EXPOSURE_ROI_RIGHT

Right region of interest for the auto exposure Algorithm.

enumerator RS2_FRAME_METADATA_EXPOSURE_ROI_TOP

Top region of interest for the auto exposure Algorithm.

enumerator RS2_FRAME_METADATA_EXPOSURE_ROI_BOTTOM

Bottom region of interest for the auto exposure Algorithm.

enumerator RS2_FRAME_METADATA_BRIGHTNESS

Color image brightness.

enumerator RS2_FRAME_METADATA_CONTRAST

Color image contrast.

enumerator RS2_FRAME_METADATA_SATURATION

Color image saturation.

enumerator RS2_FRAME_METADATA_SHARPNESS

Color image sharpness.

enumerator RS2_FRAME_METADATA_AUTO_WHITE_BALANCE_TEMPERATURE

Auto white balance temperature Mode indicator. Zero corresponds to automatic mode switched off.

enumerator RS2_FRAME_METADATA_BACKLIGHT_COMPENSATION

Color backlight compensation. Zero corresponds to switched off.

enumerator RS2_FRAME_METADATA_HUE

Color image hue.

enumerator RS2_FRAME_METADATA_GAMMA

Color image gamma.

enumerator RS2_FRAME_METADATA_MANUAL_WHITE_BALANCE

Color image white balance. Manual WB value on D400, current WB value on D585S

enumerator RS2_FRAME_METADATA_POWER_LINE_FREQUENCY

Power Line Frequency for anti-flickering Off/50Hz/60Hz/Auto.

enumerator RS2_FRAME_METADATA_LOW_LIGHT_COMPENSATION

Color lowlight compensation. Zero corresponds to switched off.

enumerator RS2_FRAME_METADATA_FRAME_EMITTER_MODE

Emitter mode: 0 - all emitters disabled. 1 - laser enabled. 2 - auto laser enabled (opt). 3 - LED enabled (opt).

enumerator RS2_FRAME_METADATA_FRAME_LED_POWER

Led power value 0-360.

enumerator RS2_FRAME_METADATA_RAW_FRAME_SIZE

The number of transmitted payload bytes, not including metadata

enumerator RS2_FRAME_METADATA_GPIO_INPUT_DATA

GPIO input data

enumerator RS2_FRAME_METADATA_SEQUENCE_NAME

sub-preset id

enumerator RS2_FRAME_METADATA_SEQUENCE_ID

sub-preset sequence id

enumerator RS2_FRAME_METADATA_SEQUENCE_SIZE

sub-preset sequence size

enumerator RS2_FRAME_METADATA_TRIGGER

Frame trigger type

enumerator RS2_FRAME_METADATA_PRESET

Preset id, used in MIPI SKU Metadata

enumerator RS2_FRAME_METADATA_INPUT_WIDTH

Frame input width in pixels, used as safety attribute

enumerator RS2_FRAME_METADATA_INPUT_HEIGHT

Frame input height in pixels, used as safety attribute

enumerator RS2_FRAME_METADATA_SUB_PRESET_INFO

Sub-preset information

enumerator RS2_FRAME_METADATA_CALIB_INFO

FW-controlled frame counter to be using in Calibration scenarios

enumerator RS2_FRAME_METADATA_CRC

CRC checksum of the Metadata

enumerator RS2_FRAME_METADATA_SAFETY_DEPTH_FRAME_COUNTER

Counter of the depth frame upon which the stream was calculated

enumerator RS2_FRAME_METADATA_SAFETY_LEVEL1

Designates the Yellow zone status: 0x1 - High, 0x0 - Low

enumerator RS2_FRAME_METADATA_SAFETY_LEVEL1_ORIGIN

When l1 is low - equals to frame_counter in safety_header - For l1=0x1 : hold the Frame id on last transition to “High” state

enumerator RS2_FRAME_METADATA_SAFETY_LEVEL2

Designates the “Red” zone status: 0x1 - High, 0x0 - Low

enumerator RS2_FRAME_METADATA_SAFETY_LEVEL2_ORIGIN

When l2 is low - equals to frame_counter in safety_header - For l2=0x1 : hold the Frame id on last transition to “High” state

enumerator RS2_FRAME_METADATA_SAFETY_LEVEL1_VERDICT

Current verdict for l1 Safety Signal - May differ from l1_signal due to additional logics applied

enumerator RS2_FRAME_METADATA_SAFETY_LEVEL2_VERDICT

Current verdict for l2 Safety Signal - May differ from l2_signal due to additional logics applied

enumerator RS2_FRAME_METADATA_SAFETY_OPERATIONAL_MODE

Reflects the SC operational mode (XU control)

enumerator RS2_FRAME_METADATA_SAFETY_VISION_VERDICT

Bitmask, enumerated

enumerator RS2_FRAME_METADATA_SAFETY_HARA_EVENTS

Bitmask, enumerated

enumerator RS2_FRAME_METADATA_SAFETY_PRESET_INTEGRITY

Bitmask, enumerated

enumerator RS2_FRAME_METADATA_SAFETY_PRESET_ID_SELECTED

Safety Preset index set via Adaptive Field selection GPIO

enumerator RS2_FRAME_METADATA_SAFETY_PRESET_ID_USED

Safety Preset index used in the latest Vision Safety algo processing

enumerator RS2_FRAME_METADATA_SAFETY_SIP_DEGRADATION_USED

Bitmask, enumerated

enumerator RS2_FRAME_METADATA_SAFETY_SIP_GENERIC_METRICS_ACTIVATE

Bitmask, enumerated

enumerator RS2_FRAME_METADATA_SAFETY_SIP_GENERIC_METRICS_STATE

Bitmask, enumerated

enumerator RS2_FRAME_METADATA_SAFETY_SIP_GENERIC_METRICS_VALUE1

First value from byte array of up to 8 Generic Safety Algo continuous metrics indications

enumerator RS2_FRAME_METADATA_SAFETY_SIP_GENERIC_METRICS_VALUE2

Second value from byte array of up to 8 Generic Safety Algo continuous metrics indications

enumerator RS2_FRAME_METADATA_SAFETY_SIP_GENERIC_METRICS_THRESHOLD1

First value from byte array of up to 8 Generic Safety Algo continuous metrics thresholds

enumerator RS2_FRAME_METADATA_SAFETY_SIP_GENERIC_METRICS_THRESHOLD2

Second value from byte array of up to 8 Generic Safety Algo continuous metrics thresholds

enumerator RS2_FRAME_METADATA_SAFETY_ZERO_MONITORING_ENABLED

Enum - 0:Regular (default) all safety in nominal mode - 1: “Zero Safety” mode

enumerator RS2_FRAME_METADATA_SAFETY_HARA_HISTORY_MODE

Enum - 0:Regular - 1: No history - 2: Local history

enumerator RS2_FRAME_METADATA_SAFETY_SOC_FUSA_EVENTS

Bitmask, enumerated - SOC critical notification: L2/L3 that requires handling/troubleshooting in S.MCU 32-bit value, as supplied by STL mechanism

enumerator RS2_FRAME_METADATA_SAFETY_SOC_FUSA_ACTION

Bitmask, enumerated - Action taken. 0x1 << 0 - HKR Reset, 0x1 << 1 - HKR ShutDown

enumerator RS2_FRAME_METADATA_SAFETY_SOC_L0_COUNTER

Total number of L0 notifications captured

enumerator RS2_FRAME_METADATA_SAFETY_SOC_L0_RATE

L_0 notifications per FDTI

enumerator RS2_FRAME_METADATA_SAFETY_SOC_L1_COUNTER

Total number of L1 notifications captured

enumerator RS2_FRAME_METADATA_SAFETY_SOC_L1_RATE

L_1 notifications per FDTI

enumerator RS2_FRAME_METADATA_SAFETY_SOC_GMT_STATUS

Result, enumerated: 0 - GMT Clock Ok, 1- GMT Clock is outside Safe threshold, 2 - GMT Clock is not available

enumerator RS2_FRAME_METADATA_SAFETY_SOC_HKR_CRITICAL_ERROR_GPIO

Critical-erro GPIO Status: 0 - off, 1 - on

enumerator RS2_FRAME_METADATA_SAFETY_SOC_MONITOR_L2_ERROR_TYPE

Soc Monitor Escalation of L2 error to Arbiter

enumerator RS2_FRAME_METADATA_SAFETY_SOC_MONITOR_L3_ERROR_TYPE

Soc Monitor Escalation of L3 error to Arbiter

enumerator RS2_FRAME_METADATA_SAFETY_SOC_SAFETY_AND_SECURITY

Bitmask, enumerated

enumerator RS2_FRAME_METADATA_SAFETY_DEPTH_FRAME_TIMESTAMP

enumerator RS2_FRAME_METADATA_SAFETY_SMCU_PROCESSING_TIMESTAMP

enumerator RS2_FRAME_METADATA_SAFETY_PIPELINE_PROPAGATION_DELAY

enumerator RS2_FRAME_METADATA_SAFETY_SMCU_DEBUG_STATUS_BITMASK

Bitmask: The values are state-specific and non-FuSa related. Shall be presented as HEX string

enumerator RS2_FRAME_METADATA_SAFETY_SMCU_DEBUG_INFO_INTERNAL_STATE

Enumerated: according to S.MCU FSM

enumerator RS2_FRAME_METADATA_SAFETY_SMCU_DEBUG_INFO_BIST_STATUS

Bitmask. To be presented as HEX value

enumerator RS2_FRAME_METADATA_SAFETY_NON_FUSA_GPIO_OUT

Bitmask, enumerated

enumerator RS2_FRAME_METADATA_SAFETY_SMCU_HW_MONITOR_STATUS

Bitmask, enumerated

enumerator RS2_FRAME_METADATA_SAFETY_SMCU_SW_MONITOR_STATUS

Bitmask, enumerated

enumerator RS2_FRAME_METADATA_SAFETY_NON_FUSA_GPIO_IN

Bitmask, enumerated

enumerator RS2_FRAME_METADATA_SAFETY_MB_FUSA_EVENT

Bitmask, enumerated

enumerator RS2_FRAME_METADATA_SAFETY_MB_FUSA_ACTION

Bitmask, enumerated

enumerator RS2_FRAME_METADATA_SAFETY_MB_STATUS

Bitmask, enumerated

enumerator RS2_FRAME_METADATA_SAFETY_SMCU_LIVELINESS

Bitmask, enumerated

enumerator RS2_FRAME_METADATA_SAFETY_SMCU_STATE

Bitmask, enumerated

enumerator RS2_FRAME_METADATA_SAFETY_PRESET_ID

Designates the Safety Zone index in [0..63] range used in algo pipe

enumerator RS2_FRAME_METADATA_SENSOR_ANGLE_ROLL

In millidegrees. Relative to X (forward) axis. Positive value is CCW

enumerator RS2_FRAME_METADATA_SENSOR_ANGLE_PITCH

In millidegrees. Relative to Y (left) axis. Positive value is CCW

enumerator RS2_FRAME_METADATA_DIAGNOSTIC_ZONE_MEDIAN_HEIGHT

In millimeters. Relative to the “leveled pointcloud” CS

enumerator RS2_FRAME_METADATA_FLOOR_DETECTION

Percentage

enumerator RS2_FRAME_METADATA_DIAGNOSTIC_ZONE_FILL_RATE

Percentage

enumerator RS2_FRAME_METADATA_DEPTH_FILL_RATE

Unsigned value in range of [0..100]. Use [x = 0xFF] if not applicable

enumerator RS2_FRAME_METADATA_DEPTH_STDEV

Spatial accuracy in millimetric units

enumerator RS2_FRAME_METADATA_OCCUPANCY_GRID_ROWS

Number of rows in the grid. Max value is 250 (corresponding to 5M width with 2cm tile)

enumerator RS2_FRAME_METADATA_OCCUPANCY_GRID_COLUMNS

Number of columns in the grid. Max value is 320 (corresponding to ~6.5M depth with 2cm tile)

enumerator RS2_FRAME_METADATA_OCCUPANCY_CELL_SIZE

Edge size of each tile, measured in cm

enumerator RS2_FRAME_METADATA_NUMBER_OF_3D_VERTICES

The max number of points is 640x360

enumerator RS2_FRAME_METADATA_SAFETY_PRESET_ERROR_TYPE

Bitmask, enumerated

enumerator RS2_FRAME_METADATA_SAFETY_PRESET_ERROR_PARAM_1

Preset Error Param. Enumerated

enumerator RS2_FRAME_METADATA_SAFETY_PRESET_ERROR_PARAM_2

Preset Error Param. Enumerated

enumerator RS2_FRAME_METADATA_DANGER_ZONE_POINT_0_X_CORD

Danger Zone point #0, X coord in mm

enumerator RS2_FRAME_METADATA_DANGER_ZONE_POINT_0_Y_CORD

Danger Zone point #0, Y coord in mm

enumerator RS2_FRAME_METADATA_DANGER_ZONE_POINT_1_X_CORD

Danger Zone point #1, X coord in mm

enumerator RS2_FRAME_METADATA_DANGER_ZONE_POINT_1_Y_CORD

Danger Zone point #1, Y coord in mm

enumerator RS2_FRAME_METADATA_DANGER_ZONE_POINT_2_X_CORD

Danger Zone point #2, X coord in mm

enumerator RS2_FRAME_METADATA_DANGER_ZONE_POINT_2_Y_CORD

Danger Zone point #2, Y coord in mm

enumerator RS2_FRAME_METADATA_DANGER_ZONE_POINT_3_X_CORD

Danger Zone point #3, X coord in mm

enumerator RS2_FRAME_METADATA_DANGER_ZONE_POINT_3_Y_CORD

Danger Zone point #3, Y coord in mm

enumerator RS2_FRAME_METADATA_WARNING_ZONE_POINT_0_X_CORD

Warning Zone point #0, X coord in mm

enumerator RS2_FRAME_METADATA_WARNING_ZONE_POINT_0_Y_CORD

Warning Zone point #0, Y coord in mm

enumerator RS2_FRAME_METADATA_WARNING_ZONE_POINT_1_X_CORD

Warning Zone point #1, X coord in mm

enumerator RS2_FRAME_METADATA_WARNING_ZONE_POINT_1_Y_CORD

Warning Zone point #1, Y coord in mm

enumerator RS2_FRAME_METADATA_WARNING_ZONE_POINT_2_X_CORD

Warning Zone point #2, X coord in mm

enumerator RS2_FRAME_METADATA_WARNING_ZONE_POINT_2_Y_CORD

Warning Zone point #2, Y coord in mm

enumerator RS2_FRAME_METADATA_WARNING_ZONE_POINT_3_X_CORD

Warning Zone point #3, X coord in mm

enumerator RS2_FRAME_METADATA_WARNING_ZONE_POINT_3_Y_CORD

Warning Zone point #3, Y coord in mm

enumerator RS2_FRAME_METADATA_DIAGNOSTIC_ZONE_POINT_0_X_CORD

Diagnostic Zone point #0, X coord in mm

enumerator RS2_FRAME_METADATA_DIAGNOSTIC_ZONE_POINT_0_Y_CORD

Diagnostic Zone point #0, Y coord in mm

enumerator RS2_FRAME_METADATA_DIAGNOSTIC_ZONE_POINT_1_X_CORD

Diagnostic Zone point #1, X coord in mm

enumerator RS2_FRAME_METADATA_DIAGNOSTIC_ZONE_POINT_1_Y_CORD

Diagnostic Zone point #1, Y coord in mm

enumerator RS2_FRAME_METADATA_DIAGNOSTIC_ZONE_POINT_2_X_CORD

Diagnostic Zone point #2, X coord in mm

enumerator RS2_FRAME_METADATA_DIAGNOSTIC_ZONE_POINT_2_Y_CORD

Diagnostic Zone point #2, Y coord in mm

enumerator RS2_FRAME_METADATA_DIAGNOSTIC_ZONE_POINT_3_X_CORD

Diagnostic Zone point #3, X coord in mm

enumerator RS2_FRAME_METADATA_DIAGNOSTIC_ZONE_POINT_3_Y_CORD

Diagnostic Zone point #3, Y coord in mm

enumerator RS2_FRAME_METADATA_EMBEDDED_FILTERS

Bitmask, enumerated

enumerator RS2_FRAME_METADATA_COUNT