k4a_color_control_command_t

enum k4a_color_control_command_t

Color sensor control commands.

Remarks

The current settings can be read with k4a_device_get_color_control(). The settings can be set with k4a_device_set_color_control().

Control values set on a device are reset only when the device is power cycled. The device will retain the settings even if the k4a_device_t is closed or the application is restarted.

See also

k4a_color_control_mode_t

Enumerator
K4A_COLOR_CONTROL_EXPOSURE_TIME_ABSOLUTE	Exposure time setting. May be set to K4A_COLOR_CONTROL_MODE_AUTO or K4A_COLOR_CONTROL_MODE_MANUAL. The Azure Kinect supports a limited number of fixed expsore settings. When setting this, expect the exposure to be rounded up to the nearest setting. Exceptions are 1) The last value in the table is the upper limit, so a value larger than this will be overridden to the largest entry in the table. 2) The exposure time cannot be larger than the equivelent FPS. So expect 100ms exposure time to be reduced to 30ms or 33.33ms when the camera is started. The most recent copy of the table 'device_exposure_mapping' is in https://github.com/microsoft/Azure-Kinect-Sensor-SDK/blob/develop/src/color/color_priv.h Exposure time is measured in microseconds.
K4A_COLOR_CONTROL_AUTO_EXPOSURE_PRIORITY	Exposure or Framerate priority setting. May only be set to K4A_COLOR_CONTROL_MODE_MANUAL. Value of 0 means framerate priority. Value of 1 means exposure priority. Using exposure priority may impact the framerate of both the color and depth cameras. Deprecated starting in 1.2.0. Please discontinue usage, firmware does not support this.
K4A_COLOR_CONTROL_BRIGHTNESS	Brightness setting. May only be set to K4A_COLOR_CONTROL_MODE_MANUAL. The valid range is 0 to 255. The default value is 128.
K4A_COLOR_CONTROL_CONTRAST	Contrast setting. May only be set to K4A_COLOR_CONTROL_MODE_MANUAL.
K4A_COLOR_CONTROL_SATURATION	Saturation setting. May only be set to K4A_COLOR_CONTROL_MODE_MANUAL.
K4A_COLOR_CONTROL_SHARPNESS	Sharpness setting. May only be set to K4A_COLOR_CONTROL_MODE_MANUAL.
K4A_COLOR_CONTROL_WHITEBALANCE	White balance setting. May be set to K4A_COLOR_CONTROL_MODE_AUTO or K4A_COLOR_CONTROL_MODE_MANUAL. The unit is degrees Kelvin. The setting must be set to a value evenly divisible by 10 degrees.
K4A_COLOR_CONTROL_BACKLIGHT_COMPENSATION	Backlight compensation setting. May only be set to K4A_COLOR_CONTROL_MODE_MANUAL. Value of 0 means backlight compensation is disabled. Value of 1 means backlight compensation is enabled.
K4A_COLOR_CONTROL_GAIN	Gain setting. May only be set to K4A_COLOR_CONTROL_MODE_MANUAL.
K4A_COLOR_CONTROL_POWERLINE_FREQUENCY	Powerline frequency setting. May only be set to K4A_COLOR_CONTROL_MODE_MANUAL. Value of 1 sets the powerline compensation to 50 Hz. Value of 2 sets the powerline compensation to 60 Hz.