audioencoder: Improve set_frame_sample_{min,max} documentation
authorSebastian Dröge <sebastian.droege@collabora.co.uk>
Mon, 26 Sep 2011 14:35:55 +0000 (16:35 +0200)
committerSebastian Dröge <sebastian.droege@collabora.co.uk>
Mon, 26 Sep 2011 14:35:55 +0000 (16:35 +0200)
gst-libs/gst/audio/gstaudioencoder.c

index 57f6460..c118438 100644 (file)
@@ -1732,6 +1732,9 @@ gst_audio_encoder_get_audio_info (GstAudioEncoder * enc)
  * Sets number of samples (per channel) subclass needs to be handed,
  * at least or will be handed all available if 0.
  *
+ * If an exact number of samples is required, gst_audio_encoder_set_frame_samples_max()
+ * must be called with the same number.
+ *
  * Since: 0.10.36
  */
 void
@@ -1766,6 +1769,9 @@ gst_audio_encoder_get_frame_samples_min (GstAudioEncoder * enc)
  * Sets number of samples (per channel) subclass needs to be handed,
  * at most or will be handed all available if 0.
  *
+ * If an exact number of samples is required, gst_audio_encoder_set_frame_samples_min()
+ * must be called with the same number.
+ *
  * Since: 0.10.36
  */
 void