Adding signal source prototype from parameters interface call

parent f803842e
......@@ -50,6 +50,7 @@ public:
VA_SS_ENGINE, //!< Sound source is an engine
VA_SS_MACHINE, //!< Sound source is a machine
VA_SS_TEXT_TO_SPEECH, //!< Text-to-speech signal source
VA_SS_JETENGINE, //!< Sound source is a jet engine
};
//! Destructor.
......
......@@ -597,13 +597,29 @@ public:
/**
* 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.
*
*
* @param[in] oParams Buffer signal source magic parameters
* @param[in] sName Name (optional, e.g. "Prototype Trumpet")
*
*
* @return Signal source ID
*/
virtual std::string CreateSignalSourceBufferFromParameters( const CVAStruct& oParams, const std::string& sName = "" ) = 0;
//! Creates a prototype signal source from parameters
/**
* Creates a prototype signal source which generates samples. Which class is instantiated is depending on the given class
* parameter and the currently available core feature set. This prototype function is used to provide a generic interface call
* so no API changes are required during rapid prototyping.
*
* Usually, the "class" key corresponds to a certain implementation of a prototype, e.g. jet_engine, car_engine, train_engine.
* The parameters may be controlled by the SetSignalSourceParameter and obtained via GetSignalSourceParameters.
*
* @param[in] oParams Set of magic parameters, must include a "class" key
* @param[in] sName Name (optional, e.g. "Prototype generator exhaust")
*
* @return Signal source ID
*/
virtual std::string CreateSignalSourcePrototypeFromParameters( const CVAStruct& oParams, const std::string& sName = "" ) = 0;
//! Creates a text-to-speech (TTS) signal source
/**
......
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