Virtual Acoustics (VA) C++ API  v2018a
Virtual Acoustics is a real-time auralization framework devoted to Virtual Reality.
Functions
VACore Namespace Reference

Functions

VACORE_API IVAInterfaceCreateCoreInstance (const CVAStruct &oArgs, std::ostream *pOutputStream=nullptr)
 Factory method - creates a VACore instance. More...
 
VACORE_API CVAStruct LoadCoreConfigFromFile (const std::string &sConfigFilePath)
 Parses input INI configuration file and converts it into a VA core config struct. More...
 
VACORE_API void StoreCoreConfigToFile (const CVAStruct &oCoreConfig, const std::string &sConfigFilePath)
 Store configuration to INI file from VA core config struct. More...
 
IVAInterfaceCreateCoreInstance (const std::string &sConfigFile=VACORE_DEFAULT_CONFIGFILE, std::ostream *pOutputStream=nullptr)
 Factore method - create a VACore instance with configuration file. More...
 
VACORE_API std::string GetCoreLibFilePath ()
 Returns the filesystem path of the VACore shared lib (e.g. VACore.dll) More...
 

Function Documentation

VACORE_API IVAInterface* VACore::CreateCoreInstance ( const CVAStruct oArgs,
std::ostream *  pOutputStream = nullptr 
)

Factory method - creates a VACore instance.

Parameters
[in]oArgsArguments with configuration for the core
Returns
Pointer to the core instance (VA interface API from VABase)
IVAInterface* VACore::CreateCoreInstance ( const std::string &  sConfigFile = VACORE_DEFAULT_CONFIGFILE,
std::ostream *  pOutputStream = nullptr 
)
inline

Factore method - create a VACore instance with configuration file.

Parameters
[in]sConfigFileConfiguration file, or default file
Returns
Pointer to the core instance (VA interface API from VABase)
See also
GetCoreConfigFromFile()

Definition at line 60 of file VACoreFactory.h.

VACORE_API std::string VACore::GetCoreLibFilePath ( )

Returns the filesystem path of the VACore shared lib (e.g. VACore.dll)

Returns
Core library path
VACORE_API CVAStruct VACore::LoadCoreConfigFromFile ( const std::string &  sConfigFilePath)

Parses input INI configuration file and converts it into a VA core config struct.

Parameters
[in]sConfigFilePathFile path to core config (INI) file
Returns
Core configuration
VACORE_API void VACore::StoreCoreConfigToFile ( const CVAStruct oCoreConfig,
const std::string &  sConfigFilePath 
)

Store configuration to INI file from VA core config struct.

Parameters
[in]oCoreConfigCore configuration struct
[in]sConfigFilePathFile path to core config (INI) file
Virtual Acoustics (VA) | http://www.virtualacoustics.org
Source code licensed under the Apache License, Version 2.0
C++ API documentation auto generated and licensed under Creative Commons Attribution License 4.0
© 2017-2018 Institute of Technical Acoustics (ITA)
RWTH Aachen University, Germany.