swresample: document the need to configure the context using AVOptions

Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
cus · Aug 10, 2014 · c4ac48c · c4ac48c
1 parent 49456a9
commit c4ac48c
Showing 1 changed file with 4 additions and 0 deletions.
diff --git 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.