kinect/codes/Azure-Kinect-Sensor-SDK/README.md

4.0 KiB

Azure Kinect SDK (K4A)

Welcome to the Azure Kinect Sensor SDK! We hope you can use it to build many great applications and participate in the project. Don't be shy to ask questions, and provide feedback. See Azure.com/Kinect for device info and available documentation.

Build Status(develop) Nuget

Introduction

Azure Kinect SDK is a cross platform (Linux and Windows) user mode SDK to read data from your Azure Kinect device.

Why use the Azure Kinect SDK

The Azure Kinect SDK enables you to get the most out of your Azure Kinect camera. Features include:

  • Depth camera access
  • RGB camera access and control (e.g. exposure and white balance)
  • Motion sensor (gyroscope and accelerometer) access
  • Synchronized Depth-RGB camera streaming with configurable delay between cameras
  • External device synchronization control with configurable delay offset between devices
  • Camera frame meta-data access for image resolution, timestamp and temperature
  • Device calibration data access

Installation

To use the SDK, please refer to the installation instructions in usage

Documentation

API documentation is avaliable here.

Building

Azure Kinect SDK uses CMake to build. For instructions on how to build this SDK please see building.

Versioning

The Azure Kinect SDK uses semantic versioning, please see versioning.md for more information.

Testing

For information on writing or running tests, please see testing.md

Contribute

We welcome your contributions! Please see the contribution guidelines.

Feedback

For SDK feedback or to report a bug, please file a GitHub Issue. For general suggestions or ideas, visit our feedback forum.

Sample Code

There are several places where the sample code can be found.

Q&A

Welcome to the Q&A corner!

Join Our Developer Program

Complete your developer profile here to get connected with our Mixed Reality Developer Program. You will receive the latest on our developer tools, events, and early access offers.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Reporting Security Issues

Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) at <secure@microsoft.com>. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the MSRC PGP key, can be found in the Security TechCenter.

License and Microsoft Support for Azure Kinect Sensor SDK

MIT License

Microsoft Support for Azure Kinect Sensor SDK