mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-07-27 00:38:21 +00:00
Code Issues 1 Projects Releases Wiki Activity

audioencoder: elaborate some documentation

Browse source
This commit is contained in:
Mark Nauwelaerts 2011-11-28 11:30:18 +01:00
parent 9f57d91137
commit 4a58223e4c
2 changed files with 6 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
gst-libs/gst/audio/gstaudioencoder.c
View file

@ -464,6 +464,9 @@ gst_audio_encoder_finalize (GObject * object)
* are considered discarded, e.g. as a result of discontinuous transmission,
* and a discontinuity is marked.
*
* Note that samples received in gst_audio_encoder_handle_frame()
* may be invalidated by a call to this function.
*
* Returns: a #GstFlowReturn that should be escalated to caller (of caller)
*
* Since: 0.10.36

4
gst-libs/gst/audio/gstaudioencoder.h
View file

@ -132,7 +132,9 @@ struct _GstAudioEncoder {
* @handle_frame: Provides input samples (or NULL to clear any remaining data)
* according to directions as configured by the subclass
* using the API. Input data ref management is performed
* by base class, subclass should not care or intervene.
* by base class, subclass should not care or intervene,
* and input data is only valid until next call to base class,
* most notably a call to gst_audio_encoder_finish_frame().
* @flush: Optional.
* Instructs subclass to clear any codec caches and discard
* any pending samples and not yet returned encoded data.