adapter: align documentation to actual behavior

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/6535>
This commit is contained in:
Mark Nauwelaerts 2024-04-03 20:56:57 +02:00 committed by GStreamer Marge Bot
parent 16f69acf30
commit e019093fbf
2 changed files with 10 additions and 10 deletions

View file

@ -629,7 +629,7 @@ position is returned.
The dts is reset to GST_CLOCK_TIME_NONE and the distance is set to 0 when
the adapter is first created or when it is cleared. This also means that before
the first byte with a dts is removed from the adapter, the dts
the first byte with a dts is added to the adapter, the dts
and distance returned are GST_CLOCK_TIME_NONE and 0 respectively.</doc>
<source-position filename="../subprojects/gstreamer/libs/gst/base/gstadapter.h"/>
<return-value transfer-ownership="none">
@ -654,7 +654,7 @@ position is returned.
The dts is reset to GST_CLOCK_TIME_NONE and the distance is set to 0 when
the adapter is first created or when it is cleared. This also means that before
the first byte with a dts is removed from the adapter, the dts
the first byte with a dts is added to the adapter, the dts
and distance returned are GST_CLOCK_TIME_NONE and 0 respectively.</doc>
<source-position filename="../subprojects/gstreamer/libs/gst/base/gstadapter.h"/>
<return-value transfer-ownership="none">
@ -683,7 +683,7 @@ position is returned.
The offset is reset to GST_BUFFER_OFFSET_NONE and the distance is set to 0
when the adapter is first created or when it is cleared. This also means that
before the first byte with an offset is removed from the adapter, the offset
before the first byte with an offset is added to the adapter, the offset
and distance returned are GST_BUFFER_OFFSET_NONE and 0 respectively.</doc>
<source-position filename="../subprojects/gstreamer/libs/gst/base/gstadapter.h"/>
<return-value transfer-ownership="none">
@ -708,7 +708,7 @@ position is returned.
The pts is reset to GST_CLOCK_TIME_NONE and the distance is set to 0 when
the adapter is first created or when it is cleared. This also means that before
the first byte with a pts is removed from the adapter, the pts
the first byte with a pts is added to the adapter, the pts
and distance returned are GST_CLOCK_TIME_NONE and 0 respectively.</doc>
<source-position filename="../subprojects/gstreamer/libs/gst/base/gstadapter.h"/>
<return-value transfer-ownership="none">
@ -733,7 +733,7 @@ position is returned.
The pts is reset to GST_CLOCK_TIME_NONE and the distance is set to 0 when
the adapter is first created or when it is cleared. This also means that before
the first byte with a pts is removed from the adapter, the pts
the first byte with a pts is added to the adapter, the pts
and distance returned are GST_CLOCK_TIME_NONE and 0 respectively.</doc>
<source-position filename="../subprojects/gstreamer/libs/gst/base/gstadapter.h"/>
<return-value transfer-ownership="none">

View file

@ -1454,7 +1454,7 @@ gst_adapter_dts_at_discont (GstAdapter * adapter)
*
* The offset is reset to GST_BUFFER_OFFSET_NONE and the distance is set to 0
* when the adapter is first created or when it is cleared. This also means that
* before the first byte with an offset is removed from the adapter, the offset
* before the first byte with an offset is added to the adapter, the offset
* and distance returned are GST_BUFFER_OFFSET_NONE and 0 respectively.
*
* Since: 1.10
@ -1483,7 +1483,7 @@ gst_adapter_prev_offset (GstAdapter * adapter, guint64 * distance)
*
* The pts is reset to GST_CLOCK_TIME_NONE and the distance is set to 0 when
* the adapter is first created or when it is cleared. This also means that before
* the first byte with a pts is removed from the adapter, the pts
* the first byte with a pts is added to the adapter, the pts
* and distance returned are GST_CLOCK_TIME_NONE and 0 respectively.
*
* Returns: The previously seen pts.
@ -1510,7 +1510,7 @@ gst_adapter_prev_pts (GstAdapter * adapter, guint64 * distance)
*
* The dts is reset to GST_CLOCK_TIME_NONE and the distance is set to 0 when
* the adapter is first created or when it is cleared. This also means that before
* the first byte with a dts is removed from the adapter, the dts
* the first byte with a dts is added to the adapter, the dts
* and distance returned are GST_CLOCK_TIME_NONE and 0 respectively.
*
* Returns: The previously seen dts.
@ -1538,7 +1538,7 @@ gst_adapter_prev_dts (GstAdapter * adapter, guint64 * distance)
*
* The pts is reset to GST_CLOCK_TIME_NONE and the distance is set to 0 when
* the adapter is first created or when it is cleared. This also means that before
* the first byte with a pts is removed from the adapter, the pts
* the first byte with a pts is added to the adapter, the pts
* and distance returned are GST_CLOCK_TIME_NONE and 0 respectively.
*
* Since: 1.2
@ -1588,7 +1588,7 @@ gst_adapter_prev_pts_at_offset (GstAdapter * adapter, gsize offset,
*
* The dts is reset to GST_CLOCK_TIME_NONE and the distance is set to 0 when
* the adapter is first created or when it is cleared. This also means that before
* the first byte with a dts is removed from the adapter, the dts
* the first byte with a dts is added to the adapter, the dts
* and distance returned are GST_CLOCK_TIME_NONE and 0 respectively.
*
* Since: 1.2