Mercurial > hg > vamp-plugin-sdk
comparison vamp-hostsdk/PluginConfiguration.h @ 428:4912b698f3f7 vampipe
Configuration request/response structs
author | Chris Cannam |
---|---|
date | Tue, 17 May 2016 13:52:51 +0100 |
parents | 8c45dee08a95 |
children | fbdb06ce1e9a |
comparison
equal
deleted
inserted
replaced
427:56a23abf8283 | 428:4912b698f3f7 |
---|---|
36 | 36 |
37 #ifndef VAMP_PLUGIN_CONFIGURATION_H | 37 #ifndef VAMP_PLUGIN_CONFIGURATION_H |
38 #define VAMP_PLUGIN_CONFIGURATION_H | 38 #define VAMP_PLUGIN_CONFIGURATION_H |
39 | 39 |
40 #include "hostguard.h" | 40 #include "hostguard.h" |
41 | |
42 #include "Plugin.h" | |
41 | 43 |
42 #include <map> | 44 #include <map> |
43 #include <string> | 45 #include <string> |
44 | 46 |
45 _VAMP_SDK_HOSTSPACE_BEGIN(PluginConfiguration.h) | 47 _VAMP_SDK_HOSTSPACE_BEGIN(PluginConfiguration.h) |
100 | 102 |
101 return c; | 103 return c; |
102 } | 104 } |
103 }; | 105 }; |
104 | 106 |
107 /** | |
108 * \class ConfigurationRequest PluginConfiguration.h <vamp-hostsdk/PluginConfiguration.h> | |
109 * | |
110 * A wrapper for a plugin pointer and PluginConfiguration, bundling up | |
111 * the data needed to configure a plugin after it has been loaded. | |
112 * | |
113 * \see PluginConfiguration, ConfigurationResponse, LoadRequest, LoadResponse | |
114 */ | |
115 struct ConfigurationRequest | |
116 { | |
117 public: | |
118 ConfigurationRequest() : // invalid request by default | |
119 plugin(0) { } | |
120 | |
121 Plugin *plugin; | |
122 PluginConfiguration configuration; | |
123 }; | |
124 | |
125 /** | |
126 * \class ConfigurationResponse PluginConfiguration.h <vamp-hostsdk/PluginConfiguration.h> | |
127 * | |
128 * The return value from a configuration request (i.e. setting the | |
129 * parameters and initialising the plugin). If the configuration was | |
130 * successful, the output list will contain the final | |
131 * post-initialisation output descriptors. If configuration failed, | |
132 * the output list will be empty. | |
133 * | |
134 * \see PluginConfiguration, ConfigurationRequest, LoadRequest, LoadResponse | |
135 */ | |
136 struct ConfigurationResponse | |
137 { | |
138 public: | |
139 ConfigurationResponse() // failed by default | |
140 { } | |
141 | |
142 Plugin::OutputList outputs; | |
143 }; | |
144 | |
105 } | 145 } |
106 | 146 |
107 } | 147 } |
108 | 148 |
109 _VAMP_SDK_HOSTSPACE_END(PluginConfiguration.h) | 149 _VAMP_SDK_HOSTSPACE_END(PluginConfiguration.h) |