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:30:50 +00:00
parent 0180f6e54e
commit 26542c81b1
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
api.md

@@ -49,8 +49,8 @@ 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:
* *audioConfigBuffer*: pointer to an unsigned 8-bit integer buffer to which the ASC data is written. May be `NULL`, in which case no ASC is generated.
* *audioConfigBytes*: pointer to a single unsigned 32-bit integer to which the size of the ASC data (in bytes) is written. Optional, may be `NULL`.
* *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.
* *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**
@@ -70,7 +70,7 @@ unsigned ExhaleEncAPI::`encodeLookahead`( );
**Purpose**
encode the first (lookahead) frame with an *ExhaleEncAPI* object. Requires *frameLength***numChannels* new audio samples in *inputPcmData* (see `exhaleCreate()`).
encode the first (lookahead) frame with an *ExhaleEncAPI* object. Requires *frameLength***numChannels* new audio samples in *inputPcmData*, returns the AU in *outputAuData* (see `exhaleCreate()`).
**Return value**
@@ -90,7 +90,7 @@ unsigned ExhaleEncAPI::`encodeFrame`( );
**Purpose**
encode a regular PCM audio frame with an *ExhaleEncAPI* object. Requires *frameLength***numChannels* new audio samples in *inputPcmData* (see `exhaleCreate()`).
encode a regular PCM audio frame with an *ExhaleEncAPI* object. Requires *frameLength***numChannels* new audio samples in *inputPcmData*, returns the AU in *outputAuData* (see `exhaleCreate()`).
**Return value**
@@ -110,7 +110,7 @@ ExhaleEncAPI::`~ExhaleEncAPI`( ); *(class destructor)*
**Purpose**
free all dynamic memory allocated by an *ExhaleEncAPI* object. After calling this function, the *exhaleEnc* pointer can be set to `NULL`.
free all dynamic memory allocated by an *ExhaleEncAPI* object. After calling this function, the *exhaleEnc* pointer can be set to `NULL` or the return value of a new call to `exhaleCreate()`.
**Return value**