avresample: Document avresample_open() a little better

Bug-Id: 911
This commit is contained in:
Luca Barbato 2015-11-04 09:16:46 +01:00
parent f128b8e19a
commit e2854e731f
1 changed files with 4 additions and 0 deletions

View File

@ -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