Browse code

avresample: Document avresample_open() a little better

Bug-Id: 911

Luca Barbato authored on 2015/11/04 17:16:46
Showing 1 changed files
... ...
@@ -167,9 +167,13 @@ AVAudioResampleContext *avresample_alloc_context(void);
167 167
 /**
168 168
  * Initialize AVAudioResampleContext.
169 169
  * @note The context must be configured using the AVOption API.
170
+ * @note The fields "in_channel_layout", "out_channel_layout",
171
+ *       "in_sample_rate", "out_sample_rate", "in_sample_fmt",
172
+ *       "out_sample_fmt" must be set.
170 173
  *
171 174
  * @see av_opt_set_int()
172 175
  * @see av_opt_set_dict()
176
+ * @see av_get_default_channel_layout()
173 177
  *
174 178
  * @param avr  audio resample context
175 179
  * @return     0 on success, negative AVERROR code on failure