mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-02-03 13:02:29 +00:00
Code Issues 1 Projects Releases Wiki Activity

baseaudioencoder: gtk-doc syntax fixes

Browse source
This commit is contained in:
Mark Nauwelaerts 2011-03-09 12:18:56 +01:00 committed by Tim-Philipp Müller
parent 51acb02342
commit 3d2f496b3a
1 changed files with 14 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
gst-libs/gst/audio/gstbaseaudioencoder.c
View file

@ -100,20 +100,18 @@
* *
* In particular, base class will either favor tracking upstream timestamps * In particular, base class will either favor tracking upstream timestamps
* (at the possible expense of jitter) or aim to arrange for a perfect stream of * (at the possible expense of jitter) or aim to arrange for a perfect stream of
* output timestamps, depending on * output timestamps, depending on #GstBaseAudioEncoder:perfect-ts.
* <link linkend="GstBaseAudioEncoder--perfect-ts">perfect-ts</link>.
* However, in the latter case, the input may not be so perfect or ideal, which * However, in the latter case, the input may not be so perfect or ideal, which
* is handled as follows. An input timestamp is compared with the expected * is handled as follows. An input timestamp is compared with the expected
* timestamp as dictated by input sample stream and if the deviation is less * timestamp as dictated by input sample stream and if the deviation is less
* than <link linkend="GstBaseAudioEncoder--tolerance">tolerance</link>, * than #GstBaseAudioEncoder:tolerance, the deviation is discarded.
* the deviation is discarded. Otherwise, it is considered * Otherwise, it is considered a discontuinity and subsequent output timestamp
* a discontuinity and subsequent output timestamp is resynced to the * is resynced to the new position after performing configured discontinuity
* new position after performing configured discontinuity processing. * processing. In the non-perfect-ts case, an upstream variation exceeding
* In the non-perfect-ts case, an upstream variation exceeding tolerance * tolerance only leads to marking DISCONT on subsequent outgoing
* only leads to marking DISCONT on subsequent outgoing (while timestamps * (while timestamps are adjusted to upstream regardless of variation).
* are adjusted to upstream regardless of variation).
* While DISCONT is also marked in the perfect-ts case, this one optionally * While DISCONT is also marked in the perfect-ts case, this one optionally
* (see <link linkend="GstBaseAudioEncoder--hard-resync">hard-resync</link>) * (see #GstBaseAudioEncoder:hard-resync)
* performs some additional steps, such as clipping of (early) input samples * performs some additional steps, such as clipping of (early) input samples
* or draining all currently remaining input data, depending on the direction * or draining all currently remaining input data, depending on the direction
* of the discontuinity. * of the discontuinity.
@ -428,7 +426,8 @@ gst_base_audio_encoder_finalize (GObject * object)
G_OBJECT_CLASS (parent_class)->finalize (object); G_OBJECT_CLASS (parent_class)->finalize (object);
} }
/** gst_base_audio_encoder_finish_frame: /**
* gst_base_audio_encoder_finish_frame:
* @enc: a #GstBaseAudioEncoder * @enc: a #GstBaseAudioEncoder
* @buffer: encoded data * @buffer: encoded data
* @samples: number of samples (per channel) represented by encoded data * @samples: number of samples (per channel) represented by encoded data
@ -1013,7 +1012,8 @@ refuse_caps:
} }
/** gst_base_audio_encoder_proxy_getcaps: /**
* gst_base_audio_encoder_proxy_getcaps:
* @enc: a #GstBaseAudioEncoder * @enc: a #GstBaseAudioEncoder
* @caps: initial * @caps: initial
* *
@ -1593,7 +1593,8 @@ gst_base_audio_encoder_sink_activate_push (GstPad * pad, gboolean active)
return result; return result;
} }
/** gst_base_audio_encoder_add_streamheader: /**
* gst_base_audio_encoder_add_streamheader:
* @caps: a #GstCaps * @caps: a #GstCaps
* @buf: header buffers * @buf: header buffers
* *