Interface Structures and Types

Data Structures
struct	FEAPI_SignalDescription_t_tag
struct	FEAPI_ParameterDescription_t_tag
struct	FEAPI_UserData_t_tag
Typedefs
typedef enum FEAPI_MaxStringLengths_t_tag	FEAPI_MaxStringLengths_t
typedef FEAPI_SignalDescription_t_tag	FEAPI_SignalDescription_t
typedef FEAPI_ParameterDescription_t_tag	FEAPI_ParameterDescription_t
typedef FEAPI_UserData_t_tag	FEAPI_UserData_t
typedef void *	FEAPI_PluginInstance_t
typedef double	FEAPI_TimeStamp_t
typedef float	FEAPI_Signal_t
typedef enum FEAPI_Error_t_tag	FEAPI_Error_t
typedef enum FEAPI_VersionInfo_t_tag	FEAPI_VersionInfo_t
typedef enum FEAPI_PluginProperty_t_tag	FEAPI_PluginProperty_t
Enumerations
enum	FEAPI_MaxStringLengths_t_tag { FEAPI_kMaxNameLength = 1024, FEAPI_kMaxUnitLength = 1024, FEAPI_kMaxDescriptionLength = 4096 }
enum	FEAPI_Error_t_tag {   FEAPI_kNoError = 0, FEAPI_kUnspecifiedError = -1, FEAPI_kIndexOutOfRangeError = -2, FEAPI_kInvalidPointerError = -3,   FEAPI_kUnknownError = -9999 }
enum	FEAPI_VersionInfo_t_tag { FEAPI_kMajorVersion = 0, FEAPI_kMinorVersion = 1, FEAPI_kSubVersion = 2 }
enum	FEAPI_PluginProperty_t_tag {   FEAPI_kMinSampleRate = 0, FEAPI_kMaxSampleRate = 1, FEAPI_kMinChannels = 2, FEAPI_kMaxChannels = 3,   FEAPI_kMinFrameSize = 4, FEAPI_kMaxFrameSize = 5, FEAPI_kOptFrameSize = 6 }

---

Typedef Documentation

typedef enum FEAPI_Error_t_tag FEAPI_Error_t

Enumerator for possible error return values, if any other value than FEAPI_kNoError is returned, the function was not able to execute the specified operation(s). All error defines are negative. Todo: add more errors

typedef enum FEAPI_MaxStringLengths_t_tag FEAPI_MaxStringLengths_t

Maximum string lengths in API

typedef struct FEAPI_ParameterDescription_t_tag FEAPI_ParameterDescription_t

Structure describing properties and other information about one parameter.

typedef void* FEAPI_PluginInstance_t

Typedef for the plugin instance handle. Definition at line 175 of file FEAPI.h.

typedef enum FEAPI_PluginProperty_t_tag FEAPI_PluginProperty_t

Enumerator for retrieval of information about what the plug supports.

typedef float FEAPI_Signal_t

This typedef is used for input and output data. At least for this version of the API, this is exactly float. Definition at line 185 of file FEAPI.h.

typedef struct FEAPI_SignalDescription_t_tag FEAPI_SignalDescription_t

Structure describing properties and other information about one result/feature.

typedef double FEAPI_TimeStamp_t

This typedef is used for time stamps in seconds. For a block of data, the time stamp is defined to be the time at the beginning of the block. Definition at line 180 of file FEAPI.h.

typedef struct FEAPI_UserData_t_tag FEAPI_UserData_t

Structure for user/vendor defined commands.

typedef enum FEAPI_VersionInfo_t_tag FEAPI_VersionInfo_t

Enumerator for retrieval of version info which can be resolved as major.minor.sub.

---

Enumeration Type Documentation

enum FEAPI_Error_t_tag

Enumerator for possible error return values, if any other value than FEAPI_kNoError is returned, the function was not able to execute the specified operation(s). All error defines are negative. Todo: add more errors Enumeration values: FEAPI_kNoError  no error occurred FEAPI_kUnspecifiedError  an error occurred, but the type is not yet specified FEAPI_kIndexOutOfRangeError  an out of range index has been passed to the function FEAPI_kInvalidPointerError  an invalid (null) pointer has been passed to the funtion FEAPI_kUnknownError  an error occurred, but its type is not specifyable Definition at line 192 of file FEAPI.h.

enum FEAPI_MaxStringLengths_t_tag

Maximum string lengths in API Enumeration values: FEAPI_kMaxNameLength  maximum number of characters for a name string (including null terminator) FEAPI_kMaxUnitLength  maximum number of characters for a unit string (including null terminator) FEAPI_kMaxDescriptionLength  maximum number of characters for a description string (including null terminator) Definition at line 131 of file FEAPI.h.

enum FEAPI_PluginProperty_t_tag

Enumerator for retrieval of information about what the plug supports. Enumeration values: FEAPI_kMinSampleRate  indicates the minimum sample rate FEAPI_kMaxSampleRate  indicates the maximum sample rate FEAPI_kMinChannels  indicates minimum number of channels FEAPI_kMaxChannels  indicates maximum number of channels FEAPI_kMinFrameSize  indicates minimum number of frames per process call FEAPI_kMaxFrameSize  indicates maximum number of frames per process call FEAPI_kOptFrameSize  indicates optimal number of frames per process call Definition at line 212 of file FEAPI.h.

enum FEAPI_VersionInfo_t_tag

Enumerator for retrieval of version info which can be resolved as major.minor.sub. Enumeration values: FEAPI_kMajorVersion  indicates the major version FEAPI_kMinorVersion  indicates the minor version FEAPI_kSubVersion  indicates the sub version or bug-fix version Definition at line 203 of file FEAPI.h.

---