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:40:25 +00:00
parent 26542c81b1
commit 0c5c0c4f89
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

@ -49,7 +49,7 @@ unsigned ExhaleEncAPI::`initEncoder`(unsigned char* const audioConfigBuffer, uin
initialize an *ExhaleEncAPI* object for encoding and allocate dynamic object memory. Also checks the validity of the parameters given to `exhaleCreate()` and, upon success, generates AudioSpecificConfig (ASC, including UsacConfig) data for the bit-stream header. The following parameters are available for storage of this data: initialize an *ExhaleEncAPI* object for encoding and allocate dynamic object memory. Also checks the validity of the parameters given to `exhaleCreate()` and, upon success, generates AudioSpecificConfig (ASC, including UsacConfig) data for the bit-stream header. The following parameters are available for storage of this data:
* *audioConfigBuffer*: pointer to an unsigned 8-bit integer buffer to which the ASC data is written. The buffer must be at least 16 bytes large. May be `NULL`, in which case no ASC is generated. * *audioConfigBuffer*: pointer to an unsigned 8-bit integer buffer to which the ASC data will be written. The buffer must be at least 16 bytes large. May be `NULL`, in which case no ASC is generated.
* *audioConfigBytes*: pointer to a single unsigned 32-bit integer to which the byte-size of the ASC data is written. Optional parameter, may be `NULL`, in which case the size information is discarded. * *audioConfigBytes*: pointer to a single unsigned 32-bit integer to which the byte-size of the ASC data is written. Optional parameter, may be `NULL`, in which case the size information is discarded.
**Return value** **Return value**