IngestApplication
IngestApplication
Public Classes
Name | |
---|---|
struct | Settings |
Public Functions
Name | |
---|---|
IngestApplication() Constructor, creates an empty IngestApplication without starting it. | |
~IngestApplication() Destructor. | |
bool | start(const std::shared_ptr< ISystemControllerInterface > & controllerInterface, const Settings & settings) Start this IngestApplication given an interface to the System Controller and an UUID. |
bool | stop() Stop this IngestApplication. |
std::string | getVersion() Get application version. |
std::string | getGitRevision() Get git revision which application was built on. |
std::string | getBuildInfo() Get application build information. |
std::string | getLibraryVersions() Get the versions of the libraries available at runtime, among others, CUDA version, BMD and NDI versions. |
Public Functions Documentation
function IngestApplication
IngestApplication()
Constructor, creates an empty IngestApplication without starting it.
function ~IngestApplication
~IngestApplication()
Destructor.
function start
bool start(
const std::shared_ptr< ISystemControllerInterface > & controllerInterface,
const Settings & settings
)
Start this IngestApplication given an interface to the System Controller and an UUID.
Parameters:
- controllerInterface The interface for communication with the System Controller
- settings The settings for the IngestApplication
Return: True if the IngestApplication was successfully started, false otherwise
function stop
bool stop()
Stop this IngestApplication.
Return: True if the IngestApplication was successfully stopped, false otherwise
function getVersion
static std::string getVersion()
Get application version.
Return: a string with the current version, e.g. “1.0.0”
function getGitRevision
static std::string getGitRevision()
Get git revision which application was built on.
Return: a string with the current git revision, e.g. “v1.0.0”, or “v2.1.0-231-gcd012ab”
function getBuildInfo
static std::string getBuildInfo()
Get application build information.
Return: a string with the current build information such as git hashes of all direct dependencies
function getLibraryVersions
static std::string getLibraryVersions()
Get the versions of the libraries available at runtime, among others, CUDA version, BMD and NDI versions.
Return: a string with the currently found versions of the libraries used by this application
Updated on 2023-06-13 at 17:00:17 +0200