comparison vamp-hostsdk/RequestResponse.h @ 455:5c07a86abddd outputid-string-in-featureset

Make RequestResponse types more consistent by adding plugin to ConfigurationResponse and introducing a FinishRequest

  * SDK, along with the PluginLoader method that returns this structure.
  */
 struct ConfigurationResponse
 {
 public:
-    ConfigurationResponse() // failed by default
-    { }
-
+    ConfigurationResponse() : // failed by default
+        plugin(0) { }
+
+    Plugin *plugin;
     Plugin::OutputList outputs;
 };
 
 /**
  * \class ProcessRequest RequestResponse.h <vamp-hostsdk/RequestResponse.h>

 
     Plugin *plugin;
     Plugin::FeatureSet features;
 };
 
+/**
+ * \class FinishRequest RequestResponse.h <vamp-hostsdk/RequestResponse.h>
+ *
+ * A structure that bundles the necessary data for finishing
+ * processing, i.e. calling getRemainingFeatures(). This consists only
+ * of the plugin pointer. Caller retains ownership of the plugin.
+ *
+ * \see Plugin::getRemainingFeatures()
+ *
+ * \note This class was introduced in version 2.7 of the Vamp plugin
+ * SDK, but it is not currently used by the SDK. It is supplied as a
+ * convenience for code using the SDK, and for symmetry with the load
+ * and configuration request structs.
+ *
+ * \note The response to a finish request (getRemainingFeatures()) is
+ * a ProcessResponse, just as it is for a process request.
+ */
+struct FinishRequest
+{
+public:
+    FinishRequest() : // invalid by default
+        plugin(0) { }
+
+    Plugin *plugin;
+};
+
 }
 
 }
 
 _VAMP_SDK_HOSTSPACE_END(RequestResponse.h)