Detailed Description

Configuration parameters for an Azure Kinect device.

Remarks

Used by Device.start_cameras() to specify the configuration of the data capture.

Field Name	Type	Description
color_format	EImageFormat	Image format to capture with the color camera. The color camera does not natively produce BGRA32 images. Setting to EImageFormat.BGRA32 for color_format will result in higher CPU utilization.
color_resolution	EColorResolution	Image resolution to capture with the color camera.
depth_mode	EDepthMode	Capture mode for the depth camera.
camera_fps	EFramesPerSecond	Desired frame rate for the color and depth camera.
synchronized_images_only	bool	Only produce k4a_capture_t objects if they contain synchronized color and depth images. This setting controls the behavior in which images are dropped when images are produced faster than they can be read, or if there are errors in reading images from the device. If set to True, Capture objects will only be produced with both color and depth images. If set to False, Capture objects may be produced with only a single image when the corresponding image is dropped. Setting this to False ensures that the caller receives all of the images received from the camera, regardless of whether the corresponding images expected in the capture are available. If either the color or depth camera are disabled, this setting has no effect.
depth_delay_off_color_usec	int	Desired delay in microseconds between the capture of the color image and the capture of the depth image. A negative value indicates that the depth image should be captured before the color image. Any value between negative and positive one capture period is valid.
wired_sync_mode	EWiredSyncMode	The external synchronization mode.
subordinate_delay_off_master_usec	int	The external synchronization timing. If this camera is a subordinate, this sets the capture delay between the color camera capture and the external input pulse. A setting of zero indicates that the master and subordinate color images should be aligned. This setting does not effect the 'Sync out' connection. This value must be positive and range from zero to one capture period. If this is not a subordinate, then this value is ignored.
disable_streaming_indicator	bool	Streaming indicator automatically turns on when the color or depth cameras are in use. This setting disables that behavior and keeps the LED in an off state.

The documentation for this class was generated from the following file:

src/k4a/_bindings/k4atypes.py