fenix/exhale
1
0
Fork 0
mirror of https://gitlab.com/ecodis/exhale.git synced 2025-06-05 21:59:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update api

Christian R. Helmrich
2020-01-31 23:10:43 +00:00
parent 9008932420
commit 5ae5171e08
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
api.md

@@ -25,7 +25,7 @@ create an *ExhaleEncAPI* object and return a pointer to it. The following parame
* *numChannels*: number of channels in the input PCM audio data. Must be between 1 (mono) and 8 (7.1 surround), or 0 to indicate two-channel input which will be encoded channel-independently in dual-mono two-SCE configuration.
* *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, only for scientific research.
* *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, only for scientific research purposes.
* *useNoiseFilling*: enable (true) or disable (false) the noise substitution functionality. It is recommended to enable this feature.
* *useEcodisExt*: additional, reserved parameter for future use. Currently ignored, should be set to false.