Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

API function pointers


Typedefs

typedef FEAPI_Error_t(* FEAPI_CreatePluginInstance_t )(FEAPI_PluginInstance_t *phInstanceHandle)
typedef FEAPI_Error_t(* FEAPI_DestroyPluginInstance_t )(FEAPI_PluginInstance_t *phInstanceHandle)
typedef FEAPI_Error_t(* FEAPI_InitializePlugin_t )(FEAPI_PluginInstance_t hInstanceHandle, float fInputSampleRate, int iNumberOfAudioChannels, int iHostApiMajorVersion, FEAPI_UserData_t *pstUserData)
typedef unsigned int(* FEAPI_GetPluginAPIVersion_t )(FEAPI_VersionInfo_t eAPIMajorMinorOrSubVersion)
typedef FEAPI_Error_t(* FEAPI_GetPluginName_t )(FEAPI_PluginInstance_t hInstanceHandle, char *pcPluginName)
typedef FEAPI_Error_t(* FEAPI_GetPluginVendor_t )(FEAPI_PluginInstance_t hInstanceHandle, char *pcPluginVendor)
typedef float(* FEAPI_GetPluginProperty_t )(FEAPI_PluginInstance_t hInstanceHandle, FEAPI_PluginProperty_t ePluginProperty)
typedef FEAPI_Error_t(* FEAPI_GetPluginId_t )(FEAPI_PluginInstance_t hInstanceHandle, char *pcPluginId)
typedef unsigned int(* FEAPI_GetPluginVendorVersion_t )(FEAPI_PluginInstance_t hInstanceHandle, FEAPI_VersionInfo_t ePluginMajorMinorOrSubVersion)
typedef FEAPI_Error_t(* FEAPI_GetPluginDescription_t )(FEAPI_PluginInstance_t hInstanceHandle, char *pcPluginDescription)
typedef FEAPI_Error_t(* FEAPI_GetPluginCopyright_t )(FEAPI_PluginInstance_t hInstanceHandle, char *pcPluginCopyright)
typedef unsigned int(* FEAPI_GetPluginNumOfInputs_t )(FEAPI_PluginInstance_t hInstanceHandle)
typedef FEAPI_Error_t(* FEAPI_GetPluginInputDescription_t )(FEAPI_PluginInstance_t hInstanceHandle, int iInputIndex, FEAPI_SignalDescription_t *pstInputDescription)
typedef unsigned int(* FEAPI_GetPluginNumOfParameters_t )(FEAPI_PluginInstance_t hInstanceHandle)
typedef FEAPI_Error_t(* FEAPI_GetPluginParameterDescription_t )(FEAPI_PluginInstance_t hInstanceHandle, int iParameterIndex, FEAPI_ParameterDescription_t *pstParameterDescription)
typedef FEAPI_Error_t(* FEAPI_SetPluginParameter_t )(FEAPI_PluginInstance_t hInstanceHandle, int iParameterIndex, float fValue)
typedef float(* FEAPI_GetPluginParameter_t )(FEAPI_PluginInstance_t hInstanceHandle, int iParameterIndex)
typedef FEAPI_Error_t(* FEAPI_ProcessPlugin_t )(FEAPI_PluginInstance_t hInstanceHandle, const FEAPI_Signal_t **ppfInputBuffer, const FEAPI_TimeStamp_t *ptFEAPI_TimeStamp, int iNumberOfFrames)
typedef FEAPI_Error_t(* FEAPI_ProcessPluginDone_t )(FEAPI_PluginInstance_t hInstanceHandle)
typedef unsigned int(* FEAPI_GetPluginNumOfResults_t )(FEAPI_PluginInstance_t hInstanceHandle)
typedef FEAPI_Error_t(* FEAPI_GetPluginResultDescription_t )(FEAPI_PluginInstance_t hInstanceHandle, int iResultIndex, FEAPI_SignalDescription_t *pstResultDescription)
typedef int(* FEAPI_GetPluginSizeOfResult_t )(FEAPI_PluginInstance_t hInstanceHandle, int iResultIndex)
typedef FEAPI_Error_t(* FEAPI_GetPluginResult_t )(FEAPI_PluginInstance_t hInstanceHandle, int iResultIndex, FEAPI_Signal_t *pfResult, FEAPI_TimeStamp_t *ptFEAPI_TimeStamp)
typedef int(* FEAPI_GetPluginResultLatency_t )(FEAPI_PluginInstance_t hInstanceHandle, int iResultIndex)
typedef FEAPI_Error_t(* FEAPI_ResetPlugin_t )(FEAPI_PluginInstance_t hInstanceHandle)


Typedef Documentation

typedef FEAPI_Error_t(* FEAPI_CreatePluginInstance_t)(FEAPI_PluginInstance_t *phInstanceHandle)
 

Creates a new instance of the plugin. Note that this function is not intended to implement any time-consuming or heavy-weight stuff like memory allocation; this has to be done in FEAPI_InitializePlugin_t.

Parameters:
phInstanceHandle : handle to the instance to be created
Returns:
FEAPI_Error_t : FEAPI_kNoError when no error

Definition at line 239 of file FEAPI.h.

typedef FEAPI_Error_t(* FEAPI_DestroyPluginInstance_t)(FEAPI_PluginInstance_t *phInstanceHandle)
 

Destroys an instance of the plugin.

Parameters:
phInstanceHandle : handle to the instance to be destroyed
Returns:
FEAPI_Error_t : FEAPI_kNoError when no error

Definition at line 247 of file FEAPI.h.

typedef unsigned int(* FEAPI_GetPluginAPIVersion_t)(FEAPI_VersionInfo_t eAPIMajorMinorOrSubVersion)
 

Gets the version number (major, minor or subversion) of the API used by the plugin. This is *not* the plugin version, therefore the function may be called without a previously created instance.

Parameters:
eAPIMajorMinorOrSubVersion : flag to indicate which version type is requested
Returns:
unsigned int : requested version number

Definition at line 276 of file FEAPI.h.

typedef FEAPI_Error_t(* FEAPI_GetPluginCopyright_t)(FEAPI_PluginInstance_t hInstanceHandle, char *pcPluginCopyright)
 

Gets the copyright information for the plugin.

Parameters:
hInstanceHandle : handle to instance
*pcPluginCopyright : pointer to buffer of FEAPI_kMaxDescriptionLength chars, the plugin copyright information will be copied to this buffer
Returns:
FEAPI_Error_t : FEAPI_kNoError when no error

Definition at line 346 of file FEAPI.h.

typedef FEAPI_Error_t(* FEAPI_GetPluginDescription_t)(FEAPI_PluginInstance_t hInstanceHandle, char *pcPluginDescription)
 

Gets the description of the plugin, containing information about what the plugin actually does.

Parameters:
hInstanceHandle : handle to instance
*pcPluginDescription : pointer to buffer of FEAPI_kMaxDescriptionLength chars, the plugin description will be copied to this buffer
Returns:
FEAPI_Error_t : FEAPI_kNoError when no error

Definition at line 336 of file FEAPI.h.

typedef FEAPI_Error_t(* FEAPI_GetPluginId_t)(FEAPI_PluginInstance_t hInstanceHandle, char *pcPluginId)
 

Gets the (vendor unique) plugin identification string.

Parameters:
hInstanceHandle : handle to instance
*pcPluginId : pointer to buffer of FEAPI_kMaxNameLength chars, the id will be copied to this buffer
Returns:
FEAPI_Error_t : FEAPI_kNoError when no error

Definition at line 316 of file FEAPI.h.

typedef FEAPI_Error_t(* FEAPI_GetPluginInputDescription_t)(FEAPI_PluginInstance_t hInstanceHandle, int iInputIndex, FEAPI_SignalDescription_t *pstInputDescription)
 

Gets information about one of the possible inputs.

Parameters:
hInstanceHandle : handle to instance
iInputIndex : index of the input the description is requested for, index ranges from 0...NumOfInputs-1
*pstInputDescription : the requested description will be copied to this structure
Returns:
FEAPI_Error_t : FEAPI_kNoError when no error

Definition at line 368 of file FEAPI.h.

typedef FEAPI_Error_t(* FEAPI_GetPluginName_t)(FEAPI_PluginInstance_t hInstanceHandle, char *pcPluginName)
 

Gets the name of the plugin.

Parameters:
hInstanceHandle : handle to instance
*pcPluginName : pointer to buffer of FEAPI_kMaxNameLength chars, the name will be copied to this buffer
Returns:
FEAPI_Error_t : FEAPI_kNoError when no error

Definition at line 286 of file FEAPI.h.

typedef unsigned int(* FEAPI_GetPluginNumOfInputs_t)(FEAPI_PluginInstance_t hInstanceHandle)
 

Gets the number of inputs for the plugin. This number will equal the number of audio channels in many cases, otherwise exceed the number of audio channels. The additional input channels are plugin developer specific and not recommended. If used, they have to be routed host internally.

Parameters:
hInstanceHandle : handle to instance
Returns:
unsigned int : number of inputs

Definition at line 358 of file FEAPI.h.

typedef unsigned int(* FEAPI_GetPluginNumOfParameters_t)(FEAPI_PluginInstance_t hInstanceHandle)
 

Gets the number of parameters.

Parameters:
hInstanceHandle : handle to instance
Returns:
unsigned int : number of parameters

Definition at line 378 of file FEAPI.h.

typedef unsigned int(* FEAPI_GetPluginNumOfResults_t)(FEAPI_PluginInstance_t hInstanceHandle)
 

Returns the number of results/features to be calculated. One result/feature can be a scalar or n-dimensional.

Parameters:
hInstanceHandle : handle to instance
Returns:
int : number of results

Definition at line 442 of file FEAPI.h.

typedef float(* FEAPI_GetPluginParameter_t)(FEAPI_PluginInstance_t hInstanceHandle, int iParameterIndex)
 

Gets the current value of a parameter.

Parameters:
hInstanceHandle : handle to instance
iParameterIndex : index of the parameter (setting) requested, index ranges from 0...NumOfParameters-1
Returns:
float : value of the parameter with index iParameterIndex

Definition at line 411 of file FEAPI.h.

typedef FEAPI_Error_t(* FEAPI_GetPluginParameterDescription_t)(FEAPI_PluginInstance_t hInstanceHandle, int iParameterIndex, FEAPI_ParameterDescription_t *pstParameterDescription)
 

Gets information about one of the possible parameters.

Parameters:
hInstanceHandle : handle to instance
iParameterIndex : index of the parameter (setting) the description is requested for, index ranges from 0...NumOfParameters-1
*pstParameterDescription : the requested description will be copied to this structure
Returns:
FEAPI_Error_t : FEAPI_kNoError when no error

Definition at line 388 of file FEAPI.h.

typedef float(* FEAPI_GetPluginProperty_t)(FEAPI_PluginInstance_t hInstanceHandle, FEAPI_PluginProperty_t ePluginProperty)
 

Gets an indication of the plugins capabilities.

Parameters:
hInstanceHandle : handle to instance
ePluginProperty : requested property
Returns:
float : corresponding value

Definition at line 306 of file FEAPI.h.

typedef FEAPI_Error_t(* FEAPI_GetPluginResult_t)(FEAPI_PluginInstance_t hInstanceHandle, int iResultIndex, FEAPI_Signal_t *pfResult, FEAPI_TimeStamp_t *ptFEAPI_TimeStamp)
 

Gets one result.

Parameters:
hInstanceHandle : handle to instance
iResultIndex : index of the requested result/feature, index ranges from 0...NumOfResults-1
*pfResult : the result data is copied into this buffer
*ptFEAPI_TimeStamp : the time stamp of the result
Returns:
FEAPI_Error_t : FEAPI_kNoError when no error

Definition at line 475 of file FEAPI.h.

typedef FEAPI_Error_t(* FEAPI_GetPluginResultDescription_t)(FEAPI_PluginInstance_t hInstanceHandle, int iResultIndex, FEAPI_SignalDescription_t *pstResultDescription)
 

Gets information about one of the possible results/features.

Parameters:
hInstanceHandle : handle to instance
iResultIndex : index of the result (feature) the description is requested for, index ranges from 0...NumOfResults-1
*pstResultDescription : the requested description will be copied to this structure
Returns:
FEAPI_Error_t : FEAPI_kNoError when no error

Definition at line 452 of file FEAPI.h.

typedef int(* FEAPI_GetPluginResultLatency_t)(FEAPI_PluginInstance_t hInstanceHandle, int iResultIndex)
 

Gets the maximum latency of one result. Since the host buffer size may vary, this is only the *internal* latency.

Parameters:
hInstanceHandle : handle to instance
iResultIndex : index of the requested result (feature), index ranges from 0...NumOfResults-1
Returns:
int : number of samples (at audio input sample rate) which is required to calculate this result the first time (negative values are not allowed, 0 means undefined)

Definition at line 488 of file FEAPI.h.

typedef int(* FEAPI_GetPluginSizeOfResult_t)(FEAPI_PluginInstance_t hInstanceHandle, int iResultIndex)
 

Gets the size of one result in FEAPI_Signal_t values (4 bytes per value).

Parameters:
hInstanceHandle : handle to instance
iResultIndex : index of the result/feature the size is requested for, index ranges from 0...NumOfResults-1
Returns:
int : size of result in FEAPI_Signal_t values (4 bytes per value). If the result/feature is a scalar, the return value is *always* 1.

Definition at line 463 of file FEAPI.h.

typedef FEAPI_Error_t(* FEAPI_GetPluginVendor_t)(FEAPI_PluginInstance_t hInstanceHandle, char *pcPluginVendor)
 

Gets the vendor name of the plugin.

Parameters:
hInstanceHandle : handle to instance
*pcPluginVendor : pointer to buffer of FEAPI_kMaxNameLength chars, the vendor name will be copied to this buffer
Returns:
FEAPI_Error_t : FEAPI_kNoError when no error

Definition at line 296 of file FEAPI.h.

typedef unsigned int(* FEAPI_GetPluginVendorVersion_t)(FEAPI_PluginInstance_t hInstanceHandle, FEAPI_VersionInfo_t ePluginMajorMinorOrSubVersion)
 

Gets the vendor version of the plugin.

Parameters:
hInstanceHandle : handle to instance
ePluginMajorMinorOrSubVersion : flag which version type is requested
Returns:
unsigned int : requested version number

Definition at line 326 of file FEAPI.h.

typedef FEAPI_Error_t(* FEAPI_InitializePlugin_t)(FEAPI_PluginInstance_t hInstanceHandle, float fInputSampleRate, int iNumberOfAudioChannels, int iHostApiMajorVersion, FEAPI_UserData_t *pstUserData)
 

Initializes a new instance of the plugin, has to be called before processing and after changing a non-realtime parameter

Parameters:
hInstanceHandle : handle to the instance
fInputSampleRate : sample rate of input(s) in Hz
iNumberOfAudioChannels : number of input audio channels
iHostApiMajorVersion : major version number of *host*
pstUserData : pointer to user/vendor defined data (may be NULL)
Returns:
FEAPI_Error_t : FEAPI_kNoError when no error

Definition at line 261 of file FEAPI.h.

typedef FEAPI_Error_t(* FEAPI_ProcessPlugin_t)(FEAPI_PluginInstance_t hInstanceHandle, const FEAPI_Signal_t **ppfInputBuffer, const FEAPI_TimeStamp_t *ptFEAPI_TimeStamp, int iNumberOfFrames)
 

Processes a block of audio data.

Parameters:
hInstanceHandle : handle to instance
**ppfInputBuffer : input audio data in the format [channels][samples]; audio samples have a range from -1.0...+1.0
*ptFEAPI_TimeStamp : time stamps in seconds for every input, may be NULL
iNumberOfFrames : number of frames in ppfInputBuffer
Returns:
FEAPI_Error_t : FEAPI_kNoError when no error

Definition at line 423 of file FEAPI.h.

typedef FEAPI_Error_t(* FEAPI_ProcessPluginDone_t)(FEAPI_PluginInstance_t hInstanceHandle)
 

Signals that no more input data is available (does the final processing).

Parameters:
hInstanceHandle : handle to instance
Returns:
FEAPI_Error_t : FEAPI_kNoError when no error

Definition at line 434 of file FEAPI.h.

typedef FEAPI_Error_t(* FEAPI_ResetPlugin_t)(FEAPI_PluginInstance_t hInstanceHandle)
 

Resets/clears all internal buffers and states, so that the plugin is in a state where it can start processing a new audio stream.

Parameters:
hInstanceHandle : handle to instance
Returns:
FEAPI_Error_t : FEAPI_kNoError when no error

Definition at line 496 of file FEAPI.h.

typedef FEAPI_Error_t(* FEAPI_SetPluginParameter_t)(FEAPI_PluginInstance_t hInstanceHandle, int iParameterIndex, float fValue)
 

Sets a parameter to a specified value.

Parameters:
hInstanceHandle : handle to instance
iParameterIndex : index of the parameter (setting) to be changed, index ranges from 0...NumOfParameters-1
fValue : new value of the parameter
Returns:
FEAPI_Error_t : FEAPI_kNoError when no error

Definition at line 400 of file FEAPI.h.


Generated on Fri Mar 23 10:29:00 2007 for FEAPI Plugin Documentation by  doxygen 1.3.9.1