Mercurial > hg > vamp-plugin-sdk
comparison vamp/vamp.h @ 54:933fee59d33a
* doc updates
author | cannam |
---|---|
date | Fri, 30 Mar 2007 17:14:16 +0000 |
parents | b907557b2fb9 |
children | e841e2365b48 |
comparison
equal
deleted
inserted
replaced
53:74822738965b | 54:933fee59d33a |
---|---|
35 */ | 35 */ |
36 | 36 |
37 #ifndef VAMP_HEADER_INCLUDED | 37 #ifndef VAMP_HEADER_INCLUDED |
38 #define VAMP_HEADER_INCLUDED | 38 #define VAMP_HEADER_INCLUDED |
39 | 39 |
40 /* | 40 #ifdef __cplusplus |
41 extern "C" { | |
42 #endif | |
43 | |
44 /** | |
45 * Plugin API version. This is incremented when a change is made that | |
46 * changes the binary layout of the descriptor records. When this | |
47 * happens, there should be a mechanism for retaining compatibility | |
48 * with older hosts and/or plugins. | |
49 * | |
50 * See also the vampApiVersion field in the plugin descriptor, and the | |
51 * hostApiVersion argument to the vampGetPluginDescriptor function. | |
52 */ | |
53 #define VAMP_API_VERSION 1 | |
54 | |
55 /** | |
41 * C language API for Vamp plugins. | 56 * C language API for Vamp plugins. |
42 * | 57 * |
43 * This is the formal plugin API for Vamp. Plugin authors may prefer | 58 * This is the formal plugin API for Vamp. Plugin authors may prefer |
44 * to use the C++ classes provided in the Vamp plugin SDK, instead of | 59 * to use the C++ classes provided in the Vamp plugin SDK, instead of |
45 * using this API directly. There is an adapter class provided that | 60 * using this API directly. There is an adapter class provided that |
51 * guide to their permitted values and expected usage. Please refer | 66 * guide to their permitted values and expected usage. Please refer |
52 * to the C++ headers in the Vamp plugin SDK for further details and | 67 * to the C++ headers in the Vamp plugin SDK for further details and |
53 * plugin lifecycle documentation. | 68 * plugin lifecycle documentation. |
54 */ | 69 */ |
55 | 70 |
56 #ifdef __cplusplus | |
57 extern "C" { | |
58 #endif | |
59 | |
60 /** | |
61 * Plugin API version. This is incremented when a change is made that | |
62 * changes the binary layout of the descriptor records. When this | |
63 * happens, there should be a mechanism for retaining compatibility | |
64 * with older hosts and/or plugins. | |
65 * | |
66 * See also the vampApiVersion field in the plugin descriptor, and the | |
67 * hostApiVersion argument to the vampGetPluginDescriptor function. | |
68 */ | |
69 #define VAMP_API_VERSION 1 | |
70 | |
71 typedef struct _VampParameterDescriptor | 71 typedef struct _VampParameterDescriptor |
72 { | 72 { |
73 /** Computer-usable name of the parameter. Must not change. [a-zA-Z0-9_] */ | 73 /** Computer-usable name of the parameter. Must not change. [a-zA-Z0-9_] */ |
74 const char *identifier; | 74 const char *identifier; |
75 | 75 |