Kinect For Azure Python API
Classes | Functions
k4atypes.py File Reference

Defines common enums and structures used in the Azure Kinect SDK. More...

Classes

class  CalibrationCamera
 Camera calibration contains intrinsic and extrinsic calibration information for a camera. More...
 
class  CalibrationExtrinsics
 Extrinsic calibration data. More...
 
class  CalibrationIntrinsicParam
 Camera intrinsic calibration data. More...
 
class  CalibrationIntrinsics
 Camera sensor intrinsic calibration data. More...
 
class  DeviceConfiguration
 Configuration parameters for an Azure Kinect device. More...
 
class  EBufferStatus
 Result code returned by Azure Kinect APIs. More...
 
class  ECalibrationModelType
 Calibration model type. More...
 
class  ECalibrationType
 Calibration types. More...
 
class  EColorControlCommand
 Color sensor control commands. More...
 
class  EColorControlMode
 Color sensor control mode. More...
 
class  EColorResolution
 Color sensor resolutions, width * height and aspect ratio. More...
 
class  EDepthMode
 Depth sensor capture modes. More...
 
class  EFirmwareBuild
 Firmware build type. More...
 
class  EFirmwareSignature
 Firmware signature type. More...
 
class  EFramesPerSecond
 Color and depth sensor frame rate. More...
 
class  EImageFormat
 Image format type. More...
 
class  ELogLevel
 Verbosity levels of debug messaging. More...
 
class  EStatus
 Result code returned by Azure Kinect APIs. More...
 
class  ETransformInterpolationType
 Transformation interpolation type. More...
 
class  EWaitStatus
 Result code returned by Azure Kinect APIs. More...
 
class  EWiredSyncMode
 Synchronization mode when connecting two or more devices together. More...
 
class  HardwareVersion
 Structure to define hardware version. More...
 
class  ImuSample
 IMU Sample. More...
 
class  Version
 Version information. More...
 

Functions

def K4A_FAILED (result)
 Validate that an EStatus is failed. More...
 

Detailed Description

Defines common enums and structures used in the Azure Kinect SDK.

These enums defined here are analogous to those defined in k4a.h.

Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT License. Kinect For Azure SDK.

Function Documentation

◆ K4A_FAILED()

def k4a._bindings.k4atypes.K4A_FAILED (   result)

Validate that an EStatus is failed.

Parameters
result(EStatus): An EStatus returned by some functions in the K4A API.
Returns
True if result is a failed status, False otherwise.