From 3304eae3e8419af9d8aa8627eb544d30ac24311c Mon Sep 17 00:00:00 2001 From: Jan Schmidt Date: Tue, 14 Nov 2023 22:29:41 +1100 Subject: [PATCH] audio: Extra documentation for gst_audio_ring_buffer_set_timestamp() Clarify the documentation that gst_audio_ring_buffer_set_timestamp() expects timestamps sampled directly from the pipeline clock Part-of: --- .../gst-libs/gst/audio/gstaudioringbuffer.c | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/subprojects/gst-plugins-base/gst-libs/gst/audio/gstaudioringbuffer.c b/subprojects/gst-plugins-base/gst-libs/gst/audio/gstaudioringbuffer.c index 0685896ff4..5705f34287 100644 --- a/subprojects/gst-plugins-base/gst-libs/gst/audio/gstaudioringbuffer.c +++ b/subprojects/gst-plugins-base/gst-libs/gst/audio/gstaudioringbuffer.c @@ -2181,7 +2181,13 @@ gst_audio_ring_buffer_set_channel_positions (GstAudioRingBuffer * buf, * @readseg: the current data segment * @timestamp: The new timestamp of the buffer. * - * Set a new timestamp on the buffer. + * Set a new timestamp on the buffer representing the time of the first sample + * in the ringbuffer segment. The timestamp is used by the #GstAudioSrc base + * class to set the timestamps on output buffers. Timestamps are + * expected to be taken directly from the pipeline clock and are + * actual clock timestamps. #GstAudioSrc will convert to running time + * by subtracting the base time, but otherwise does not adjust the + * outgoing timestamps if provided. * * MT safe. */