This is the open source repo of the Orbbec SDK. The Orbbec SDK is a cross-platform library for interfacing with the Orbbec RGB-D cameras. It provides C/C++ APIs and many other languages or frameworks wrappers.

The Orbbec SDK is open source since the version 2.0.0, the pre-compiled binaries of current and previous versions still can be found in this repo: https://github.com/orbbec/OrbbecSDK. It's is recommended to use the pre-compiled binaries repo if you already have an project relying on the previous version of the Orbbec SDK.

Compared to v1.x.x, the v2.x.x version has many optimizations and refactoring. And we also have removed or modified some interfaces that were either rarely used or had flawed designs, these changes will not affect the normal usage of the SDK. The different between v1.x.x and v2.x.x of interfaces can be found in the API changes at v2.x.x.

• Windows 10 or later: x86 and x64 architectures
• Linux x64: tested on Ubuntu 18.04 and 20.04
• Linux ARM64: tested on NVIDIA Jetson Nano, TX2, and Xavier NX
• Android: coming soon
• macOS: coming soon
• Linux ARM32: coming soon

More devices support will be added in the near future. If you can not find your device in the table above currently, try the previous version: Orbbec SDK

For a comprehensive guide on installing the SDK, setting up your development environment, and developing applications, please consult the Tutorial section for detailed information.

For practical examples on utilizing the SDK, refer to the Examples section for more insights.

To learn how to effectively use the Orbbec Viewer, please refer to the Orbbec Viewer User Guide. (TODO: Replace the placeholder with the actual link when available.)

API Reference: Orbbec_SDK_API_Reference.html

OrbbecSDK C++ API user guide：Orbbec_SDK_C++_API_user_guide-v1.0.pdf

For building the SDK from source, please refer to the build guide for more information.

For the developers who want to contribute to the SDK, please refer to the developer guide for more information.

Most frequently asked questions can be found in the FAQ file.

More asked and answered questions can be found in the issues channel. Use key words for searching may help you find the answer you are looking for.

Code snippet of the QuickStart example:

// Create a pipeline.
ob::Pipeline pipe;

// Start the pipeline with default config.
pipe.start();

// Create a window for showing the frames, and set the size of the window.
ob_smpl::CVWindow win("QuickStart", 1280, 720, ob_smpl::ARRANGE_ONE_ROW);

while(win.run()) {
    // Wait for frameSet from the pipeline, the default timeout is 1000ms.
    auto frameSet = pipe.waitForFrameset();

    // Push the frames to the window for showing.
    win.pushFramesToView(frameSet);
}

// Stop the Pipeline, no frame data will be generated
pipe.stop();

Currently, we are not accepting external contributions to expand the functionality of the SDK. But we will be happy to review any pull requests or suggestions you may have. Please contact us at issues channel if you have any questions or concerns.

This project is licensed under the MIT License with some other licenses for third-party libraries and extensions - see the LICENSE file for details.

• Orbbec SDK Open Source Version Repo
• Orbbec SDK Close Source Version Repo
• Orbbec Main Page
• Orbbec 3D Club