More doxy comments

parent 7f679831
......@@ -1211,46 +1211,51 @@ public:
//! Returns all sound receiver IDs
/**
* @param[out] viIDs Sound receiver identifier vector
*/
virtual void GetSoundReceiverIDs( std::vector< int >& viIDs ) const = 0;
//! Creates a sound receiver
/**
* This method creates a new sound receiver (sound receiver).
*
* @param[in] sName Name (optional)
*
* @return ID of the new sound receiver, if the method succeeded, -1, otherwise
*/
* This method creates a new sound receiver (sound receiver).
*
* @param[in] sName Name (optional)
*
* @return ID of the new sound receiver, if the method succeeded, -1, otherwise
*/
virtual int CreateSoundReceiver( const std::string& sName = "" ) = 0;
//! Creates a sound receiver explicitly for a given renderer
/**
* This method creates a new sound receiver for a special renderer, only.
* the sound receiver will be skipped by all other renderers. See
* GetRendererLister() for a list of all available renderer identifier.
*
* @param[in] sName Name
* @param[in] sRendererID Renderer identifier
*
* @return ID of the new sound receiver, if the method succeeded and -1, otherwise
*/
* This method creates a new sound receiver for a given renderer, only.
* the sound receiver will be skipped by all other renderers.
*
* @param[in] sRendererID Renderer identifier
* @param[in] sName Name
*
* @return ID of the new sound receiver, if the method succeeded and -1, otherwise
*/
virtual int CreateSoundReceiverExplicitRenderer( const std::string& sRendererID, const std::string& sName = "" ) = 0;
//! Hörer entfernen
//! Removes a sound receiver
/**
* Diese Methode entfernt einen Hörer aus der Szene.
* Wichtig: Der aktive Hörer kann nicht gelöscht werden.
*
* @return 0 falls der Hörer entfernt wurde,
* -1 im Fehlerfall
*/
* Will fail if sound receiver is an active listener.
*
* @return 0 on success, -1 otherwise
*/
virtual int DeleteSoundReceiver( const int iID ) = 0;
virtual CVASoundReceiverInfo GetSoundReceiverInfo( const int iID ) const = 0;
//! Sound receiver info getter
/**
* @param[in] Sound receiver identifier
*@return Sound receiver info
*/
virtual CVASoundReceiverInfo GetSoundReceiverInfo( const int iID ) const = 0;
//! Enables or disables a virtual sound receiver (removes the sound receiver from audio processing)
/**
* @param[in] iID SoundReceiver identifier
* @param[in] iID Sound receiver identifier
* @param[in] bEnabled Enable (true) or disable (false) sound source
*
* @sa GetSoundReceiverEnabled()
......@@ -1266,19 +1271,32 @@ public:
*/
virtual bool GetSoundReceiverEnabled( const int iID ) const = 0;
//! Name eines Hörers zurückgeben
//! Sound receiver name getter
/**
* @param[in] iID Sound receiver identifier
* @return Verbatim name
*/
virtual std::string GetSoundReceiverName( const int iID ) const = 0;
//! Name eines Hörers setzen
//! Sound receiver name setter
/**
* @param[in] iID Sound receiver identifier
* @param[in] sName Verbatim name
*/
virtual void SetSoundReceiverName( const int iID, const std::string& sName ) = 0;
//! Auralisierungsmodus eines Hörers zurückgeben (Bitvektor)
//! Sound receiver auralization mode getter
/**
* @param[in] iID Sound receiver identifier
* @return Auralization mode bit-vector
*/
virtual int GetSoundReceiverAuralizationMode( const int iID ) const = 0;
//! Auralisierungsmodus eines Hörers setzen (Bitvektor)
//! Sound receiver auralization mode setter
/**
* Mit dieser Methode wird der Auralisierungsmodus für eines Hörers festgelegt.
*/
* @param[in] iID Sound receiver identifier
* @param[in] iAuralizationMode Auralization mode bit-vector
*/
virtual void SetSoundReceiverAuralizationMode( const int iSoundReceiverID, const int iAuralizationMode ) = 0;
//! Set sound receiver parameters
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment