AJA ColorBox API/Demos

The ColorBox from AJA supports a rich RESTful API using OpenAPI.

C++, Go and Python OpenAPI implementations are included in this package. Some simple demo projects are included to demonstrate the functionality available via this RESTful API.

This document gives a brief overview of the API and directory hierarchy, for more details please visit the README.md file in each of the top level directories.

OpenAPI

The ColorBox RESTful API is generated using the OpenAPI specification. The main demos are built on Qt with C++ but there are also C++(without Qt), Python and Go demos as well.

The OpenAPI interface to ColorBox is self-documenting and that can be found at:

ipaddressOfColorBox/api (for example http://192.168.1.140/api)

This allows you not only to see the data structures for the API but also try it out.

Directory Hierarchy

• Qt C++ demos
  • cpp-qt/
    • api/ - the generated OpenAPI for use with Qt C++
    • bin/ - where the built demos are placed
    • cmake/ - files used by cmake
    • common/ - common code used by Qt C++ demos
    • docs/ - docs/images for the readme
    • DynamicFrameLoad/ - GUI demo
    • DynamicLutLoad/ - GUI demo
    • DynamicMatrixLoad/ - GUI demo
    • FrameGrab/ - GUI demo
    • Librarian/ - GUI demo
    • PreviewDemo/ - GUI demo
    • RGBTriplet/ - GUI demo
    • CMakeLists.txt - defines cmake build
    • demos.pro - defines qmake build
    • README.md - more details about these demos
• cpprestsdk demos
  • cpp-restsdk/
    • api/ - the generated OpenAPI for use with cpprestsdk (C++)
    • bin/ - where the built demos are placed
    • cmake/ - files used by cmake
    • dynamic_frame_load/ - command line demo
    • dynamic_lut_load/ - command line demo
    • get_temp/ - command line demo
    • lib_load/ - command line demo
    • rgb_triplet/ - command line demo
    • set_overlay_text/ - command line demo
    • CMakeLists.txt - defines cmake build
    • README.md - more details about these demos
• Go demos
  • go/
    • api/ - the generated OpenAPI for use with Go
    • get_temp/ - command line demo
    • lib_load/ - command line demo
    • set_overlay_text/ - command line demo
    • README.md - more details about these demos
• Python demos
  • python/
    • api/ - the generated OpenAPI for use with Python
    • get_temp/ - command line demo
    • lib_load/ - command line demo
    • set_overlay_text/ - command line demo
    • README.md - more details about these demos

Updates

03/31/2022 - Added Calibration related API updated ColorFront API with Live Mode and TV Mode controls. The Calibration API is demonstrated in the C++ Qt DynamicFrameLoad project.