summaryrefslogtreecommitdiff
path: root/libavresample
diff options
context:
space:
mode:
authorLuca Barbato <lu_zero@gentoo.org>2015-11-04 09:16:46 +0100
committerLuca Barbato <lu_zero@gentoo.org>2015-11-05 17:25:46 +0100
commite2854e731f843906d9a9a5b882bed872341999fd (patch)
treea6ab81b89e9c385fff82f763af5b073112130b44 /libavresample
parentf128b8e19ac7f702adae899ab91cc1e80f238761 (diff)
downloadffmpeg-e2854e731f843906d9a9a5b882bed872341999fd.tar.gz
avresample: Document avresample_open() a little better
Bug-Id: 911
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 b705a45cde..1dca6e4c69 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