From 5ae5171e085a8eb930fc535bee86d0cc87fba719 Mon Sep 17 00:00:00 2001 From: "Christian R. Helmrich" Date: Fri, 31 Jan 2020 23:10:43 +0000 Subject: [PATCH] Update api --- api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api.md b/api.md index 29f5193..1090ef4 100644 --- a/api.md +++ b/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.