Virtual Acoustics (VA) C++ API  v2018a
Virtual Acoustics is a real-time auralization framework devoted to Virtual Reality.
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
IVAInterface Class Referenceabstract

Interface of Virtual Acoustics (VA) More...

#include <VAInterface.h>

Inheritance diagram for IVAInterface:
CVANetClientImpl::CNetworkedVACore

Public Types

enum  CoreState { VA_CORESTATE_CREATED = 0, VA_CORESTATE_READY = 1, VA_CORESTATE_FAIL = -1 }
 Core states. More...
 
enum  ErrorLevel {
  VA_LOG_LEVEL_QUIET = 0, VA_LOG_LEVEL_ERROR = 1, VA_LOG_LEVEL_WARNING = 2, VA_LOG_LEVEL_INFO = 3,
  VA_LOG_LEVEL_VERBOSE = 4, VA_LOG_LEVEL_TRACE = 5
}
 Core error levels. More...
 
enum  PlaybackState { VA_PLAYBACK_STATE_INVALID = -1, VA_PLAYBACK_STATE_STOPPED = 0, VA_PLAYBACK_STATE_PAUSED = 1, VA_PLAYBACK_STATE_PLAYING = 2 }
 Playback states of audiofile signal sources. More...
 
enum  PlaybackAction { VA_PLAYBACK_ACTION_NONE = -1, VA_PLAYBACK_ACTION_STOP = 0, VA_PLAYBACK_ACTION_PAUSE = 1, VA_PLAYBACK_ACTION_PLAY = 2 }
 Playback actions (transitions) of audiofile signal sources. More...
 

Public Member Functions

virtual ~IVAInterface ()
 Destructor. More...
 
virtual void GetVersionInfo (CVAVersionInfo *pVersionInfo) const =0
 Returns the core version. More...
 
virtual void SetOutputStream (std::ostream *posDebug)=0
 Set the output stream for debug messages. More...
 
virtual int GetState () const =0
 Returns the state of the core. More...
 
virtual void Initialize ()=0
 Initializes the core. More...
 
virtual void Finalize ()=0
 Finalizes the core and frees allocated resources. More...
 
virtual void Reset ()=0
 Full reset of the core. Clears all scene objects, resources, etc. More...
 
virtual void AttachEventHandler (IVAEventHandler *pEventHandler)=0
 Attaches a handler for core events to the core instance. More...
 
virtual void DetachEventHandler (IVAEventHandler *pEventHandler)=0
 Detaches a handler for core events from the core instance. More...
 
virtual void GetModules (std::vector< CVAModuleInfo > &voModuleInfos) const =0
 Get all registered modules of the core. More...
 
virtual CVAStruct CallModule (const std::string &sModuleName, const CVAStruct &oArgs)=0
 Calls a module and returns the answer. More...
 
virtual bool AddSearchPath (const std::string &sPath)
 Adds a search path to the core instance. More...
 
virtual CVAStruct GetSearchPaths () const =0
 Returns a struct with entries for each search paths. More...
 
virtual CVAStruct GetFileList (const bool bRecursive=true, const std::string &sFileSuffixFilter="*") const =0
 Returns files that are accessible through search paths. More...
 
virtual CVAStruct GetCoreConfiguration (const bool bFilterEnabled=true) const =0
 Returns a struct with the core configuration. More...
 
virtual CVAStruct GetHardwareConfiguration () const =0
 Returns a struct with the hardware configuration. More...
 
virtual int CreateDirectivityFromParameters (const CVAStruct &oParams, const std::string &sName="")=0
 Create a directivity from a set of parameters. More...
 
int CreateDirectivityFromFile (const std::string &sFilePath, const std::string &sName="")
 Create a directivity from a file path. More...
 
virtual bool DeleteDirectivity (const int iID)=0
 Delete a directivity. More...
 
virtual CVADirectivityInfo GetDirectivityInfo (const int iID) const =0
 Directivity info getter. More...
 
virtual void GetDirectivityInfos (std::vector< CVADirectivityInfo > &voDest) const =0
 Directivity info getter. More...
 
virtual void SetDirectivityName (const int iID, const std::string &sName)=0
 Directivity name setter. More...
 
virtual std::string GetDirectivityName (const int iID) const =0
 Directivity name getter. More...
 
virtual void SetDirectivityParameters (const int iID, const CVAStruct &oParams)=0
 Directivity parameter setter. More...
 
virtual CVAStruct GetDirectivityParameters (const int iID, const CVAStruct &oParams) const =0
 Directivity parameter getter. More...
 
virtual int CreateAcousticMaterial (const CVAAcousticMaterial &oMaterial, const std::string &sName="")=0
 Create acoustic material by passing material data. More...
 
virtual int CreateAcousticMaterialFromParameters (const CVAStruct &oParams, const std::string &sName="")=0
 Create acoustic material based on magic parameter set (for prototyping) More...
 
int CreateAcousticMaterialFromFile (const std::string &sFilePath, const std::string &sName="")
 Create acoustic material from file path (e.g. 'mat' file) More...
 
virtual bool DeleteAcousticMaterial (const int iID)=0
 Create acoustic material based on magic parameter set (for prototyping) More...
 
virtual CVAAcousticMaterial GetAcousticMaterialInfo (const int iID) const =0
 Acoustic material info getter. More...
 
virtual void GetAcousticMaterialInfos (std::vector< CVAAcousticMaterial > &voDest) const =0
 Acoustic material info getter for entire database. More...
 
virtual std::string GetAcousticMaterialName (const int iID) const =0
 Acoustic material name getter. More...
 
virtual void SetAcousticMaterialName (const int iID, const std::string &sName)=0
 Acoustic material name setter. More...
 
virtual CVAStruct GetAcousticMaterialParameters (const int iID, const CVAStruct &oParams) const =0
 Acoustic material name getter. More...
 
virtual void SetAcousticMaterialParameters (const int iID, const CVAStruct &oParams)=0
 Acoustic material parameter setter. More...
 
virtual int CreateGeometryMesh (const CVAGeometryMesh &oMesh, const std::string &sName="")=0
 Create a geometry mesh with mesh infos. More...
 
virtual int CreateGeometryMeshFromParameters (const CVAStruct &oParams, const std::string &sName="")=0
 Create a geometry mesh from parameters. More...
 
int CreateGeometryMeshFromFile (const std::string &sFilePath, const std::string &sName="")
 Create a geometry mesh from file. More...
 
virtual bool DeleteGeometryMesh (const int iID)=0
 Delete a geometry mesh. More...
 
virtual CVAGeometryMesh GetGeometryMesh (const int iID) const =0
 Get a geometry mesh from identifeir. More...
 
virtual void GetGeometryMeshIDs (std::vector< int > &viIDs) const =0
 Get geometry mesh ids. More...
 
virtual void SetGeometryMeshName (const int iID, const std::string &sName)=0
 Delete a geometry mesh. More...
 
virtual std::string GetGeometryMeshName (const int iID) const =0
 Geometry mesh name getter. More...
 
virtual void SetGeometryMeshParameters (const int iID, const CVAStruct &oParams)=0
 Geometry mesh parameter setter. More...
 
virtual CVAStruct GetGeometryMeshParameters (const int iID, const CVAStruct &oParams) const =0
 Geometry mesh parameter getter. More...
 
virtual void SetGeometryMeshEnabled (const int iID, const bool bEnabled=true)=0
 Geometry mesh enabled setter. More...
 
virtual bool GetGeometryMeshEnabled (const int iID) const =0
 Geometry mesh enabled getter. More...
 
std::string CreateSignalSourceBufferFromFile (const std::string &sFilePath, const std::string &sName="")
 Creates a buffer signal source from an audio file. More...
 
virtual std::string CreateSignalSourceBufferFromSamples (const CVASampleBuffer &oSamples, const std::string &sName="")
 Creates a mono buffer signal source from sample buffer. More...
 
std::string CreateSignalSourceBufferMultichannelFromSamples (const std::vector< CVASampleBuffer > &voSamples, const std::string &sName="")
 Creates a multi-channel buffer signal source from sample buffer. More...
 
virtual std::string CreateSignalSourceBufferFromParameters (const CVAStruct &oParams, const std::string &sName="")=0
 Creates a buffer signal source from parameters. More...
 
virtual std::string CreateSignalSourceTextToSpeech (const std::string &sName="")=0
 Creates a text-to-speech (TTS) signal source. More...
 
virtual std::string CreateSignalSourceSequencer (const std::string &sName="")=0
 Creates a sequencer signal source. More...
 
virtual std::string CreateSignalSourceNetworkStream (const std::string &sInterface, const int iPort, const std::string &sName="")=0
 Creates a network-based signal source. More...
 
virtual std::string CreateSignalSourceEngine (const CVAStruct &oParams, const std::string &sName="")=0
 Creates a rotating engine source. More...
 
virtual std::string CreateSignalSourceMachine (const CVAStruct &oParams, const std::string &sName="")=0
 Creates a machine signal source. More...
 
virtual bool DeleteSignalSource (const std::string &sID)=0
 Deletes a signal source. More...
 
virtual std::string RegisterSignalSource (IVAAudioSignalSource *pSignalSource, const std::string &sName="")=0
 Registers an (external) signal source with the core. More...
 
virtual bool UnregisterSignalSource (IVAAudioSignalSource *pSignalSource)=0
 Unregisters an (external) signal source from the core. More...
 
virtual CVASignalSourceInfo GetSignalSourceInfo (const std::string &sSignalSourceID) const =0
 Retrieves information of a signal source. More...
 
virtual void GetSignalSourceInfos (std::vector< CVASignalSourceInfo > &voInfos) const =0
 Retrieves information of all signal sources. More...
 
virtual int GetSignalSourceBufferPlaybackState (const std::string &sSignalSourceID) const =0
 Returns the playback state flag (bit-vector) of an audiofile signal source. More...
 
virtual void SetSignalSourceBufferPlaybackAction (const std::string &sSignalSourceID, const int iPlaybackAction)=0
 Set the playback state of an audiofile signal source. More...
 
virtual void SetSignalSourceBufferPlaybackPosition (const std::string &sSignalSourceID, const double dPlaybackPosition)=0
 Set the playback position of an audiofile signal source. More...
 
virtual void SetSignalSourceBufferLooping (const std::string &sSignalSourceID, const bool bLooping=true)=0
 Set playback looping mode (true = looping) More...
 
virtual bool GetSignalSourceBufferLooping (const std::string &sSignalSourceID) const =0
 Get playback looping mode (true = looping) More...
 
void SetSignalSourceMachineStartMachine (const std::string &sSignalSourceID)
 Starts the signal of a machine source. More...
 
void SetSignalSourceMachineHaltMachine (const std::string &sSignalSourceID)
 Halts the signal of a machine source. More...
 
std::string GetSignalSourceMachineStateStr (const std::string &sSignalSourceID) const
 Returns the state of a machine signal source. More...
 
void SetSignalSourceMachineSpeed (const std::string &sSignalSourceID, double dSpeed)
 Sets the speed of a machine signal source. More...
 
double GetSignalSourceMachineSpeed (const std::string &sSignalSourceID) const
 Sets the speed of a machine signal source. More...
 
void SetSignalSourceMachineStartFile (const std::string &sSignalSourceID, const std::string &sFilePath)
 Set start file sample of machine signal source. More...
 
void SetSignalSourceMachineIdleFile (const std::string &sSignalSourceID, const std::string &sFilePath)
 Set idle file sample of machine signal source. More...
 
void SetSignalSourceMachineStopFile (const std::string &sSignalSourceID, const std::string &sFilePath)
 Set stop file sample of machine signal source. More...
 
virtual void SetSignalSourceParameters (const std::string &sSignalSourceID, const CVAStruct &oParams)=0
 Set parameters for a signal source. More...
 
virtual CVAStruct GetSignalSourceParameters (const std::string &sSignalSourceID, const CVAStruct &oParams) const =0
 Get parameters from a signal source. More...
 
int AddSignalSourceSequencerSample (const std::string &sSignalSourceID, const std::string sFilePath)
 Add sequencer sample from file path. More...
 
virtual int AddSignalSourceSequencerSample (const std::string &sSignalSourceID, const CVAStruct &oArgs)=0
 Add sequencer sample. More...
 
virtual int AddSignalSourceSequencerPlayback (const std::string &sSignalSourceID, const int iSoundID, const int iFlags, const double dTimeCode)=0
 Add sequencer sound playback. More...
 
virtual void RemoveSignalSourceSequencerSample (const std::string &sSignalSourceID, const int iSoundID)=0
 Remove sound sample (a sample added for playback can not be reverted) More...
 
virtual bool GetUpdateLocked () const =0
 Returns wheather a synchronized scene modification is in progress. More...
 
virtual void LockUpdate ()=0
 Begins a synchronized scene modification. More...
 
virtual int UnlockUpdate ()=0
 Ends a synchronized scene modification and applies all changes. More...
 
virtual int CreateSoundSource (const std::string &sName="")=0
 Create a sound source. More...
 
virtual void GetSoundSourceIDs (std::vector< int > &viSoundSourceIDs)=0
 Return all sound source IDs. More...
 
virtual CVASoundSourceInfo GetSoundSourceInfo (const int iID) const =0
 Return sound source info. More...
 
virtual int CreateSoundSourceExplicitRenderer (const std::string &sRendererID, const std::string &sName="")=0
 Create a sound source explicitly for a certain renderer. More...
 
virtual int DeleteSoundSource (const int iID)=0
 Removes a sound source. More...
 
virtual void SetSoundSourceEnabled (const int iID, const bool bEnabled=true)=0
 Enables or disables a sound source (removes the sound source from processing within renderers) More...
 
virtual bool GetSoundSourceEnabled (const int iID) const =0
 Returns sound source enabled/disabled status. More...
 
virtual std::string GetSoundSourceName (const int iID) const =0
 Returns name of a sound source. More...
 
virtual void SetSoundSourceName (const int iID, const std::string &sName)=0
 Sound source name setter. More...
 
virtual std::string GetSoundSourceSignalSource (const int iID) const =0
 Returns signal source identifier of a sound source. More...
 
virtual int GetSoundSourceGeometryMesh (const int iID) const =0
 Sound source geo mesh identifier getter. More...
 
virtual void SetSoundSourceGeometryMesh (const int iSoundReceiverID, const int iGeometryMeshID)=0
 Sound source geo mesh identifier getter. More...
 
virtual void SetSoundSourceSignalSource (const int iID, const std::string &sSignalSourceID)=0
 Attach a signal source to sound source. More...
 
void RemoveSoundSourceSignalSource (const int iID)
 Detach signal source from a sound sourve. More...
 
virtual int GetSoundSourceAuralizationMode (const int iID) const =0
 Sound source auralization mode getter. More...
 
virtual void SetSoundSourceAuralizationMode (const int iID, const int iAuralizationMode)=0
 Sound source auralization mode setter. More...
 
virtual void SetSoundSourceParameters (const int iID, const CVAStruct &oParams)=0
 Set sound source parameters. More...
 
virtual CVAStruct GetSoundSourceParameters (const int iID, const CVAStruct &oParams) const =0
 Get sound source parameters. More...
 
virtual int GetSoundSourceDirectivity (const int iID) const =0
 Returns the directivity of a sound source. More...
 
virtual void SetSoundSourceDirectivity (const int iSoundReceiverID, const int iDirectivityID)=0
 Sets the directivity of a sound source. More...
 
virtual double GetSoundSourceSoundPower (const int iID) const =0
 Sound receiver sound power getter. More...
 
virtual void SetSoundSourceSoundPower (const int iID, const double dSoundPower)=0
 Sound receiver sound power setter. More...
 
virtual bool GetSoundSourceMuted (const int iID) const =0
 Sound source enabled getter. More...
 
virtual void SetSoundSourceMuted (const int iID, const bool bMuted=true)=0
 Sound source enabled setter. More...
 
virtual void GetSoundSourcePose (const int iID, VAVec3 &v3Pos, VAQuat &qOrient) const =0
 Sound source pose getter. More...
 
virtual void SetSoundSourcePose (const int iID, const VAVec3 &v3Pos, const VAQuat &qOrient)=0
 Sound source pose setter. More...
 
virtual VAVec3 GetSoundSourcePosition (const int iID) const =0
 Sound source position getter. More...
 
virtual void SetSoundSourcePosition (const int iID, const VAVec3 &v3Pos)=0
 Sound source position setter. More...
 
virtual VAQuat GetSoundSourceOrientation (const int iID) const =0
 Sound source orientation getter. More...
 
virtual void SetSoundSourceOrientation (const int iID, const VAQuat &qOrient)=0
 Sound source orientation setter. More...
 
virtual void GetSoundSourceOrientationVU (const int iID, VAVec3 &v3View, VAVec3 &v3Up) const =0
 Sound source orientation getter for view and up vectors. More...
 
virtual void SetSoundSourceOrientationVU (const int iID, const VAVec3 &v3View, const VAVec3 &v3Up)=0
 Sound source orientation setter using view and up vector. More...
 
virtual void GetSoundReceiverIDs (std::vector< int > &viIDs) const =0
 Returns all sound receiver IDs. More...
 
virtual int CreateSoundReceiver (const std::string &sName="")=0
 Creates a sound receiver. More...
 
virtual int CreateSoundReceiverExplicitRenderer (const std::string &sRendererID, const std::string &sName="")=0
 Creates a sound receiver explicitly for a given renderer. More...
 
virtual int DeleteSoundReceiver (const int iID)=0
 Removes a sound receiver. More...
 
virtual CVASoundReceiverInfo GetSoundReceiverInfo (const int iID) const =0
 Sound receiver info getter. More...
 
virtual void SetSoundReceiverEnabled (const int iID, const bool bEnabled=true)=0
 Enables or disables a virtual sound receiver (removes the sound receiver from audio processing) More...
 
virtual bool GetSoundReceiverEnabled (const int iID) const =0
 Returns sound receiver enabled/disabled status. More...
 
virtual std::string GetSoundReceiverName (const int iID) const =0
 Sound receiver name getter. More...
 
virtual void SetSoundReceiverName (const int iID, const std::string &sName)=0
 Sound receiver name setter. More...
 
virtual int GetSoundReceiverAuralizationMode (const int iID) const =0
 Sound receiver auralization mode getter. More...
 
virtual void SetSoundReceiverAuralizationMode (const int iSoundReceiverID, const int iAuralizationMode)=0
 Sound receiver auralization mode setter. More...
 
virtual void SetSoundReceiverParameters (const int iID, const CVAStruct &oParams)=0
 Set sound receiver parameters. More...
 
virtual CVAStruct GetSoundReceiverParameters (const int iID, const CVAStruct &oArgs) const =0
 Get sound receiver parameters. More...
 
virtual int GetSoundReceiverDirectivity (const int iID) const =0
 Returns the directivity of a sound source. More...
 
virtual void SetSoundReceiverDirectivity (const int iSoundReceiverID, const int iDirectivityID)=0
 Sets the directivity of a sound receiver. More...
 
virtual int GetSoundReceiverGeometryMesh (const int iID) const =0
 Sound receiver geo mesh identifier getter. More...
 
virtual void SetSoundReceiverGeometryMesh (const int iSoundReceiverID, const int iGeometryMeshID)=0
 Sound receiver geo mesh identifier getter. More...
 
virtual void GetSoundReceiverPose (const int iID, VAVec3 &v3Pos, VAQuat &qOrient) const =0
 Sound source pose getter. More...
 
virtual void SetSoundReceiverPose (const int iID, const VAVec3 &v3Pos, const VAQuat &qOrient)=0
 Sound source pose setter. More...
 
virtual VAVec3 GetSoundReceiverPosition (const int iID) const =0
 Sound source position getter. More...
 
virtual void SetSoundReceiverPosition (const int iID, const VAVec3 &v3Pos)=0
 Sound source position setter. More...
 
virtual void GetSoundReceiverOrientationVU (const int iID, VAVec3 &v3View, VAVec3 &v3Up) const =0
 Sound source orientation getter for view and up vectors. More...
 
virtual void SetSoundReceiverOrientationVU (const int iID, const VAVec3 &v3View, const VAVec3 &v3Up)=0
 Sound source orientation setter using view and up vector. More...
 
virtual VAQuat GetSoundReceiverOrientation (const int iID) const =0
 Sound source orientation getter. More...
 
virtual void SetSoundReceiverOrientation (const int iID, const VAQuat &qOrient)=0
 Sound source orientation setter. More...
 
virtual VAQuat GetSoundReceiverHeadAboveTorsoOrientation (const int iID) const =0
 Sound receiver head-above-torso orientation getter. More...
 
virtual void SetSoundReceiverHeadAboveTorsoOrientation (const int iID, const VAQuat &qOrient)=0
 Sound receiver head-above-torso orientation setter. More...
 
virtual void GetSoundReceiverRealWorldPositionOrientationVU (const int iID, VAVec3 &v3Pos, VAVec3 &v3View, VAVec3 &v3Up) const =0
 Returns the position and orientation of the real-world sound receiver's head. More...
 
virtual void SetSoundReceiverRealWorldPositionOrientationVU (const int iID, const VAVec3 &v3Pos, const VAVec3 &v3View, const VAVec3 &v3Up)=0
 Updates the position and orientation of the real-world sound receiver's head. More...
 
virtual void GetSoundReceiverRealWorldPose (const int iID, VAVec3 &v3Pos, VAQuat &qOrient) const =0
 Returns the pose of the real-world sound receiver's head. More...
 
virtual void SetSoundReceiverRealWorldPose (const int iID, const VAVec3 &v3Pos, const VAQuat &qOrient)=0
 Updates the pose of the real-world sound receiver's head. More...
 
virtual VAQuat GetSoundReceiverRealWorldHeadAboveTorsoOrientation (const int iID) const =0
 Sound receiver real-world head-above-torso (HATO) orientation getter. More...
 
virtual void SetSoundReceiverRealWorldHeadAboveTorsoOrientation (const int iID, const VAQuat &qOrient)=0
 Sound receiver real-world head-above-torso orientation setter. More...
 
virtual void SetHomogeneousMediumSoundSpeed (const double dSoundSpeed)=0
 Set homogeneous medium sound speed in m/s. More...
 
virtual double GetHomogeneousMediumSoundSpeed () const =0
 Get homogeneous medium sound speed in m/s. More...
 
virtual void SetHomogeneousMediumTemperature (const double dDegreesCentigrade)=0
 Set homogeneous medium temperature in degree Celsius (0 is freezing point of water) More...
 
virtual double GetHomogeneousMediumTemperature () const =0
 Get homogeneous medium temperature in degree Celsius (0 is freezing point of water) More...
 
virtual void SetHomogeneousMediumStaticPressure (const double dPressurePascal)=0
 Set homogeneous medium static pressure in Pascal. More...
 
virtual double GetHomogeneousMediumStaticPressure () const =0
 Get homogeneous medium static pressure in Pascal. More...
 
virtual void SetHomogeneousMediumRelativeHumidity (const double dRelativeHumidityPercent)=0
 Set homogeneous medium relative humidity in percent (0.0 = no vapor, 50.0 = 50%, ... ) More...
 
virtual double GetHomogeneousMediumRelativeHumidity ()=0
 Get homogeneous medium relative humidity in percent (0.0 = no vapor, 50.0 = 50%, ... ) More...
 
virtual void SetHomogeneousMediumShiftSpeed (const VAVec3 &v3TranslationSpeed)=0
 Set homogeneous medium shift speed as 3-dim direction vector in m/s ("wind" speed with direction) More...
 
virtual VAVec3 GetHomogeneousMediumShiftSpeed () const =0
 Get homogeneous medium shift speed as 3-dim direction vector in m/s ("wind" speed with direction) More...
 
virtual void SetHomogeneousMediumParameters (const CVAStruct &oParams)=0
 Set homogeneous medium special parameters. More...
 
virtual CVAStruct GetHomogeneousMediumParameters (const CVAStruct &oArgs)=0
 Get homogeneous medium special parameters with optional arguments. More...
 
virtual std::string CreateScene (const CVAStruct &oParams, const std::string &sName="")=0
 Creates a virtual scene. More...
 
virtual void GetSceneIDs (std::vector< std::string > &vsIDs) const =0
 IDs of created scenes. More...
 
virtual CVASceneInfo GetSceneInfo (const std::string &sID) const =0
 Get scene info. More...
 
virtual std::string GetSceneName (const std::string &sID) const =0
 Returns the name of given scene. More...
 
virtual void SetSceneName (const std::string &sID, const std::string &sName)=0
 Set the name of given scene. More...
 
virtual void SetSceneEnabled (const std::string &sID, const bool bEnabled=true)=0
 Set scene enabled or disabled. More...
 
virtual bool GetSceneEnabled (const std::string &sID) const =0
 Scene enabled status (true, if enabled) More...
 
virtual int CreateSoundPortal (const std::string &sName="")=0
 Create a sound portal. More...
 
virtual void GetSoundPortalIDs (std::vector< int > &viIDs)=0
 Return all portal IDs. More...
 
virtual CVASoundPortalInfo GetSoundPortalInfo (const int iID) const =0
 Return sound portal info. More...
 
virtual std::string GetSoundPortalName (const int iID) const =0
 Returns the name of a portal. More...
 
virtual void SetSoundPortalName (const int iID, const std::string &sName)=0
 Sets the name of a portal. More...
 
virtual void SetSoundPortalMaterial (const int iSoundPortalID, const int iMaterialID)=0
 Sound portal material setter. More...
 
virtual int GetSoundPortalMaterial (const int iID) const =0
 Sound portal material getter. More...
 
virtual void SetSoundPortalNextPortal (const int iSoundPortalID, const int iNextSoundPortalID)=0
 Sound portal next portal setter. More...
 
virtual int GetSoundPortalNextPortal (const int iID) const =0
 Sound portal next portal getter. More...
 
virtual void SetSoundPortalSoundReceiver (const int iSoundPortalID, const int iSoundReceiverID)=0
 Sound portal target sound receiver setter. More...
 
virtual int GetSoundPortalSoundReceiver (const int iSoundPortalID) const =0
 Sound portal target sound receiver getter. More...
 
virtual void SetSoundPortalSoundSource (const int iSoundPortalID, const int iSoundSourceID)=0
 Sound portal sound source setter. More...
 
virtual int GetSoundPortalSoundSource (const int iSoundPortalID) const =0
 Sound portal sound source getter. More...
 
virtual CVAStruct GetSoundPortalParameters (const int iID, const CVAStruct &oParams) const =0
 Get sound portal parameters. More...
 
virtual void SetSoundPortalParameters (const int iID, const CVAStruct &oParams)=0
 Set sound portal parameters. More...
 
virtual void SetSoundPortalPosition (const int iID, const VAVec3 &vPos)=0
 Sound portal position setter. More...
 
virtual VAVec3 GetSoundPortalPosition (const int iID) const =0
 Sound portal position getter. More...
 
virtual void SetSoundPortalOrientation (const int iID, const VAQuat &qOrient)=0
 Sound portal orientation setter. More...
 
virtual VAQuat GetSoundPortalOrientation (const int iID) const =0
 Sound portal orientation getter. More...
 
virtual void SetSoundPortalEnabled (const int iID, const bool bEnabled=true)=0
 Sound portal enabled setter. More...
 
virtual bool GetSoundPortalEnabled (const int iID) const =0
 Sound portal orientation getter. More...
 
virtual void GetRenderingModules (std::vector< CVAAudioRendererInfo > &voRenderer, const bool bFilterEnabled=true) const =0
 Returns all available renderers (default: only those that are enabled) More...
 
virtual void SetRenderingModuleMuted (const std::string &sModuleID, const bool bMuted=true)=0
 Mutes/unmutes a rendering module audio output. More...
 
virtual bool GetRenderingModuleMuted (const std::string &sModuleID) const =0
 Returns if rendering module audio output is muted or not. More...
 
virtual void SetRenderingModuleGain (const std::string &sModuleID, const double dGain)=0
 Sets the rendering module audio output gain. More...
 
virtual double GetRenderingModuleGain (const std::string &sModuleID) const =0
 Returns the rendering module audio output gain. More...
 
virtual void SetRenderingModuleAuralizationMode (const std::string &sModuleID, const int iAuralizationMode)=0
 Sets the rendering module auralization mode. More...
 
virtual int GetRenderingModuleAuralizationMode (const std::string &sModuleID) const =0
 Returns the rendering module auralization mode. More...
 
virtual void SetRenderingModuleParameters (const std::string &sModuleID, const CVAStruct &oParams)=0
 Sets the rendering module parameters. More...
 
virtual CVAStruct GetRenderingModuleParameters (const std::string &sModuleID, const CVAStruct &oParams) const =0
 Returns the rendering module parameters. More...
 
virtual void GetReproductionModules (std::vector< CVAAudioReproductionInfo > &voReproductions, const bool bFilterEnabled=true) const =0
 Returns all available reproductions (default: only those that are enabled) More...
 
virtual void SetReproductionModuleMuted (const std::string &sModuleID, const bool bMuted=true)=0
 Mutes/unmutes a rendering module audio output. More...
 
virtual bool GetReproductionModuleMuted (const std::string &sModuleID) const =0
 Returns if rendering module audio output is muted or not. More...
 
virtual void SetReproductionModuleGain (const std::string &sModuleID, const double dGain)=0
 Sets the reproduction module audio output gain. More...
 
virtual double GetReproductionModuleGain (const std::string &sModuleID) const =0
 Returns the rendering module audio output gain. More...
 
virtual void SetReproductionModuleParameters (const std::string &sModuleID, const CVAStruct &oParams)=0
 Sets the reproduction module parameters. More...
 
virtual CVAStruct GetReproductionModuleParameters (const std::string &sModuleID, const CVAStruct &oParams) const =0
 Returns the reproduction module parameters. More...
 
virtual double GetInputGain () const =0
 Returns the global audio interface input gain. More...
 
virtual void SetInputGain (const double dGain)=0
 Sets the global audio interface input gain. More...
 
virtual bool GetInputMuted () const =0
 Returns if global audio interface input is muted or not. More...
 
virtual void SetInputMuted (const bool bMuted=true)=0
 Mutes global audio interface input. More...
 
virtual double GetOutputGain () const =0
 Returns the global audio interface output gain. More...
 
virtual void SetOutputGain (const double dGain)=0
 Sets the global audio interface output gain. More...
 
virtual bool GetOutputMuted () const =0
 Returns if global audio interface output is muted or not. More...
 
virtual void SetOutputMuted (const bool bMuted=true)=0
 Sets the global audio interface input gain. More...
 
virtual int GetGlobalAuralizationMode () const =0
 Returns the global auralization mode. More...
 
virtual void SetGlobalAuralizationMode (const int iAuralizationMode)=0
 Sets the global auralization mode. More...
 
virtual int GetActiveSoundReceiver () const =0
 Returns the (global) active sound receiver. More...
 
virtual void SetActiveSoundReceiver (const int iSoundReceiverID)=0
 Sets the active sound receiver. More...
 
virtual int GetActiveSoundReceiverExplicitRenderer (const std::string &sRendererID) const =0
 Returns the active sound receiver of an explicit renderer. More...
 
virtual void SetActiveSoundReceiverExplicitRenderer (const int iSoundReceiverID, const std::string &sRendererID)=0
 Sets the active sound receiver for an explicit renderer. More...
 
virtual double GetCoreClock () const =0
 Get current core time. More...
 
virtual void SetCoreClock (const double dSeconds)=0
 Set core time. More...
 
virtual std::string SubstituteMacros (const std::string &sStr) const =0
 Substitute VA core macro definitions in a string (e.g. a filename) More...
 
virtual std::string FindFilePath (const std::string &sFilePath) const =0
 Searches for the file and returns full path (relative or absolute) More...
 

Static Public Member Functions

static bool GetAuralizationModeValid (const int iAuralizationMode)
 Auralization mode bit-vector validation. More...
 
static bool GetVolumeValid (const double dVolume)
 Checks if volume value is positive. More...
 
static bool GetSignalSourceBufferPlaybackActionValid (const int iAction)
 Validates buffer signal source playback action. More...
 
static std::string GetLogLevelStr (const int iLogLevel)
 Log level string getter. More...
 
static int ParseAuralizationModeStr (const std::string &sModeStr, const int iBaseMode=VA_AURAMODE_NOTHING)
 Parses an auralization mode from a string (short format only) More...
 
static std::string GetAuralizationModeStr (const int iAuralizationMode, const bool bShortFormat=false)
 Returns an auralization mode as formatted string. More...
 
static std::string GetVolumeStrDecibel (const double dVolume)
 Converst a volume to decibel as string (for formatting) More...
 
static int ParsePlaybackState (const std::string &sStr)
 Parses an play state from a string. More...
 
static std::string GetPlaybackStateStr (const int iPlaybackState)
 Returns an play state as formatted string (short format) More...
 
static std::string GetPlaybackActionStr (const int iPlaybackAction)
 Returns an play action as formatted string (short format) More...
 
static int ParsePlaybackAction (const std::string &sPlaybackAction)
 Returns the playback action integer from a string representation (PLAY, STOP, PAUSE) More...
 
static const std::vector< CVAIntLiteral > & GetLiterals ()
 Returns the table of literals defined by the IVACore interface. More...
 

Static Public Attributes

static const int VA_AURAMODE_NOTHING = 0
 Auralization modes (bit-vector flags) More...
 
static const int VA_AURAMODE_DIRECT_SOUND = ( 1 << 0 )
 Direct sound. More...
 
static const int VA_AURAMODE_EARLY_REFLECTIONS = ( 1 << 1 )
 Early reflections. More...
 
static const int VA_AURAMODE_DIFFUSE_DECAY = ( 1 << 2 )
 Diffuse decay. More...
 
static const int VA_AURAMODE_SOURCE_DIRECTIVITY = ( 1 << 3 )
 Source directivity. More...
 
static const int VA_AURAMODE_MEDIUM_ABSORPTION = ( 1 << 4 )
 Absorption in air. More...
 
static const int VA_AURAMODE_TEMP_VAR = ( 1 << 5 )
 Atmospheric temporal variations. More...
 
static const int VA_AURAMODE_SCATTERING = ( 1 << 6 )
 Scattering. More...
 
static const int VA_AURAMODE_DIFFRACTION = ( 1 << 7 )
 Diffraction. More...
 
static const int VA_AURAMODE_NEARFIELD = ( 1 << 8 )
 Near-field effects. More...
 
static const int VA_AURAMODE_DOPPLER = ( 1 << 9 )
 Doppler effects. More...
 
static const int VA_AURAMODE_SPREADING_LOSS = ( 1 << 10 )
 Spherical spreading loss. More...
 
static const int VA_AURAMODE_TRANSMISSION = ( 1 << 11 )
 Sound transmission. More...
 
static const int VA_AURAMODE_ABSORPTION = ( 1 << 12 )
 Material absorption. More...
 
static const int VA_AURAMODE_LAST = ( 1 << 13 )
 
static const int VA_AURAMODE_DEFAULT
 For validation checking, increase for more modes! More...
 
static const int VA_AURAMODE_ALL
 All auralization modes (mask) More...
 

Protected Member Functions

 IVAInterface ()
 

Detailed Description

Interface of Virtual Acoustics (VA)

This mostly abstract interface to VA describes all relevant functions and methods that have to be implemented to comply with a VA controller instance or core instance.

The VACore will implement all these methods. The VANet library will wrap and transmit methods and data classes to make the VA interface completely transparent through a network connection using TCP/IP. All binding classes provide similar named methods in the script language fashion and can use the networked connection or an internal core.

There are a lot of prototyping methods using CVAStruct, an associative container for any kind of value.

Events can be propagated to event handlers (including network clients) and help to detect core changes and updates.

Definition at line 50 of file VAInterface.h.

Member Enumeration Documentation

Core states.

Enumerator
VA_CORESTATE_CREATED 

Core was created, but is not yet initialized.

VA_CORESTATE_READY 

Core is successfully initialized and ready for use.

VA_CORESTATE_FAIL 

Core is corrupted and can not be recovered (trash state)

Definition at line 54 of file VAInterface.h.

Core error levels.

Enumerator
VA_LOG_LEVEL_QUIET 

Quiet log level (no outputs)

VA_LOG_LEVEL_ERROR 

Show errors ...

VA_LOG_LEVEL_WARNING 

... and warnings ...

VA_LOG_LEVEL_INFO 

... and infos ...

VA_LOG_LEVEL_VERBOSE 

... and verbose messages ...

VA_LOG_LEVEL_TRACE 

... and tracing outputs.

Definition at line 62 of file VAInterface.h.

Playback actions (transitions) of audiofile signal sources.

Enumerator
VA_PLAYBACK_ACTION_NONE 

No action.

VA_PLAYBACK_ACTION_STOP 

Stop playback.

VA_PLAYBACK_ACTION_PAUSE 

Pause playback.

VA_PLAYBACK_ACTION_PLAY 

Start/resume playback.

Definition at line 82 of file VAInterface.h.

Playback states of audiofile signal sources.

Enumerator
VA_PLAYBACK_STATE_INVALID 

Playback is stopped.

VA_PLAYBACK_STATE_STOPPED 

Playback is stopped.

VA_PLAYBACK_STATE_PAUSED 

Playback is paused.

VA_PLAYBACK_STATE_PLAYING 

Playback active.

Definition at line 73 of file VAInterface.h.

Constructor & Destructor Documentation

IVAInterface::~IVAInterface ( )
virtual

Destructor.

Note
If the core was not finialized until the time of its destruction, the destructor will attempt to implicitly finalize it here. Remember that you should always finialize a core, so that you can track errors.

Definition at line 73 of file VAInterface.cpp.

IVAInterface::IVAInterface ( )
protected

Definition at line 71 of file VAInterface.cpp.

Member Function Documentation

bool IVAInterface::AddSearchPath ( const std::string &  sPath)
virtual

Adds a search path to the core instance.

Parameters
[in]sPathLocal relative or absolute path
Returns
True, if path is valid at core side

Definition at line 75 of file VAInterface.cpp.

virtual int IVAInterface::AddSignalSourceSequencerPlayback ( const std::string &  sSignalSourceID,
const int  iSoundID,
const int  iFlags,
const double  dTimeCode 
)
pure virtual

Add sequencer sound playback.

Parameters
[in]sSignalSourceIDSignal source identifier
[in]iSoundIDSound sampler identifier
[in]iFlagsSampler playback start flags
[in]dTimeCodeTime code
Returns
Sample playback identifier

Implemented in CVANetClientImpl::CNetworkedVACore.

int IVAInterface::AddSignalSourceSequencerSample ( const std::string &  sSignalSourceID,
const std::string  sFilePath 
)
inline

Add sequencer sample from file path.

Parameters
[in]sSignalSourceIDSignal source identifier
[in]sFilePathSample audio file path
Returns
Sample identifier

Definition at line 884 of file VAInterface.h.

virtual int IVAInterface::AddSignalSourceSequencerSample ( const std::string &  sSignalSourceID,
const CVAStruct oArgs 
)
pure virtual

Add sequencer sample.

Parameters
[in]sSignalSourceIDSignal source identifier
[in]oArgsSample audio file parameters
Returns
Sample identifier

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::AttachEventHandler ( IVAEventHandler pEventHandler)
pure virtual

Attaches a handler for core events to the core instance.

Parameters
[in]pEventHandlerEvent handler pointer
Note
Attaching event handlers it always possible, regardless of the state of the core. This method can therefore be called anytime, also before initialization and after finalization.

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual CVAStruct IVAInterface::CallModule ( const std::string &  sModuleName,
const CVAStruct oArgs 
)
pure virtual

Calls a module and returns the answer.

This method is useful for prototyping. There is no general documentation possible. Special calls have to be extracted from C++ code in core. It is recommended to implement at least a help text that will be returned if the 'help' or 'info' key is set to any value. Also, a true-valued 'verbose' key flag should activate verbose return or output on debug stream.

Parameters
[in]sModuleNameFull qualifier of module identifier (may include ':' separator)
[in]oArgsMagic struct that is interpreted by module
Returns
Magic return struct

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual int IVAInterface::CreateAcousticMaterial ( const CVAAcousticMaterial oMaterial,
const std::string &  sName = "" 
)
pure virtual

Create acoustic material by passing material data.

Parameters
[in]oMaterialMaterial data
[in]sNameVerbatim name
Returns
Identifier

Implemented in CVANetClientImpl::CNetworkedVACore.

int IVAInterface::CreateAcousticMaterialFromFile ( const std::string &  sFilePath,
const std::string &  sName = "" 
)
inline

Create acoustic material from file path (e.g. 'mat' file)

Parameters
[in]sFilePathMaterial file path
[in]sNameVerbatim name
Returns
Identifier

Definition at line 383 of file VAInterface.h.

virtual int IVAInterface::CreateAcousticMaterialFromParameters ( const CVAStruct oParams,
const std::string &  sName = "" 
)
pure virtual

Create acoustic material based on magic parameter set (for prototyping)

Parameters
[in]oParamsMaterial parameters
[in]sNameVerbatim name
Returns
Identifier

Implemented in CVANetClientImpl::CNetworkedVACore.

int IVAInterface::CreateDirectivityFromFile ( const std::string &  sFilePath,
const std::string &  sName = "" 
)
inline

Create a directivity from a file path.

Parameters
[in]sFilePathFile path (relative or absolute or macro)
[in]sNameVersatile name
Returns
Directivity identifier

Definition at line 301 of file VAInterface.h.

virtual int IVAInterface::CreateDirectivityFromParameters ( const CVAStruct oParams,
const std::string &  sName = "" 
)
pure virtual

Create a directivity from a set of parameters.

Parameters
[in]oParamsParameters
[in]sNameVersatile name
Returns
Directivity identifier

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual int IVAInterface::CreateGeometryMesh ( const CVAGeometryMesh oMesh,
const std::string &  sName = "" 
)
pure virtual

Create a geometry mesh with mesh infos.

Parameters
[in]oMeshGeometry mesh information
[in]sNameVersatile name
Returns
Geometry mesh identifier

Implemented in CVANetClientImpl::CNetworkedVACore.

int IVAInterface::CreateGeometryMeshFromFile ( const std::string &  sFilePath,
const std::string &  sName = "" 
)
inline

Create a geometry mesh from file.

Parameters
[in]sFilePathGeometry mesh file path (relative or absolute or macro)
[in]sNameVersatile name
Returns
Geometry mesh identifier

Definition at line 465 of file VAInterface.h.

virtual int IVAInterface::CreateGeometryMeshFromParameters ( const CVAStruct oParams,
const std::string &  sName = "" 
)
pure virtual

Create a geometry mesh from parameters.

Parameters
[in]oParamsGeometry mesh parameters
[in]sNameVersatile name
Returns
Geometry mesh identifier

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual std::string IVAInterface::CreateScene ( const CVAStruct oParams,
const std::string &  sName = "" 
)
pure virtual

Creates a virtual scene.

Scenes is a relatively loose description for a virtual environment. It may contain information of arbitrary form that can be intepreted by a rendering module. The scene methods are for prototyping in order to pass scene information to a rendering module or an associated simulation backend that requires e.g. geometry input files.

Scenes may be enabled and disabled for rapid scene switching.

Parameters
[in]oParamsScene parameters
[in]sNameVerbatin scene name
Returns
Scene identifier string

Implemented in CVANetClientImpl::CNetworkedVACore.

std::string IVAInterface::CreateSignalSourceBufferFromFile ( const std::string &  sFilePath,
const std::string &  sName = "" 
)
inline

Creates a buffer signal source from an audio file.

Creates a signal source which streams the samples of an audiofile.

Parameters
[in]sFilePathFilename, file path, macro, ...
[in]sNameName (optional, e.g. "Trumpet")
Returns
Signal source ID

Definition at line 555 of file VAInterface.h.

virtual std::string IVAInterface::CreateSignalSourceBufferFromParameters ( const CVAStruct oParams,
const std::string &  sName = "" 
)
pure virtual

Creates a buffer signal source from parameters.

Creates a signal source which streams the samples of a buffer that is created based on magic parameters. Useful for prototyping, i.e. if a special signal source type is required and no interface change should be performed.

Parameters
[in]oParamsBuffer signal source magic parameters
[in]sNameName (optional, e.g. "Prototype Trumpet")
Returns
Signal source ID

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual std::string IVAInterface::CreateSignalSourceBufferFromSamples ( const CVASampleBuffer oSamples,
const std::string &  sName = "" 
)
inlinevirtual

Creates a mono buffer signal source from sample buffer.

Creates a signal source which streams the samples of a buffer.

Parameters
[in]oSamplesBuffer samples
[in]sNameName (optional, e.g. "Trumpet")
Returns
Signal source ID

Definition at line 571 of file VAInterface.h.

std::string IVAInterface::CreateSignalSourceBufferMultichannelFromSamples ( const std::vector< CVASampleBuffer > &  voSamples,
const std::string &  sName = "" 
)
inline

Creates a multi-channel buffer signal source from sample buffer.

Creates a signal source which streams the samples of a buffer with more than one channel. Useful for prototyping, i.e. for switching channels during playback or mixing.

Parameters
[in]voSamplesBuffer sample vector
[in]sNameName (optional, e.g. "Trumpet")
Returns
Signal source ID

Definition at line 588 of file VAInterface.h.

virtual std::string IVAInterface::CreateSignalSourceEngine ( const CVAStruct oParams,
const std::string &  sName = "" 
)
pure virtual

Creates a rotating engine source.

Parameters
[in]oParamsParameters
[in]sNameName of the engine
Returns
ID of signal source

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual std::string IVAInterface::CreateSignalSourceMachine ( const CVAStruct oParams,
const std::string &  sName = "" 
)
pure virtual

Creates a machine signal source.

Parameters
[in]oParamsParameters
[in]sNameName of the machine
Returns
Signal source identifier

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual std::string IVAInterface::CreateSignalSourceNetworkStream ( const std::string &  sInterface,
const int  iPort,
const std::string &  sName = "" 
)
pure virtual

Creates a network-based signal source.

Creates a signal source which receives audio samples via network. Therefore an IP socket is set up with the given parameters.

Parameters
[in]sInterfaceIP address of the socket
[in]iPortDestination port on which samples are received
[in]sNameOptional name
Note
Usual port range is 12480 to 12500
Returns
ID of signal source

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual std::string IVAInterface::CreateSignalSourceSequencer ( const std::string &  sName = "")
pure virtual

Creates a sequencer signal source.

Creates a sequencer signal source.

Parameters
[in]sNameName (optional, e.g. "Sequencer 1")
Returns
Signal source ID

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual std::string IVAInterface::CreateSignalSourceTextToSpeech ( const std::string &  sName = "")
pure virtual

Creates a text-to-speech (TTS) signal source.

Creates a signal source which streams generated samples from a text input.

Parameters
[in]sNameName (optional, e.g. "Penny")
Returns
Signal source ID

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual int IVAInterface::CreateSoundPortal ( const std::string &  sName = "")
pure virtual

Create a sound portal.

This method creates a new sound portal and returns its ID.

Parameters
[in]sNameName (optional)
Returns
ID of the new sound portal, if the method succeeded, -1 otherwise

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual int IVAInterface::CreateSoundReceiver ( const std::string &  sName = "")
pure virtual

Creates a sound receiver.

This method creates a new sound receiver (sound receiver).

Parameters
[in]sNameName (optional)
Returns
ID of the new sound receiver, if the method succeeded, -1, otherwise

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual int IVAInterface::CreateSoundReceiverExplicitRenderer ( const std::string &  sRendererID,
const std::string &  sName = "" 
)
pure virtual

Creates a sound receiver explicitly for a given renderer.

This method creates a new sound receiver for a given renderer, only. the sound receiver will be skipped by all other renderers.

Parameters
[in]sRendererIDRenderer identifier
[in]sNameName
Returns
ID of the new sound receiver, if the method succeeded and -1, otherwise

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual int IVAInterface::CreateSoundSource ( const std::string &  sName = "")
pure virtual

Create a sound source.

This method creates a new sound source and returns its ID. A signal source is not created and assigned to the sound source.

Parameters
[in]sNameName (optional)
Returns
ID of the new sound source, if the method succeeded, -1, otherwise

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual int IVAInterface::CreateSoundSourceExplicitRenderer ( const std::string &  sRendererID,
const std::string &  sName = "" 
)
pure virtual

Create a sound source explicitly for a certain renderer.

This method creates a new sound source and returns its ID. This sound source will be skipped for rendering from any other but the given renderer. See GetRenderingModules() to get a list of available renderers and their name identifier.

Parameters
[in]sRendererIDIdentifier of target renderer
[in]sNameName
Returns
Numerical identifier of the new sound source on success, -1 otherwise
Note
Throws VA exception

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual bool IVAInterface::DeleteAcousticMaterial ( const int  iID)
pure virtual

Create acoustic material based on magic parameter set (for prototyping)

Parameters
[in]iIDMaterial identifier
Returns
True, if material could be removed

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual bool IVAInterface::DeleteDirectivity ( const int  iID)
pure virtual

Delete a directivity.

Parameters
[in]iIDIdentifier
Returns
True, if directivity was found and could be released (was not in use)

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual bool IVAInterface::DeleteGeometryMesh ( const int  iID)
pure virtual

Delete a geometry mesh.

Parameters
[in]iIDGeometry mesh identifier
Returns
True if mesh could be removed

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual bool IVAInterface::DeleteSignalSource ( const std::string &  sID)
pure virtual

Deletes a signal source.

Deletes a signal source. This is only possible if it is not in use.

Returns
True, if the signal source has been deleted, false otherwise

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual int IVAInterface::DeleteSoundReceiver ( const int  iID)
pure virtual

Removes a sound receiver.

Will fail if sound receiver is an active listener.

Returns
0 on success, -1 otherwise

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual int IVAInterface::DeleteSoundSource ( const int  iID)
pure virtual

Removes a sound source.

Parameters
[in]iIDSound source identifier
Returns
0 on success, -1 otherwise

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::DetachEventHandler ( IVAEventHandler pEventHandler)
pure virtual

Detaches a handler for core events from the core instance.

Parameters
[in]pEventHandlerEvent handler pointer
Note
Detaching event handlers it always possible, regardless of the state of the core. This method can therefore be called anytime, also before initialization and after finalization.
When the method returns, it is guaranteed that the handler will not receive any further core events and may safely be destroyed.

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::Finalize ( )
pure virtual

Finalizes the core and frees allocated resources.

This method finalizes an initialized core. Thereby all its allocated resources are freed. Afterwards the core is in the state VA_CORESTATE_CREATED. It can then be reinitialized again.

Finalization should not fail in general. If for some reason it does, the core cannot be used anymore and is within the VA_CORESTATE_FAIL. It shall be destroyed in this case.

Note
Finalization does not detach event handlers

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual std::string IVAInterface::FindFilePath ( const std::string &  sFilePath) const
pure virtual

Searches for the file and returns full path (relative or absolute)

Parameters
[in]sFilePathnon-empty relative file path
Returns
If found, first valid combined file path; empty string otherwise
Note
Also substitutes macros
Prints a warning if file not found or ambiguous name

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual CVAAcousticMaterial IVAInterface::GetAcousticMaterialInfo ( const int  iID) const
pure virtual

Acoustic material info getter.

Parameters
[in]iIDMaterial identifier
Returns
Info on material

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::GetAcousticMaterialInfos ( std::vector< CVAAcousticMaterial > &  voDest) const
pure virtual

Acoustic material info getter for entire database.

Parameters
[out]voDestVector with material infos

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual std::string IVAInterface::GetAcousticMaterialName ( const int  iID) const
pure virtual

Acoustic material name getter.

Parameters
[in]iIDMaterial identifier
Returns
Verbatim name

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual CVAStruct IVAInterface::GetAcousticMaterialParameters ( const int  iID,
const CVAStruct oParams 
) const
pure virtual

Acoustic material name getter.

Parameters
[in]iIDMaterial identifier
[in]oParamsMaterial parameter request arguments
Returns
Material parameters

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual int IVAInterface::GetActiveSoundReceiver ( ) const
pure virtual

Returns the (global) active sound receiver.

The (global) active sound receiver is the virtual sound receiver for which the renderers will route the output for, if the sound receiver is not used explicitly for a given renderer.

Returns
Active sound receiver id or -1, if no (global) active sound receiver
See also
GetActiveSoundReceiverExplicitRenderer

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual int IVAInterface::GetActiveSoundReceiverExplicitRenderer ( const std::string &  sRendererID) const
pure virtual

Returns the active sound receiver of an explicit renderer.

Parameters
[in]sRendererIDRenderer identifier
Returns
Active sound receiver id or -1, if the sound receiver is not activated explicitly
See also
GetActiveSoundReceiver
SetActiveSoundReceiverExplicitRenderer

Implemented in CVANetClientImpl::CNetworkedVACore.

std::string IVAInterface::GetAuralizationModeStr ( const int  iAuralizationMode,
const bool  bShortFormat = false 
)
static

Returns an auralization mode as formatted string.

Parameters
[in]iAuralizationModeInput auralization mode
[in]bShortFormatFlag for short mode
Returns
Auralization mode string

Definition at line 283 of file VAInterface.cpp.

bool IVAInterface::GetAuralizationModeValid ( const int  iAuralizationMode)
static

Auralization mode bit-vector validation.

Parameters
[in]iAuralizationModeAuralization bit-vector
Returns
True, if auralization bit-vector is valid (positive bits are reflecting a mode)

Definition at line 84 of file VAInterface.cpp.

virtual double IVAInterface::GetCoreClock ( ) const
pure virtual

Get current core time.

This method returns the current clock of the core instance in seconds. This Clock is offset-cleaned from Stream Tracker, which uses the default clock

Returns
Clock time in seconds

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual CVAStruct IVAInterface::GetCoreConfiguration ( const bool  bFilterEnabled = true) const
pure virtual

Returns a struct with the core configuration.

Parameters
[in]bFilterEnabledIf true, only include enabled sections.
Returns
Encapsulated core configuration (as used to load/store and work in core)

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual CVADirectivityInfo IVAInterface::GetDirectivityInfo ( const int  iID) const
pure virtual

Directivity info getter.

Parameters
[in]iIDIdentifier
Returns
Directivity information

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::GetDirectivityInfos ( std::vector< CVADirectivityInfo > &  voDest) const
pure virtual

Directivity info getter.

Parameters
[out]voDestDirectivity information vector

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual std::string IVAInterface::GetDirectivityName ( const int  iID) const
pure virtual

Directivity name getter.

Parameters
[in]iIDIdentifier
Returns
Versatile name

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual CVAStruct IVAInterface::GetDirectivityParameters ( const int  iID,
const CVAStruct oParams 
) const
pure virtual

Directivity parameter getter.

Parameters
[in]iIDIdentifier
[in]oParamsParameters
Returns
Parameters

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual CVAStruct IVAInterface::GetFileList ( const bool  bRecursive = true,
const std::string &  sFileSuffixFilter = "*" 
) const
pure virtual

Returns files that are accessible through search paths.

Parameters
[in]bRecursiveSearch recursively in paths
[in]sFileSuffixFilterFile suffix / type filtering, i.e. "wav" or "daff". "*" or empty string will list all.
Returns
Encapsulated file paths
Warning
This call may take a while and can result in a lot of return data.

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual CVAGeometryMesh IVAInterface::GetGeometryMesh ( const int  iID) const
pure virtual

Get a geometry mesh from identifeir.

Parameters
[in]iIDGeometry mesh identifier
Returns
Geometry mesh

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual bool IVAInterface::GetGeometryMeshEnabled ( const int  iID) const
pure virtual

Geometry mesh enabled getter.

Parameters
[in]iIDGeometry mesh identifier
Returns
True if mesh is enabled, false otherwise

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::GetGeometryMeshIDs ( std::vector< int > &  viIDs) const
pure virtual

Get geometry mesh ids.

Parameters
[out]viIDsAll available geometry mesh identifiers

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual std::string IVAInterface::GetGeometryMeshName ( const int  iID) const
pure virtual

Geometry mesh name getter.

Parameters
[in]iIDGeometry mesh identifier
Returns
Verbatim name

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual CVAStruct IVAInterface::GetGeometryMeshParameters ( const int  iID,
const CVAStruct oParams 
) const
pure virtual

Geometry mesh parameter getter.

Parameters
[in]iIDGeometry mesh identifier
[in]oParamsGeometry mesh magic parameter request
Returns
Magic parameters

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual int IVAInterface::GetGlobalAuralizationMode ( ) const
pure virtual

Returns the global auralization mode.

Returns
Auralization mode bit-vector

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual CVAStruct IVAInterface::GetHardwareConfiguration ( ) const
pure virtual

Returns a struct with the hardware configuration.

Returns
Encapsulated hardware configuration

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual CVAStruct IVAInterface::GetHomogeneousMediumParameters ( const CVAStruct oArgs)
pure virtual

Get homogeneous medium special parameters with optional arguments.

Sets any further parameter of the medium, like Chemical constellation, particle density ... Intended to be used for prototyping. Can also be used to define non-homogeneous media by a proprietary definition that is used by a specialized rendering module, e.g. for air traffic noise.

Parameters
[in]oArgsMagic medium parameter request arguments
Returns
Magic medium parameters

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual double IVAInterface::GetHomogeneousMediumRelativeHumidity ( )
pure virtual

Get homogeneous medium relative humidity in percent (0.0 = no vapor, 50.0 = 50%, ... )

Returns
Relative humidity %

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual VAVec3 IVAInterface::GetHomogeneousMediumShiftSpeed ( ) const
pure virtual

Get homogeneous medium shift speed as 3-dim direction vector in m/s ("wind" speed with direction)

Returns
Translatory speed [m/s]

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual double IVAInterface::GetHomogeneousMediumSoundSpeed ( ) const
pure virtual

Get homogeneous medium sound speed in m/s.

Returns
Speed of sound [m/s]

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual double IVAInterface::GetHomogeneousMediumStaticPressure ( ) const
pure virtual

Get homogeneous medium static pressure in Pascal.

Returns
Static pressure [Pa]

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual double IVAInterface::GetHomogeneousMediumTemperature ( ) const
pure virtual

Get homogeneous medium temperature in degree Celsius (0 is freezing point of water)

Returns
Temperature in Degrees Centigrade []

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual double IVAInterface::GetInputGain ( ) const
pure virtual

Returns the global audio interface input gain.

Returns
Gain factor

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual bool IVAInterface::GetInputMuted ( ) const
pure virtual

Returns if global audio interface input is muted or not.

Returns
True, if muted, false otherwise

Implemented in CVANetClientImpl::CNetworkedVACore.

const std::vector< CVAIntLiteral > & IVAInterface::GetLiterals ( )
static

Returns the table of literals defined by the IVACore interface.

(This function is useful, when you implement bindings for other programming languages)

Returns
Integer literal vector

Definition at line 399 of file VAInterface.cpp.

std::string IVAInterface::GetLogLevelStr ( const int  iLogLevel)
static

Log level string getter.

Parameters
[in]iLogLevel
Returns
Log level string

Definition at line 106 of file VAInterface.cpp.

virtual void IVAInterface::GetModules ( std::vector< CVAModuleInfo > &  voModuleInfos) const
pure virtual

Get all registered modules of the core.

Parameters
[out]voModuleInfosVector with module infos

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual double IVAInterface::GetOutputGain ( ) const
pure virtual

Returns the global audio interface output gain.

Returns
Gain factor

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual bool IVAInterface::GetOutputMuted ( ) const
pure virtual

Returns if global audio interface output is muted or not.

Returns
True, if muted, false otherwise

Implemented in CVANetClientImpl::CNetworkedVACore.

std::string IVAInterface::GetPlaybackActionStr ( const int  iPlaybackAction)
static

Returns an play action as formatted string (short format)

Parameters
[in]iPlaybackActionPlayback action integer
Returns
Playback action string

Definition at line 391 of file VAInterface.cpp.

std::string IVAInterface::GetPlaybackStateStr ( const int  iPlaybackState)
static

Returns an play state as formatted string (short format)

Parameters
[in]iPlaybackStatePlayback state integer
Returns
Playback state string

Definition at line 371 of file VAInterface.cpp.

virtual int IVAInterface::GetRenderingModuleAuralizationMode ( const std::string &  sModuleID) const
pure virtual

Returns the rendering module auralization mode.

Parameters
[in]sModuleIDModule identifier
Returns
Auralization mode bit-vector

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual double IVAInterface::GetRenderingModuleGain ( const std::string &  sModuleID) const
pure virtual

Returns the rendering module audio output gain.

Parameters
[in]sModuleIDModule identifier
Returns
Gain

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual bool IVAInterface::GetRenderingModuleMuted ( const std::string &  sModuleID) const
pure virtual

Returns if rendering module audio output is muted or not.

Parameters
[in]sModuleIDModule identifier
Returns
True, if module muted, false otherwise

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual CVAStruct IVAInterface::GetRenderingModuleParameters ( const std::string &  sModuleID,
const CVAStruct oParams 
) const
pure virtual

Returns the rendering module parameters.

Parameters
[in]sModuleIDModule identifier
[in]oParamsMagic request parameters
Returns
Magic parameters

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::GetRenderingModules ( std::vector< CVAAudioRendererInfo > &  voRenderer,
const bool  bFilterEnabled = true 
) const
pure virtual

Returns all available renderers (default: only those that are enabled)

Parameters
[out]voRendererList of renderers modules
[in]bFilterEnabledIf true, only enabled renderers are returned (via configuration, during runtime)

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual double IVAInterface::GetReproductionModuleGain ( const std::string &  sModuleID) const
pure virtual

Returns the rendering module audio output gain.

Parameters
[in]sModuleIDModule identifier
Returns
Gain factor

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual bool IVAInterface::GetReproductionModuleMuted ( const std::string &  sModuleID) const
pure virtual

Returns if rendering module audio output is muted or not.

Parameters
[in]sModuleIDModule identifier
Returns
True, if module muted, false otherwise

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual CVAStruct IVAInterface::GetReproductionModuleParameters ( const std::string &  sModuleID,
const CVAStruct oParams 
) const
pure virtual

Returns the reproduction module parameters.

Parameters
[in]sModuleIDModule identifier
[in]oParamsMagic request parameters
Returns
Magic parameters

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::GetReproductionModules ( std::vector< CVAAudioReproductionInfo > &  voReproductions,
const bool  bFilterEnabled = true 
) const
pure virtual

Returns all available reproductions (default: only those that are enabled)

Parameters
[out]voReproductionsList of reproduction modules
[in]bFilterEnabledIf true, only enabled renderers are returned (via configuration, during runtime)

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual bool IVAInterface::GetSceneEnabled ( const std::string &  sID) const
pure virtual

Scene enabled status (true, if enabled)

Parameters
[in]sIDScene identifier
Returns
True, if scene is enabled

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::GetSceneIDs ( std::vector< std::string > &  vsIDs) const
pure virtual

IDs of created scenes.

Parameters
[out]vsIDsScene identifier vector

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual CVASceneInfo IVAInterface::GetSceneInfo ( const std::string &  sID) const
pure virtual

Get scene info.

Parameters
[in]sIDScene identifier
Returns
Scene information

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual std::string IVAInterface::GetSceneName ( const std::string &  sID) const
pure virtual

Returns the name of given scene.

Parameters
[in]sIDScene identifier
Returns
Scene verbatim name

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual CVAStruct IVAInterface::GetSearchPaths ( ) const
pure virtual

Returns a struct with entries for each search paths.

Returns
Encapsulated search paths

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual bool IVAInterface::GetSignalSourceBufferLooping ( const std::string &  sSignalSourceID) const
pure virtual

Get playback looping mode (true = looping)

Parameters
[in]sSignalSourceIDSignal source ID
Returns
True, if looping is enabled

Implemented in CVANetClientImpl::CNetworkedVACore.

bool IVAInterface::GetSignalSourceBufferPlaybackActionValid ( const int  iAction)
static

Validates buffer signal source playback action.

Parameters
[in]iActionAction integer
Returns
True, if action is recognized

Definition at line 94 of file VAInterface.cpp.

virtual int IVAInterface::GetSignalSourceBufferPlaybackState ( const std::string &  sSignalSourceID) const
pure virtual

Returns the playback state flag (bit-vector) of an audiofile signal source.

Parameters
[in]sSignalSourceIDSignal source identifier
Returns
Playback state integer

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual CVASignalSourceInfo IVAInterface::GetSignalSourceInfo ( const std::string &  sSignalSourceID) const
pure virtual

Retrieves information of a signal source.

Parameters
[in]sSignalSourceIDSignal source identifier
Returns
Signal source information

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::GetSignalSourceInfos ( std::vector< CVASignalSourceInfo > &  voInfos) const
pure virtual

Retrieves information of all signal sources.

Parameters
[in]voInfosSignal source info vector

Implemented in CVANetClientImpl::CNetworkedVACore.

double IVAInterface::GetSignalSourceMachineSpeed ( const std::string &  sSignalSourceID) const
inline

Sets the speed of a machine signal source.

Parameters
[in]sSignalSourceIDSignal source ID
Returns
Machine speed

Definition at line 806 of file VAInterface.h.

std::string IVAInterface::GetSignalSourceMachineStateStr ( const std::string &  sSignalSourceID) const
inline

Returns the state of a machine signal source.

Parameters
[in]sSignalSourceIDSignal source ID
Returns
Machine state as string

Definition at line 774 of file VAInterface.h.

virtual CVAStruct IVAInterface::GetSignalSourceParameters ( const std::string &  sSignalSourceID,
const CVAStruct oParams 
) const
pure virtual

Get parameters from a signal source.

This method returns parameters of a signal source. Behavior depends on type and implementation of the referred instance.

Parameters
[in]sSignalSourceIDID of signal source
[in]oParamsParameter request structure
Returns
Parameter structure

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual bool IVAInterface::GetSoundPortalEnabled ( const int  iID) const
pure virtual

Sound portal orientation getter.

Parameters
[in]iIDSound portal identifier
Returns
True, if enabled

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::GetSoundPortalIDs ( std::vector< int > &  viIDs)
pure virtual

Return all portal IDs.

Parameters
[out]viIDsSound portal identifiers

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual CVASoundPortalInfo IVAInterface::GetSoundPortalInfo ( const int  iID) const
pure virtual

Return sound portal info.

Parameters
[in]iIDSound portal identifier
Returns
Sound portal information

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual int IVAInterface::GetSoundPortalMaterial ( const int  iID) const
pure virtual

Sound portal material getter.

Parameters
[in]iIDSound portal identifier
Returns
Assigned material identifier or -1

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual std::string IVAInterface::GetSoundPortalName ( const int  iID) const
pure virtual

Returns the name of a portal.

Parameters
[in]iIDSound portal identifier
Returns
Verbatim name

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual int IVAInterface::GetSoundPortalNextPortal ( const int  iID) const
pure virtual

Sound portal next portal getter.

Parameters
[in]iIDSound portal identifier
Returns
Next connected sound portal identifier, or -1

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual VAQuat IVAInterface::GetSoundPortalOrientation ( const int  iID) const
pure virtual

Sound portal orientation getter.

Parameters
[in]iIDSound portal identifier
Returns
Orientation quaternion

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual CVAStruct IVAInterface::GetSoundPortalParameters ( const int  iID,
const CVAStruct oParams 
) const
pure virtual

Get sound portal parameters.

This general parameter getter can be used for quick solutions retrieving sound portal parameters without introducing new methods to the main interface.

Parameters
[in]iIDSound portal identifier
[in]oParamsMagic struct with the parameters that are requested
Returns
Magic struct with the parameter values requested

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual VAVec3 IVAInterface::GetSoundPortalPosition ( const int  iID) const
pure virtual

Sound portal position getter.

Parameters
[in]iIDSound portal identifier
Returns
Position vector

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual int IVAInterface::GetSoundPortalSoundReceiver ( const int  iSoundPortalID) const
pure virtual

Sound portal target sound receiver getter.

Parameters
[in]iSoundPortalIDSound portal identifier
Returns
Connected sound receiver identifier, or -1

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual int IVAInterface::GetSoundPortalSoundSource ( const int  iSoundPortalID) const
pure virtual

Sound portal sound source getter.

Parameters
[in]iSoundPortalIDSound portal identifier
Returns
Connected sound source identifier, or -1

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual int IVAInterface::GetSoundReceiverAuralizationMode ( const int  iID) const
pure virtual

Sound receiver auralization mode getter.

Parameters
[in]iIDSound receiver identifier
Returns
Auralization mode bit-vector

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual int IVAInterface::GetSoundReceiverDirectivity ( const int  iID) const
pure virtual

Returns the directivity of a sound source.

If the sound receiver is not assigned a directivity, the methods returns -1.

Parameters
[in]iIDSound receiver identifier
Returns
Directivity identifier

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual bool IVAInterface::GetSoundReceiverEnabled ( const int  iID) const
pure virtual

Returns sound receiver enabled/disabled status.

Parameters
[in]iIDSoundReceiver identifier
Returns
Enabled (true) or disabled (false)
See also
SetSoundReceiverEnabled()

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual int IVAInterface::GetSoundReceiverGeometryMesh ( const int  iID) const
pure virtual

Sound receiver geo mesh identifier getter.

Parameters
[in]iIDSound receiver identifier
Returns
Geo mesh identifier

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual VAQuat IVAInterface::GetSoundReceiverHeadAboveTorsoOrientation ( const int  iID) const
pure virtual

Sound receiver head-above-torso orientation getter.

Parameters
[in]iIDSound source identifier
Returns
Orientation of head-above-torso as quaternion

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::GetSoundReceiverIDs ( std::vector< int > &  viIDs) const
pure virtual

Returns all sound receiver IDs.

Parameters
[out]viIDsSound receiver identifier vector

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual CVASoundReceiverInfo IVAInterface::GetSoundReceiverInfo ( const int  iID) const
pure virtual

Sound receiver info getter.

Parameters
[in]iIDSound receiver identifier
Returns
Sound receiver info

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual std::string IVAInterface::GetSoundReceiverName ( const int  iID) const
pure virtual

Sound receiver name getter.

Parameters
[in]iIDSound receiver identifier
Returns
Verbatim name

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual VAQuat IVAInterface::GetSoundReceiverOrientation ( const int  iID) const
pure virtual

Sound source orientation getter.

Parameters
[in]iIDSound source identifier
Returns
Orientation quaternion

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::GetSoundReceiverOrientationVU ( const int  iID,
VAVec3 v3View,
VAVec3 v3Up 
) const
pure virtual

Sound source orientation getter for view and up vectors.

Uses OpenGL view and up convention.

Parameters
[in]iIDSound source identifier
[out]v3ViewView vector
[out]v3UpUp vector

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual CVAStruct IVAInterface::GetSoundReceiverParameters ( const int  iID,
const CVAStruct oArgs 
) const
pure virtual

Get sound receiver parameters.

This general parameter getter can be used for quick solutions retrieving sound receiver parameters without introducing new methods to the main interface.

Parameters
[in]iIDSoundReceiver identifier
[in]oArgsMagic struct with the parameters that are requested
Returns
Magic struct with the parameter values requested

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::GetSoundReceiverPose ( const int  iID,
VAVec3 v3Pos,
VAQuat qOrient 
) const
pure virtual

Sound source pose getter.

Parameters
[in]iIDSound source identifier
[out]v3PosPosition vector
[out]qOrientOrientation quaternion

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual VAVec3 IVAInterface::GetSoundReceiverPosition ( const int  iID) const
pure virtual

Sound source position getter.

Parameters
[in]iIDSound source identifier
Returns
Position vector

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual VAQuat IVAInterface::GetSoundReceiverRealWorldHeadAboveTorsoOrientation ( const int  iID) const
pure virtual

Sound receiver real-world head-above-torso (HATO) orientation getter.

A neutral HATO orientation will use the neutral head position looking to the front. A diverging orientation will describe how the head is oriented with respect to the torso (from the viewpoint of torso).

Parameters
[in]iIDSound source identifier
Returns
Orientation of head-above-torso as quaternion

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::GetSoundReceiverRealWorldPose ( const int  iID,
VAVec3 v3Pos,
VAQuat qOrient 
) const
pure virtual

Returns the pose of the real-world sound receiver's head.

Note
Coordinates refer the to center of the head on the axis which goes through both ears.
Parameters
[in]iIDSound receiver identifier
[out]v3PosReal world position of sound receiver
[out]qOrientReal world orientation as quaternion of sound receiver

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::GetSoundReceiverRealWorldPositionOrientationVU ( const int  iID,
VAVec3 v3Pos,
VAVec3 v3View,
VAVec3 v3Up 
) const
pure virtual

Returns the position and orientation of the real-world sound receiver's head.

Note
Coordinates refer the to center of the head on the axis which goes through both ears.
Parameters
[in]iIDSound receiver identifier
[out]v3PosReal world position of sound receiver
[out]v3ViewReal world view vector of sound receiver
[out]v3UpReal world up vector of sound receiver

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual int IVAInterface::GetSoundSourceAuralizationMode ( const int  iID) const
pure virtual

Sound source auralization mode getter.

Set an individual auralization mode for a given sound source.

Parameters
[in]iIDSound source identifier
Returns
Auralizaion mode bit-vector

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual int IVAInterface::GetSoundSourceDirectivity ( const int  iID) const
pure virtual

Returns the directivity of a sound source.

If the sound source is not assigned a directivity, the methods returns -1.

Parameters
[in]iIDSound source identifier
Returns
Directivity identifier

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual bool IVAInterface::GetSoundSourceEnabled ( const int  iID) const
pure virtual

Returns sound source enabled/disabled status.

Parameters
[in]iIDSound source identifier
Returns
Enabled (true) or disabled (false)
See also
SetSoundSourceEnabled()

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual int IVAInterface::GetSoundSourceGeometryMesh ( const int  iID) const
pure virtual

Sound source geo mesh identifier getter.

Parameters
[in]iIDSound source identifier
Returns
Geo mesh identifier

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::GetSoundSourceIDs ( std::vector< int > &  viSoundSourceIDs)
pure virtual

Return all sound source IDs.

Parameters
[out]viSoundSourceIDsSound source identifiers

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual CVASoundSourceInfo IVAInterface::GetSoundSourceInfo ( const int  iID) const
pure virtual

Return sound source info.

Parameters
[in]iIDSound source identifier
Returns
Sound source information

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual bool IVAInterface::GetSoundSourceMuted ( const int  iID) const
pure virtual

Sound source enabled getter.

Parameters
[in]iIDSound source identifier
Returns
True, if muted

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual std::string IVAInterface::GetSoundSourceName ( const int  iID) const
pure virtual

Returns name of a sound source.

Parameters
[in]iIDSound source identifier
Returns
Verbatim name

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual VAQuat IVAInterface::GetSoundSourceOrientation ( const int  iID) const
pure virtual

Sound source orientation getter.

Parameters
[in]iIDSound source identifier
Returns
Orientation quaternion

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::GetSoundSourceOrientationVU ( const int  iID,
VAVec3 v3View,
VAVec3 v3Up 
) const
pure virtual

Sound source orientation getter for view and up vectors.

Uses OpenGL view and up convention.

Parameters
[in]iIDSound source identifier
[out]v3ViewView vector
[out]v3UpUp vector

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual CVAStruct IVAInterface::GetSoundSourceParameters ( const int  iID,
const CVAStruct oParams 
) const
pure virtual

Get sound source parameters.

This general parameter getter can be used for quick solutions retrieving sound receiver parameters without introducing new methods to the main interface.

Parameters
[in]iIDSound source identifier
[in]oParamsMagic struct with the parameters that are requested
Returns
Magic struct with the parameter values requested

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::GetSoundSourcePose ( const int  iID,
VAVec3 v3Pos,
VAQuat qOrient 
) const
pure virtual

Sound source pose getter.

Parameters
[in]iIDSound source identifier
[out]v3PosPosition vector
[out]qOrientOrientation quaternion

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual VAVec3 IVAInterface::GetSoundSourcePosition ( const int  iID) const
pure virtual

Sound source position getter.

Parameters
[in]iIDSound source identifier
Returns
Position vector

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual std::string IVAInterface::GetSoundSourceSignalSource ( const int  iID) const
pure virtual

Returns signal source identifier of a sound source.

Parameters
[in]iIDSound source identifier
Returns
Signal source identifier, or -1 if not set

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual double IVAInterface::GetSoundSourceSoundPower ( const int  iID) const
pure virtual

Sound receiver sound power getter.

Parameters
[in]iIDSound source identifier
Returns
Sound power in Watts [W]

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual int IVAInterface::GetState ( ) const
pure virtual

Returns the state of the core.

Returns
Core state

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual bool IVAInterface::GetUpdateLocked ( ) const
pure virtual

Returns wheather a synchronized scene modification is in progress.

Returns
True, if scene update is locked

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::GetVersionInfo ( CVAVersionInfo pVersionInfo) const
pure virtual

Returns the core version.

Parameters
[out]pVersionInfoCore version information

Implemented in CVANetClientImpl::CNetworkedVACore.

std::string IVAInterface::GetVolumeStrDecibel ( const double  dVolume)
static

Converst a volume to decibel as string (for formatting)

Parameters
[in]dVolumeVolume
Returns
Volume as decibel string (including dB)

Definition at line 336 of file VAInterface.cpp.

bool IVAInterface::GetVolumeValid ( const double  dVolume)
static

Checks if volume value is positive.

Parameters
[in]dVolumeAuralization bit-vector
Returns
True, if volume is valid (greater zero)

Definition at line 89 of file VAInterface.cpp.

virtual void IVAInterface::Initialize ( )
pure virtual

Initializes the core.

This method initializes the core, making it ready for use.

If the method succeeds, the core is ready to use and within the state VA_CORESTATE_READY. Otherwise a CVAException is thrown, describing the cause for that the initialization failed. In this case the core remains in the state VA_CORESTATE_CREATED. If the initialized failed, the instance remains tidy. It is not necessary to clean it up by calling Finalize.

Since the initialization can take a longer time, involving many operations, progress events are send to all attached event handlers, informing about the current status. This happens during the call to the method.

Note
Initialization does not detach event handlers

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::LockUpdate ( )
pure virtual

Begins a synchronized scene modification.

Receives for the calling thread the exclusive scene modification tocken. Stays in possesion until UnlockUpdate is called.

Implemented in CVANetClientImpl::CNetworkedVACore.

int IVAInterface::ParseAuralizationModeStr ( const std::string &  sModeStr,
const int  iBaseMode = VA_AURAMODE_NOTHING 
)
static

Parses an auralization mode from a string (short format only)

This method takes a string with auralization modes in short format (e.g. "DS,ER") and interprets it as an auralization mode. More over the method allows to compute altered modes (e.g. "+DP" for enabling doppler effects) based on a given auralization mode.

Parameters
[in]sModeStr
[in]iBaseModeBase mode for differential mode setter
Returns
Modified auralization mode

Definition at line 136 of file VAInterface.cpp.

int IVAInterface::ParsePlaybackAction ( const std::string &  sPlaybackAction)
static

Returns the playback action integer from a string representation (PLAY, STOP, PAUSE)

Parameters
[in]sPlaybackActionPlayback action string
Returns
Playback action integer

Definition at line 379 of file VAInterface.cpp.

int IVAInterface::ParsePlaybackState ( const std::string &  sStr)
static

Parses an play state from a string.

This method takes a string with play state (e.g. "STOPPED", "PLAYING", "PAUSED") and converts it into a integer representation.

Parameters
[in]sStrPlayback state string
Returns
Playback state integer

Definition at line 355 of file VAInterface.cpp.

virtual std::string IVAInterface::RegisterSignalSource ( IVAAudioSignalSource pSignalSource,
const std::string &  sName = "" 
)
pure virtual

Registers an (external) signal source with the core.

This method registers a signal source which is not created and managed by the core. The core assignes it an ID, which makes it usable for auralization.

Parameters
[in]pSignalSourceSignal source instance
[in]sNameName (optional, z.B. "My tone generator")
Returns
Signal source ID
Note
This function is only locally available, but not for remote connections

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::RemoveSignalSourceSequencerSample ( const std::string &  sSignalSourceID,
const int  iSoundID 
)
pure virtual

Remove sound sample (a sample added for playback can not be reverted)

Parameters
[in]sSignalSourceIDSignal source identifier
[in]iSoundIDSound sample identifier

Implemented in CVANetClientImpl::CNetworkedVACore.

void IVAInterface::RemoveSoundSourceSignalSource ( const int  iID)
inline

Detach signal source from a sound sourve.

Detaches a connected signal source from a sound source. Signal source will not be removed.

Parameters
[in]iIDSound source identifier

Definition at line 1068 of file VAInterface.h.

virtual void IVAInterface::Reset ( )
pure virtual

Full reset of the core. Clears all scene objects, resources, etc.

Clear all scenes, removes sound entities, resets states and medium values

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetAcousticMaterialName ( const int  iID,
const std::string &  sName 
)
pure virtual

Acoustic material name setter.

Parameters
[in]iIDMaterial identifier
[in]sNameVerbatim name

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetAcousticMaterialParameters ( const int  iID,
const CVAStruct oParams 
)
pure virtual

Acoustic material parameter setter.

Parameters
[in]iIDMaterial identifier
[in]oParamsMaterial parameters

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetActiveSoundReceiver ( const int  iSoundReceiverID)
pure virtual

Sets the active sound receiver.

The renderers produce the output of this sound receiver, only (if sound receiver is not explicitly created for another renderer)

Parameters
[in]iSoundReceiverIDSoundReceiver identifier
See also
GetActiveSoundReceiver
SetActiveSoundReceiverExplicitRenderer

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetActiveSoundReceiverExplicitRenderer ( const int  iSoundReceiverID,
const std::string &  sRendererID 
)
pure virtual

Sets the active sound receiver for an explicit renderer.

The renderers forward the output of this sound receiver, only (if sound receiver is not explicitly created for another renderer)

Parameters
[in]iSoundReceiverIDSoundReceiver identifier
[in]sRendererIDRenderer identifier
See also
GetActiveSoundReceiverExplicitRenderer
SetActiveSoundReceiver

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetCoreClock ( const double  dSeconds)
pure virtual

Set core time.

This methods (re)sets the core time to the given value in seconds. The new value must be a number greater or equal zero.

Parameters
[in]dSecondsClock time in seconds

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetDirectivityName ( const int  iID,
const std::string &  sName 
)
pure virtual

Directivity name setter.

Parameters
[in]iIDIdentifier
[in]sNameVersatile name

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetDirectivityParameters ( const int  iID,
const CVAStruct oParams 
)
pure virtual

Directivity parameter setter.

Parameters
[in]iIDIdentifier
[in]oParamsParameters

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetGeometryMeshEnabled ( const int  iID,
const bool  bEnabled = true 
)
pure virtual

Geometry mesh enabled setter.

Parameters
[in]iIDGeometry mesh identifier
[in]bEnabledIf true, sets enabled, if false geo mesh is disabled

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetGeometryMeshName ( const int  iID,
const std::string &  sName 
)
pure virtual

Delete a geometry mesh.

Parameters
[in]iIDGeometry mesh identifier
[in]sNameGeometry mesh verbatim name
Returns
True if mesh could be removed

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetGeometryMeshParameters ( const int  iID,
const CVAStruct oParams 
)
pure virtual

Geometry mesh parameter setter.

Parameters
[in]iIDGeometry mesh identifier
[in]oParamsGeometry mesh magic parameters
Returns
True if mesh could be removed

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetGlobalAuralizationMode ( const int  iAuralizationMode)
pure virtual

Sets the global auralization mode.

Parameters
[in]iAuralizationModeAuralization mode integer (bit-vector)

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetHomogeneousMediumParameters ( const CVAStruct oParams)
pure virtual

Set homogeneous medium special parameters.

Sets any further parameter of the medium, like Chemical constellation, particle density ... Intended to be used for prototyping. Can also be used to define non-homogeneous media by a proprietary definition that is used by a specialized rendering module, e.g. for air traffic noise.

Parameters
[in]oParamsMagic medium parameters

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetHomogeneousMediumRelativeHumidity ( const double  dRelativeHumidityPercent)
pure virtual

Set homogeneous medium relative humidity in percent (0.0 = no vapor, 50.0 = 50%, ... )

Sets the relative humidity of the homogeneous medium. Significant changes to this parameter might cause audible artifacts due to its unphysical background.

Parameters
[in]dRelativeHumidityPercentRelative humidity %

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetHomogeneousMediumShiftSpeed ( const VAVec3 v3TranslationSpeed)
pure virtual

Set homogeneous medium shift speed as 3-dim direction vector in m/s ("wind" speed with direction)

Sets the shift speed of the homogeneous medium ("wind" speed). Significant changes to this parameter might cause audible artifacts due to its unphysical background.

Parameters
[in]v3TranslationSpeedTranslatory speed [m/s]

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetHomogeneousMediumSoundSpeed ( const double  dSoundSpeed)
pure virtual

Set homogeneous medium sound speed in m/s.

Sets the speed of sound of the homogeneous medium. Significant changes to this parameter might cause audible artifacts due to its unphysical background.

Parameters
[in]dSoundSpeedSpeed of sound [m/s]

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetHomogeneousMediumStaticPressure ( const double  dPressurePascal)
pure virtual

Set homogeneous medium static pressure in Pascal.

Sets the static pressure of the homogeneous medium. Significant changes to this parameter might cause audible artifacts due to its unphysical background.

Parameters
[in]dPressurePascalStatic pressure [Pa]

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetHomogeneousMediumTemperature ( const double  dDegreesCentigrade)
pure virtual

Set homogeneous medium temperature in degree Celsius (0 is freezing point of water)

Sets the temperature of the homogeneous medium. Significant changes to this parameter might cause audible artifacts due to its unphysical background.

Parameters
[in]dDegreesCentigradeDegrees Centigrade []

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetInputGain ( const double  dGain)
pure virtual

Sets the global audio interface input gain.

Parameters
[in]dGainGain factor [0 .. 1]
Warning
Setting gains will potentially penetrate a calibrated rendering and reproduction chain

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetInputMuted ( const bool  bMuted = true)
pure virtual

Mutes global audio interface input.

Parameters
[in]bMutedMutes global input if true, unmutes otherwise

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetOutputGain ( const double  dGain)
pure virtual

Sets the global audio interface output gain.

Parameters
[in]dGainGain factor [0 .. 1]
Warning
Setting gains will potentially penetrate a calibrated rendering and reproduction chain

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetOutputMuted ( const bool  bMuted = true)
pure virtual

Sets the global audio interface input gain.

Parameters
[in]bMutedTrue to mute

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetOutputStream ( std::ostream *  posDebug)
pure virtual

Set the output stream for debug messages.

Parameters
[in]posDebugDebug output stream

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetRenderingModuleAuralizationMode ( const std::string &  sModuleID,
const int  iAuralizationMode 
)
pure virtual

Sets the rendering module auralization mode.

Parameters
[in]sModuleIDModule identifier
[in]iAuralizationModeAuralization mode integer

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetRenderingModuleGain ( const std::string &  sModuleID,
const double  dGain 
)
pure virtual

Sets the rendering module audio output gain.

Parameters
[in]sModuleIDModule identifier
[in]dGainGain
Warning
Setting gains will potentially penetrate a calibrated rendering and reproduction chain

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetRenderingModuleMuted ( const std::string &  sModuleID,
const bool  bMuted = true 
)
pure virtual

Mutes/unmutes a rendering module audio output.

Parameters
[in]sModuleIDModule identifier
[in]bMutedMutes module, if true, unmutes otherwise

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetRenderingModuleParameters ( const std::string &  sModuleID,
const CVAStruct oParams 
)
pure virtual

Sets the rendering module parameters.

Parameters
[in]sModuleIDModule identifier
[in]oParamsMagic parameters

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetReproductionModuleGain ( const std::string &  sModuleID,
const double  dGain 
)
pure virtual

Sets the reproduction module audio output gain.

Parameters
[in]sModuleIDModule identifier
[in]dGainGain factor
Warning
Setting gains will potentially penetrate a calibrated rendering and reproduction chain

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetReproductionModuleMuted ( const std::string &  sModuleID,
const bool  bMuted = true 
)
pure virtual

Mutes/unmutes a rendering module audio output.

Parameters
[in]sModuleIDModule identifier
[in]bMutedMutes module, if true, unmutes otherwise

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetReproductionModuleParameters ( const std::string &  sModuleID,
const CVAStruct oParams 
)
pure virtual

Sets the reproduction module parameters.

Parameters
[in]sModuleIDModule identifier
[in]oParamsMagic parameters

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSceneEnabled ( const std::string &  sID,
const bool  bEnabled = true 
)
pure virtual

Set scene enabled or disabled.

Parameters
[in]sIDScene identifier
[in]bEnabledEnabled/disabled flag

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSceneName ( const std::string &  sID,
const std::string &  sName 
)
pure virtual

Set the name of given scene.

Parameters
[in]sIDScene identifier
[in]sNameScene verbatim name

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSignalSourceBufferLooping ( const std::string &  sSignalSourceID,
const bool  bLooping = true 
)
pure virtual

Set playback looping mode (true = looping)

Parameters
[in]sSignalSourceIDSignal source ID
[in]bLoopingPlayback is looping, if set true

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSignalSourceBufferPlaybackAction ( const std::string &  sSignalSourceID,
const int  iPlaybackAction 
)
pure virtual

Set the playback state of an audiofile signal source.

Start, stop or pause the playback of an audiofile using the playback action flags (bit-vector).

Parameters
[in]sSignalSourceIDSignal source identifier
[in]iPlaybackActionPlayback action integer

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSignalSourceBufferPlaybackPosition ( const std::string &  sSignalSourceID,
const double  dPlaybackPosition 
)
pure virtual

Set the playback position of an audiofile signal source.

Parameters
[in]sSignalSourceIDSignal source ID
[in]dPlaybackPositionPlayback position [s]

Implemented in CVANetClientImpl::CNetworkedVACore.

void IVAInterface::SetSignalSourceMachineHaltMachine ( const std::string &  sSignalSourceID)
inline

Halts the signal of a machine source.

Parameters
[in]sSignalSourceIDSignal source ID

Definition at line 761 of file VAInterface.h.

void IVAInterface::SetSignalSourceMachineIdleFile ( const std::string &  sSignalSourceID,
const std::string &  sFilePath 
)
inline

Set idle file sample of machine signal source.

Parameters
[in]sSignalSourceIDSignal source ID
[in]sFilePathPath to audio file

Definition at line 836 of file VAInterface.h.

void IVAInterface::SetSignalSourceMachineSpeed ( const std::string &  sSignalSourceID,
double  dSpeed 
)
inline

Sets the speed of a machine signal source.

Parameters
[in]sSignalSourceIDSignal source ID
[in]dSpeedMachine speed (0 .. not-too-large)

Definition at line 793 of file VAInterface.h.

void IVAInterface::SetSignalSourceMachineStartFile ( const std::string &  sSignalSourceID,
const std::string &  sFilePath 
)
inline

Set start file sample of machine signal source.

Parameters
[in]sSignalSourceIDSignal source ID
[in]sFilePathPath to audio file

Definition at line 823 of file VAInterface.h.

void IVAInterface::SetSignalSourceMachineStartMachine ( const std::string &  sSignalSourceID)
inline

Starts the signal of a machine source.

Parameters
[in]sSignalSourceIDSignal source ID

Definition at line 749 of file VAInterface.h.

void IVAInterface::SetSignalSourceMachineStopFile ( const std::string &  sSignalSourceID,
const std::string &  sFilePath 
)
inline

Set stop file sample of machine signal source.

Parameters
[in]sSignalSourceIDSignal source ID
[in]sFilePathPath to audio file

Definition at line 849 of file VAInterface.h.

virtual void IVAInterface::SetSignalSourceParameters ( const std::string &  sSignalSourceID,
const CVAStruct oParams 
)
pure virtual

Set parameters for a signal source.

This method sets parameters of a signal source. Behavior depends on type and implementation of the referred instance.

Parameters
[in]sSignalSourceIDID of signal source
[in]oParamsParameter structure

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundPortalEnabled ( const int  iID,
const bool  bEnabled = true 
)
pure virtual

Sound portal enabled setter.

Parameters
[in]iIDSound portal identifier
[in]bEnabledEnables sound portal, if true

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundPortalMaterial ( const int  iSoundPortalID,
const int  iMaterialID 
)
pure virtual

Sound portal material setter.

Parameters
[in]iSoundPortalIDSound portal identifier
[in]iMaterialIDAssigned material identifier

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundPortalName ( const int  iID,
const std::string &  sName 
)
pure virtual

Sets the name of a portal.

Parameters
[in]iIDSound portal identifier
[in]sNameVerbatim name

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundPortalNextPortal ( const int  iSoundPortalID,
const int  iNextSoundPortalID 
)
pure virtual

Sound portal next portal setter.

Parameters
[in]iSoundPortalIDSound portal identifier
[in]iNextSoundPortalIDNext connected sound portal identifier

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundPortalOrientation ( const int  iID,
const VAQuat qOrient 
)
pure virtual

Sound portal orientation setter.

Parameters
[in]iIDSound portal identifier
[in]qOrientOrientation quaternion

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundPortalParameters ( const int  iID,
const CVAStruct oParams 
)
pure virtual

Set sound portal parameters.

This general parameter setter can be used for quick solutions changing sound portal parameters without introducing new methods to the main interface.

Parameters
[in]iIDSound portal identifier
[in]oParamsMagic struct with the parameters

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundPortalPosition ( const int  iID,
const VAVec3 vPos 
)
pure virtual

Sound portal position setter.

Parameters
[in]iIDSound portal identifier
[in]vPosPosition vector

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundPortalSoundReceiver ( const int  iSoundPortalID,
const int  iSoundReceiverID 
)
pure virtual

Sound portal target sound receiver setter.

Parameters
[in]iSoundPortalIDSound portal identifier
[in]iSoundReceiverIDConnected sound receiver identifier

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundPortalSoundSource ( const int  iSoundPortalID,
const int  iSoundSourceID 
)
pure virtual

Sound portal sound source setter.

Parameters
[in]iSoundPortalIDSound portal identifier
[in]iSoundSourceIDConnected sound source identifier

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundReceiverAuralizationMode ( const int  iSoundReceiverID,
const int  iAuralizationMode 
)
pure virtual

Sound receiver auralization mode setter.

Parameters
[in]iSoundReceiverIDSound receiver identifier
[in]iAuralizationModeAuralization mode bit-vector

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundReceiverDirectivity ( const int  iSoundReceiverID,
const int  iDirectivityID 
)
pure virtual

Sets the directivity of a sound receiver.

In order to remove an assigned directivity, you can pass -1 to the method.

Parameters
[in]iSoundReceiverIDSound receiver identifier
[in]iDirectivityIDDirectivity identifier

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundReceiverEnabled ( const int  iID,
const bool  bEnabled = true 
)
pure virtual

Enables or disables a virtual sound receiver (removes the sound receiver from audio processing)

Parameters
[in]iIDSound receiver identifier
[in]bEnabledEnable (true) or disable (false) sound source
See also
GetSoundReceiverEnabled()

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundReceiverGeometryMesh ( const int  iSoundReceiverID,
const int  iGeometryMeshID 
)
pure virtual

Sound receiver geo mesh identifier getter.

Sound receivers can have geometrical meshes assigned, i.e. to identify which geometry is part of a sound receiver that should not be considered for direct path occlusion - or if the moving receiver geometry is relevant for occlusion of other source-receivere-paths, like cars, trains, etc.

Parameters
[in]iSoundReceiverIDSound source identifier
[in]iGeometryMeshIDGeo mesh identifier

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundReceiverHeadAboveTorsoOrientation ( const int  iID,
const VAQuat qOrient 
)
pure virtual

Sound receiver head-above-torso orientation setter.

Parameters
[in]iIDSound source identifier
[in]qOrientOrientation quaternion of head-above-torso

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundReceiverName ( const int  iID,
const std::string &  sName 
)
pure virtual

Sound receiver name setter.

Parameters
[in]iIDSound receiver identifier
[in]sNameVerbatim name

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundReceiverOrientation ( const int  iID,
const VAQuat qOrient 
)
pure virtual

Sound source orientation setter.

Parameters
[in]iIDSound source identifier
[in]qOrientOrientation quaternion

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundReceiverOrientationVU ( const int  iID,
const VAVec3 v3View,
const VAVec3 v3Up 
)
pure virtual

Sound source orientation setter using view and up vector.

Uses OpenGL view and up convention.

Parameters
[in]iIDSound source identifier
[in]v3ViewView vector
[in]v3UpUp vector

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundReceiverParameters ( const int  iID,
const CVAStruct oParams 
)
pure virtual

Set sound receiver parameters.

This general parameter setter can be used for quick solutions changing sound receiver parameters without introducing new methods to the main interface.

Parameters
[in]iIDSoundReceiver identifier
[in]oParamsMagic struct with the parameters

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundReceiverPose ( const int  iID,
const VAVec3 v3Pos,
const VAQuat qOrient 
)
pure virtual

Sound source pose setter.

Parameters
[in]iIDSound source identifier
[in]v3PosPosition vector
[in]qOrientOrientation quaternion

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundReceiverPosition ( const int  iID,
const VAVec3 v3Pos 
)
pure virtual

Sound source position setter.

Parameters
[in]iIDSound source identifier
[in]v3PosPosition vector

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundReceiverRealWorldHeadAboveTorsoOrientation ( const int  iID,
const VAQuat qOrient 
)
pure virtual

Sound receiver real-world head-above-torso orientation setter.

A neutral HATO orientation will use the neutral head position looking to the front. A diverging orientation will describe how the head is oriented with respect to the torso (from the viewpoint of torso).

Parameters
[in]iIDSound source identifier
[in]qOrientOrientation quaternion of head-above-torso

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundReceiverRealWorldPose ( const int  iID,
const VAVec3 v3Pos,
const VAQuat qOrient 
)
pure virtual

Updates the pose of the real-world sound receiver's head.

This function is used to provide the crosstalk-cancellation module with the current position of the sound receivers head in the real-world.

Note
Coordinates refer the to center of the head on the axis which goes through both ears.
Parameters
[in]iIDSound receiver identifier
[in]v3PosReal world position of sound receiver
[in]qOrientReal world orientation as quaternion of sound receiver

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundReceiverRealWorldPositionOrientationVU ( const int  iID,
const VAVec3 v3Pos,
const VAVec3 v3View,
const VAVec3 v3Up 
)
pure virtual

Updates the position and orientation of the real-world sound receiver's head.

This function is used to provide the crosstalk-cancellation module with the current position of the sound receivers head in the real-world.

Note
Coordinates refer the to center of the head on the axis which goes through both ears.
Parameters
[in]iIDSound receiver identifier
[in]v3PosReal world position of sound receiver
[in]v3ViewReal world view vector of sound receiver
[in]v3UpReal world up vector of sound receiver

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundSourceAuralizationMode ( const int  iID,
const int  iAuralizationMode 
)
pure virtual

Sound source auralization mode setter.

Set an individual auralization mode for a given sound source.

Parameters
[in]iIDSound source identifier
[in]iAuralizationModeAuralizaion mode bit-vector

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundSourceDirectivity ( const int  iSoundReceiverID,
const int  iDirectivityID 
)
pure virtual

Sets the directivity of a sound source.

In order to remove an assigned directivity, you can pass -1 to the method.

Parameters
[in]iSoundReceiverIDSound source identifier
[in]iDirectivityIDDirectivity identifier

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundSourceEnabled ( const int  iID,
const bool  bEnabled = true 
)
pure virtual

Enables or disables a sound source (removes the sound source from processing within renderers)

Parameters
[in]iIDSound source identifier
[in]bEnabledEnable (true) or disable (false) sound source
See also
GetSoundSourceEnabled()

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundSourceGeometryMesh ( const int  iSoundReceiverID,
const int  iGeometryMeshID 
)
pure virtual

Sound source geo mesh identifier getter.

Sound sources can have geometrical meshes assigned, i.e. to identify which geometry is part of a sound source that should not be considered for direct path occlusion - or if the moving source geometry is relevant for occlusion of other source-receivere-paths, like cars, trains, etc.

Parameters
[in]iSoundReceiverIDSound source identifier
[in]iGeometryMeshIDGeo mesh identifier

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundSourceMuted ( const int  iID,
const bool  bMuted = true 
)
pure virtual

Sound source enabled setter.

Parameters
[in]iIDSound source identifier
[in]bMutedMutes sound source, if true

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundSourceName ( const int  iID,
const std::string &  sName 
)
pure virtual

Sound source name setter.

Parameters
[in]iIDSound source identifier
[in]sNameVerbatim name

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundSourceOrientation ( const int  iID,
const VAQuat qOrient 
)
pure virtual

Sound source orientation setter.

Parameters
[in]iIDSound source identifier
[in]qOrientOrientation quaternion

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundSourceOrientationVU ( const int  iID,
const VAVec3 v3View,
const VAVec3 v3Up 
)
pure virtual

Sound source orientation setter using view and up vector.

Uses OpenGL view and up convention.

Parameters
[in]iIDSound source identifier
[in]v3ViewView vector
[in]v3UpUp vector

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundSourceParameters ( const int  iID,
const CVAStruct oParams 
)
pure virtual

Set sound source parameters.

This general parameter setter can be used for quick solutions changing sound source parameters without introducing new methods to the main interface.

Parameters
[in]iIDSound source identifier
[in]oParamsMagic struct with the parameters

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundSourcePose ( const int  iID,
const VAVec3 v3Pos,
const VAQuat qOrient 
)
pure virtual

Sound source pose setter.

Parameters
[in]iIDSound source identifier
[in]v3PosPosition vector
[in]qOrientOrientation quaternion

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundSourcePosition ( const int  iID,
const VAVec3 v3Pos 
)
pure virtual

Sound source position setter.

Parameters
[in]iIDSound source identifier
[in]v3PosPosition vector

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundSourceSignalSource ( const int  iID,
const std::string &  sSignalSourceID 
)
pure virtual

Attach a signal source to sound source.

Let a sound source play back samples from the given signal source. An empty string removes the signal source from sound source (silence).

See also
RemoveSoundSourceSignalSource
Parameters
[in]iIDSound source identifier
[in]sSignalSourceIDSignal source identifier

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual void IVAInterface::SetSoundSourceSoundPower ( const int  iID,
const double  dSoundPower 
)
pure virtual

Sound receiver sound power setter.

Parameters
[in]iIDSound source identifier
[in]dSoundPowerSound power in Watts [W]

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual std::string IVAInterface::SubstituteMacros ( const std::string &  sStr) const
pure virtual

Substitute VA core macro definitions in a string (e.g. a filename)

Parameters
[in]sStrString with macro
Returns
String where macros have been substituted, if macro has been set

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual int IVAInterface::UnlockUpdate ( )
pure virtual

Ends a synchronized scene modification and applies all changes.

Releases update token. Triggers scene lock and creates identifier.

Returns
State identifier of current scene on success, -1 otherwiese

Implemented in CVANetClientImpl::CNetworkedVACore.

virtual bool IVAInterface::UnregisterSignalSource ( IVAAudioSignalSource pSignalSource)
pure virtual

Unregisters an (external) signal source from the core.

Unregisters an (external) signal source from the core. This is only possible, if the signal source is not in use.

Parameters
[in]pSignalSourceSignal source instance
Returns
true, if the signal source has been unregistered, false otherwise
Note
This function is only locally available, but not remote

Implemented in CVANetClientImpl::CNetworkedVACore.

Member Data Documentation

const int IVAInterface::VA_AURAMODE_ABSORPTION = ( 1 << 12 )
static

Material absorption.

Definition at line 104 of file VAInterface.h.

const int IVAInterface::VA_AURAMODE_ALL
static
const int IVAInterface::VA_AURAMODE_DEFAULT
static
Initial value:

For validation checking, increase for more modes!

Default auralization mode (alias)

Definition at line 108 of file VAInterface.h.

const int IVAInterface::VA_AURAMODE_DIFFRACTION = ( 1 << 7 )
static

Diffraction.

Definition at line 99 of file VAInterface.h.

const int IVAInterface::VA_AURAMODE_DIFFUSE_DECAY = ( 1 << 2 )
static

Diffuse decay.

Definition at line 94 of file VAInterface.h.

const int IVAInterface::VA_AURAMODE_DIRECT_SOUND = ( 1 << 0 )
static

Direct sound.

Definition at line 92 of file VAInterface.h.

const int IVAInterface::VA_AURAMODE_DOPPLER = ( 1 << 9 )
static

Doppler effects.

Definition at line 101 of file VAInterface.h.

const int IVAInterface::VA_AURAMODE_EARLY_REFLECTIONS = ( 1 << 1 )
static

Early reflections.

Definition at line 93 of file VAInterface.h.

const int IVAInterface::VA_AURAMODE_LAST = ( 1 << 13 )
static

Definition at line 105 of file VAInterface.h.

const int IVAInterface::VA_AURAMODE_MEDIUM_ABSORPTION = ( 1 << 4 )
static

Absorption in air.

Definition at line 96 of file VAInterface.h.

const int IVAInterface::VA_AURAMODE_NEARFIELD = ( 1 << 8 )
static

Near-field effects.

Definition at line 100 of file VAInterface.h.

const int IVAInterface::VA_AURAMODE_NOTHING = 0
static

Auralization modes (bit-vector flags)

No auralization

Definition at line 91 of file VAInterface.h.

const int IVAInterface::VA_AURAMODE_SCATTERING = ( 1 << 6 )
static

Scattering.

Definition at line 98 of file VAInterface.h.

const int IVAInterface::VA_AURAMODE_SOURCE_DIRECTIVITY = ( 1 << 3 )
static

Source directivity.

Definition at line 95 of file VAInterface.h.

const int IVAInterface::VA_AURAMODE_SPREADING_LOSS = ( 1 << 10 )
static

Spherical spreading loss.

Definition at line 102 of file VAInterface.h.

const int IVAInterface::VA_AURAMODE_TEMP_VAR = ( 1 << 5 )
static

Atmospheric temporal variations.

Definition at line 97 of file VAInterface.h.

const int IVAInterface::VA_AURAMODE_TRANSMISSION = ( 1 << 11 )
static

Sound transmission.

Definition at line 103 of file VAInterface.h.


The documentation for this class was generated from the following files:
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.