voyant_version.hpp File Reference

#include <string>
#include <voyant_types_ffi.hpp>

Go to the source code of this file.

Functions
std::string	voyantApiVersion ()
std::string	voyantInterfaceContractVersion ()

Function Documentation

voyantApiVersion()

std::string voyantApiVersion ( )

inline

Version of the linked voyant-api library, e.g. "1.0.0" or "1.0.0-dev". Unrelated to VoyantPlayback::apiVersion(), which reports the version that wrote an open recording.

voyantInterfaceContractVersion()

std::string voyantInterfaceContractVersion ( )

inline

Version of the FPGA interface contract this library was built against, e.g. "1.5.6". The contract pins the sensor wire protocol, so it is the version to report alongside a sensor's firmware versions (VoyantFrame::sensorState()->device).