MPIFilterMessage

Definition

typedef enum {
    MPIFilterMessageFILTER_INVALID,
    MPIFilterMessageINVALID_ALGORITHM,
    MPIFilterMessageINVALID_DRATE,
    MPIFilterMessageCONVERSION_DIV_BY_0,
    MPIFilterMessageSECTION_NOT_ENABLED,
    MPIFilterMessageINVALID_FILTER_FORM,
} MPIFilterMessage;

Description

MPIFilterMessage is an enumeration of Filter error messages that can be returned by the MPI library.

MPIFilterMessageFILTER_INVALID
	The filter number is out of range. This message code is returned by mpiFilterCreate(...) if the filter number is less than zero or greater than or equal to MEIXmpMAX_Filters.
MPIFilterMessageINVALID_ALGORITHM
	The filter algorithm is not valid. This message code is returned by mpiFilterIntegratorReset(...) if the filter algorithm is not a member of the MEIXmpAlgorithm enumeration (does not support integrators). This problem occurs if the filter type is set to user or an unknown type with mpiFilterConfigSet(...).
MPIFilterMessageINVALID_DRATE
	The filter derivative rate is not valid. This message code is returned by mpiFilterConfigSet(...) if the filter derivative rate is less than 0 or greater than 7. NOTE: The derivative rate for all gain tables must be in the range [0,7], not just the derivative rate for the current gain table.
MPIFilterMessageCONVERSION_DIV_BY_0
	Returned when meiFilterPostfilterGet(...) or meiFilterPostfilterSectionGet(...) cannot convert digital coefficients to analog coefficients. When this error occurs, the offending section(s) will report its type as MEIFilterTypeUNKNOWN and will not contain any analog data.
MPIFilterMessageSECTION_NOT_ENABLED
	Returned when meiFilterPostfilterGet(...) or meiFilterPostfilterSectionGet(...) attempt to read postfilter data when no postfilter sections are enabled.
MPIFilterMessageINVALID_FILTER_FORM
	Returned when meiFilterPostfilterGet(...) or meiFilterPostfilterSectionGet(...) cannot interpret the current postfilter's form (when the form is something other than NONE, IIR, or BIQUAD).