summaryrefslogtreecommitdiff
path: root/libavresample
diff options
context:
space:
mode:
authorHendrik Leppkes <h.leppkes@gmail.com>2015-11-10 18:07:41 +0100
committerHendrik Leppkes <h.leppkes@gmail.com>2015-11-10 18:07:41 +0100
commit240ac53a5cccaccb0a17d42ab443ec3425423373 (patch)
treec7cfca72228d336edd7caa0cee67f74f131431c1 /libavresample
parentdf06cb561102488f09c9ef24494cc7dd843cad1a (diff)
parente2854e731f843906d9a9a5b882bed872341999fd (diff)
downloadffmpeg-240ac53a5cccaccb0a17d42ab443ec3425423373.tar.gz
Merge commit 'e2854e731f843906d9a9a5b882bed872341999fd'
* commit 'e2854e731f843906d9a9a5b882bed872341999fd': avresample: Document avresample_open() a little better Merged-by: Hendrik Leppkes <h.leppkes@gmail.com>
Diffstat (limited to 'libavresample')
-rw-r--r--libavresample/avresample.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/libavresample/avresample.h b/libavresample/avresample.h
index 5eb55cb6db..2431bddcc6 100644
--- a/libavresample/avresample.h
+++ b/libavresample/avresample.h
@@ -167,9 +167,13 @@ AVAudioResampleContext *avresample_alloc_context(void);
/**
* Initialize AVAudioResampleContext.
* @note The context must be configured using the AVOption API.
+ * @note The fields "in_channel_layout", "out_channel_layout",
+ * "in_sample_rate", "out_sample_rate", "in_sample_fmt",
+ * "out_sample_fmt" must be set.
*
* @see av_opt_set_int()
* @see av_opt_set_dict()
+ * @see av_get_default_channel_layout()
*
* @param avr audio resample context
* @return 0 on success, negative AVERROR code on failure