summaryrefslogtreecommitdiff
path: root/libswresample/swresample.h
diff options
context:
space:
mode:
authorLuca Barbato <lu_zero@gentoo.org>2014-08-11 00:35:19 +0200
committerMichael Niedermayer <michaelni@gmx.at>2014-08-11 00:35:56 +0200
commitc4ac48c5a1464e20bb02ef62da2503906349e297 (patch)
tree0d0da09f73c1550475e548142c458d6afeb2a2a6 /libswresample/swresample.h
parent49456a95ebcbc2c2318422d51740de2f54b9915f (diff)
downloadffmpeg-c4ac48c5a1464e20bb02ef62da2503906349e297.tar.gz
swresample: document the need to configure the context using AVOptions
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
Diffstat (limited to 'libswresample/swresample.h')
-rw-r--r--libswresample/swresample.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/libswresample/swresample.h b/libswresample/swresample.h
index e4bbebae16..4b8b0451ee 100644
--- a/libswresample/swresample.h
+++ b/libswresample/swresample.h
@@ -211,6 +211,10 @@ struct SwrContext *swr_alloc(void);
/**
* Initialize context after user parameters have been set.
+ * @note The context must be configured using the AVOption API.
+ *
+ * @see av_opt_set_int()
+ * @see av_opt_set_dict()
*
* @param[in,out] s Swr context to initialize
* @return AVERROR error code in case of failure.