Mercurial > hg > vamp-plugin-sdk
diff vamp-hostsdk/RequestResponse.h @ 430:fbdb06ce1e9a vampipe
Move ConfigurationRequest/Response into RequestResponse.h
author | Chris Cannam |
---|---|
date | Wed, 18 May 2016 10:35:13 +0100 |
parents | 9c25e2289faa |
children | 2819b5c9a395 |
line wrap: on
line diff
--- a/vamp-hostsdk/RequestResponse.h Wed May 18 10:33:08 2016 +0100 +++ b/vamp-hostsdk/RequestResponse.h Wed May 18 10:35:13 2016 +0100 @@ -34,8 +34,8 @@ authorization. */ -#ifndef VAMP_LOAD_REQUEST_H -#define VAMP_LOAD_REQUEST_H +#ifndef VAMP_REQUEST_RESPONSE_H +#define VAMP_REQUEST_RESPONSE_H #include "PluginStaticData.h" #include "PluginConfiguration.h" @@ -148,6 +148,44 @@ PluginConfiguration defaultConfiguration; }; +/** + * \class ConfigurationRequest RequestResponse.h <vamp-hostsdk/RequestResponse.h> + * + * A wrapper for a plugin pointer and PluginConfiguration, bundling up + * the data needed to configure a plugin after it has been loaded. + * + * \see PluginConfiguration, ConfigurationResponse, LoadRequest, LoadResponse + */ +struct ConfigurationRequest +{ +public: + ConfigurationRequest() : // invalid request by default + plugin(0) { } + + Plugin *plugin; + PluginConfiguration configuration; +}; + +/** + * \class ConfigurationResponse RequestResponse.h <vamp-hostsdk/RequestResponse.h> + * + * The return value from a configuration request (i.e. setting the + * parameters and initialising the plugin). If the configuration was + * successful, the output list will contain the final + * post-initialisation output descriptors. If configuration failed, + * the output list will be empty. + * + * \see PluginConfiguration, ConfigurationRequest, LoadRequest, LoadResponse + */ +struct ConfigurationResponse +{ +public: + ConfigurationResponse() // failed by default + { } + + Plugin::OutputList outputs; +}; + } }