IngestApplication

Public Classes

	Name
struct	Settings

	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.

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.

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

bool stop()

Return: True if the IngestApplication was successfully stopped, false otherwise

static std::string getVersion()

Get application version.

Return: a string with the current version, e.g. “1.0.0”

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”

static std::string getBuildInfo()

Get application build information.

Return: a string with the current build information such as git hashes of all direct dependencies

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