fenix
/
exhale
mirror of https://gitlab.com/ecodis/exhale.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update api

Christian R. Helmrich 2020-01-31 23:50:33 +00:00
parent 0c5c0c4f89
commit 929b0decac
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
api.md

@ -26,7 +26,7 @@ create an *ExhaleEncAPI* object and return a pointer to it. The following parame
* *frameLength*: number of audio samples per channel and encoded frame. Must equal 1024 for now.
* *indepPeriod*: random-access (also called "tune-in") period for broadcasting and streaming purposes, particularly when the audio is accompanied by video. Recommended values are 45 with 25 or 50-Hz video (Europe, Asia) and 50 with 30 or 60-Hz video (North America).
* *varBitRateMode*: the CVBR mode controlling the overall bit-rate. See the [FAQ](https://gitlab.com/ecodis/exhale/-/wikis/faq) for details. Must be between 0 (lowest rate) and 9 (highest rate). Note that mode 0 is **not** intended for content production, use it only for scientific research.
* *useNoiseFilling*: enable (true) or disable (false) the noise substitution functionality provided by the ISO/IEC 23003-3 standard. It is recommended to enable this feature for best possible audio quality.
* *useNoiseFilling*: enable (true) or disable (false) the noise substitution functionality provided by the ISO/IEC 23003-3 standard. It is recommended to enable this feature for best possible audio quality especially at the low bit-rate modes.
* *useEcodisExt*: additional, reserved parameter for future use. Currently ignored, should be set to false.
**Return value**