swresample: document the need to configure the context using AVOptions

Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
This commit is contained in:
Luca Barbato 2014-08-11 00:35:19 +02:00 committed by Michael Niedermayer
parent 49456a95eb
commit c4ac48c5a1
1 changed files with 4 additions and 0 deletions

View File

@ -211,6 +211,10 @@ struct SwrContext *swr_alloc(void);
/** /**
* Initialize context after user parameters have been set. * 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 * @param[in,out] s Swr context to initialize
* @return AVERROR error code in case of failure. * @return AVERROR error code in case of failure.