swresample: document the need to configure the context using AVOptions
authorLuca Barbato <lu_zero@gentoo.org>
Sun, 10 Aug 2014 22:35:19 +0000 (00:35 +0200)
committerMichael Niedermayer <michaelni@gmx.at>
Sun, 10 Aug 2014 22:35:56 +0000 (00:35 +0200)
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
libswresample/swresample.h

index e4bbeba..4b8b045 100644 (file)
@@ -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.