Enum rs2_frame_metadata_value

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

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.

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_COUNT