Mercurial > hg > vamp-plugin-sdk
comparison vamp-hostsdk/LoadRequest.h @ 425:6b2567f365b0 vampipe
Docs
author | Chris Cannam |
---|---|
date | Thu, 12 May 2016 14:43:10 +0100 |
parents | 8c45dee08a95 |
children | 5502a06537f6 |
comparison
equal
deleted
inserted
replaced
424:abdf03252c8a | 425:6b2567f365b0 |
---|---|
70 struct LoadRequest | 70 struct LoadRequest |
71 { | 71 { |
72 LoadRequest() : // invalid request by default | 72 LoadRequest() : // invalid request by default |
73 inputSampleRate(0.f), | 73 inputSampleRate(0.f), |
74 adapterFlags(0) { } | 74 adapterFlags(0) { } |
75 | 75 |
76 std::string pluginKey; //!!! separate out key from PluginLoader?? | 76 /** |
77 * PluginKey is a string type that is used to identify a plugin | |
78 * uniquely within the scope of "the current system". For further | |
79 * details \see PluginLoader::PluginKey. | |
80 */ | |
81 typedef std::string PluginKey; | |
82 | |
83 /** | |
84 * The identifying key for the plugin to be loaded. | |
85 */ | |
86 PluginKey pluginKey; | |
87 | |
88 /** | |
89 * Sample rate to be passed to the plugin's constructor. | |
90 */ | |
77 float inputSampleRate; | 91 float inputSampleRate; |
78 int adapterFlags; //!!! from PluginLoader::AdapterFlags, but how best to handle? | 92 |
93 /** | |
94 * A bitwise OR of the values in the PluginLoader::AdapterFlags | |
95 * enumeration, indicating under which circumstances an adapter | |
96 * should be used to wrap the original plugin. If adapterFlags is | |
97 * 0, no optional adapters will be used. | |
98 * | |
99 * \see PluginLoader::AdapterFlags, PluginLoader::loadPlugin | |
100 */ | |
101 int adapterFlags; | |
79 }; | 102 }; |
80 | 103 |
81 /** | 104 /** |
82 * \class LoadResponse LoadResponse.h <vamp-hostsdk/LoadResponse.h> | 105 * \class LoadResponse LoadResponse.h <vamp-hostsdk/LoadResponse.h> |
83 * | 106 * |
98 */ | 121 */ |
99 struct LoadResponse | 122 struct LoadResponse |
100 { | 123 { |
101 LoadResponse() : // invalid (failed) response by default | 124 LoadResponse() : // invalid (failed) response by default |
102 plugin(0) { } | 125 plugin(0) { } |
103 | 126 |
127 /** | |
128 * A pointer to the loaded plugin, or 0 if loading failed. Caller | |
129 * takes ownership of the plugin and must delete it after use. | |
130 */ | |
104 Plugin *plugin; | 131 Plugin *plugin; |
132 | |
133 /** | |
134 * The static data associated with the loaded plugin, that is, all | |
135 * information about it that does not depend on its configuration | |
136 * (parameters, programs, initialisation parameters). The contents | |
137 * of this structure are only valid if plugin is non-0. | |
138 */ | |
105 PluginStaticData staticData; | 139 PluginStaticData staticData; |
140 | |
141 /** | |
142 * The default configuration for this plugin, that is, default | |
143 * values for parameters etc. The contents of this structure are | |
144 * only valid if plugin is non-0. | |
145 */ | |
106 PluginConfiguration defaultConfiguration; | 146 PluginConfiguration defaultConfiguration; |
107 }; | 147 }; |
108 | 148 |
109 } | 149 } |
110 | 150 |