◆ getNonlinearityCoefficients()
virtual size_t oceandirect::api::LHNonlinearityAPI::getNonlinearityCoefficients |
( |
lh_device_id_t |
deviceID, |
|
|
lh_error_code_t * |
errorCode, |
|
|
float |
buffer[], |
|
|
size_t |
bufferLength |
|
) |
| |
|
virtual |
.getNonlinearityCoefficients Determine the current nonlinearity coefficients for the device.
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
buffer | the array to receive the current nonlinearity coefficients. |
bufferLength | the size of the buffer that will receive the coefficients. The number of coefficients returned by the device is expected to be eight (8). If bufferLength is less than eight then the specified number (bufferlength) of coefficients will be returned. If bufferLength is greater than eight then only the first eight elements of buffer will be populated wth the returned coefficients. |
- Returns
- the actual number of coefficients copied into the buffer or 0 on error.
The documentation for this class was generated from the following file: