diff options
| author | Ralph Giles <giles@mozilla.com> | 2011-11-26 08:25:38 +0400 |
|---|---|---|
| committer | Jean-Marc Valin <jmvalin@jmvalin.ca> | 2011-11-26 08:25:38 +0400 |
| commit | 10ebc02ecf20d81502995fa92c58dc136ddff45a (patch) | |
| tree | 92368d32db87110936d3aea064cf1217065cf6c7 /include/opus.h | |
| parent | 215938139eaaf8a4e9050692d5474e1c479779d4 (diff) | |
Misc documentation fixes (no code change)
We use macros to encapsulate the appropriate type and size
information for the different CTL requests, but the macros
still need to be used with the _ctl() function call and an
encoder or decoder instance structure. As such, just listing
the macro defines is confusing. Adding some examples outside
the OpusEncoder overview page should help with this.
Also document that OPUS_SET_APPLICATION can take
OPUS_APPLICATION_RESTRICTED_LOWDELAY.
Diffstat (limited to 'include/opus.h')
| -rw-r--r-- | include/opus.h | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/include/opus.h b/include/opus.h index c552fc27..df2103f7 100644 --- a/include/opus.h +++ b/include/opus.h @@ -261,6 +261,9 @@ OPUS_EXPORT int opus_encode_float( OPUS_EXPORT void opus_encoder_destroy(OpusEncoder *st); /** Perform a CTL function on an Opus encoder. + * + * Generally the request and subsequent arguments are generated + * by a convenience macro. * @see encoderctls */ OPUS_EXPORT int opus_encoder_ctl(OpusEncoder *st, int request, ...); @@ -398,7 +401,10 @@ OPUS_EXPORT int opus_decode_float( ); /** Perform a CTL function on an Opus decoder. - * @see decoderctls + * + * Generally the request and subsequent arguments are generated + * by a convenience macro. + * @see genericctls */ OPUS_EXPORT int opus_decoder_ctl(OpusDecoder *st, int request, ...); @@ -455,7 +461,7 @@ OPUS_EXPORT int opus_packet_get_samples_per_frame(const unsigned char *data, opu */ OPUS_EXPORT int opus_packet_get_nb_channels(const unsigned char *data); -/** Gets the number of frame in an Opus packet. +/** Gets the number of frames in an Opus packet. * @param [in] packet <tt>char*</tt>: Opus packet * @param [in] len <tt>int</tt>: Length of packet * @returns Number of frames |