The current API documentation is provided with each distribution package in the ../doc folder.  Open documentation.html in any browser.

The platform-specific documentation is provided in the README.  This provides an explanation of the sample application as well as build requirements unique to the platform.

Notes on Gain APIs

All gain (volume level) parameters are passed into the DPS API as scalar (linear) float values.  This allows for maximum flexibility between platforms.  However, all user interfaces should preset gain in decibels to account for the logarithmic nature of audio loudness.  Use the following formulas in your UI to convert to and from decibels to linear float:

decibel = 20 * log10(scalar)
scalar = 10^(decibel/20)
Was this page helpful?