diff options
| author | Ralph Giles <giles@mozilla.com> | 2011-12-02 13:22:22 -0800 |
|---|---|---|
| committer | Ralph Giles <giles@mozilla.com> | 2012-03-05 17:09:54 -0800 |
| commit | 1e0ba0f40a8d874b3474f1b543943a65d42137b2 (patch) | |
| tree | ed3bcf7d6d8fe1ca73fe3725e846ef3108298a75 /include/opus.h | |
| parent | b46991c34f3587a06957a627d1e3095bf711851e (diff) | |
| download | opus-1e0ba0f40a8d874b3474f1b543943a65d42137b2.tar.gz | |
Fix typos in the API documentation.
opus_decode() takes a sixth 'enable_fec' option. Naive invocations
shoudl set this to zero.
Diffstat (limited to 'include/opus.h')
| -rw-r--r-- | include/opus.h | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/include/opus.h b/include/opus.h index e5dafa63..bd15b853 100644 --- a/include/opus.h +++ b/include/opus.h @@ -304,7 +304,7 @@ OPUS_EXPORT int opus_encoder_ctl(OpusEncoder *st, int request, ...); * * To decode a frame, opus_decode() or opus_decode_float() must be called with a packet of compressed audio data: * @code - * frame_size = opus_decode(enc, packet, len, decoded, max_size); + * frame_size = opus_decode(dec, packet, len, decoded, max_size, 0); * @endcode * where * @@ -313,7 +313,7 @@ OPUS_EXPORT int opus_encoder_ctl(OpusEncoder *st, int request, ...); * @li decoded is the decoded audio data in opus_int16 (or float for opus_decode_float()) * @li max_size is the max duration of the frame in samples (per channel) that can fit into the decoded_frame array * - * opus_decode() and opus_decode_frame() return the number of samples ()per channel) decoded from the packet. + * opus_decode() and opus_decode_float() return the number of samples (per channel) decoded from the packet. * If that value is negative, then an error has occured. This can occur if the packet is corrupted or if the audio * buffer is too small to hold the decoded audio. |