avresample: Document avresample_open() a little better

[ffmpeg] / libavresample / avresample.h

diff --git a/libavresample/avresample.h b/libavresample/avresample.h
index b705a45cdebdaa5f1b6b13ba04b0d4f415f18b88..1dca6e4c699e7c6b8efeff5c307fb88ba75b175f 100644 (file)
--- a/libavresample/avresample.h
+++ b/libavresample/avresample.h
@@ -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