From 1eb7f81f9db9760aa5ec6939cc7c349f227875ff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebastian=20Dr=C3=B6ge?= Date: Tue, 19 Apr 2022 14:05:16 +0300 Subject: [PATCH] gstreamer: Document various caps for the reference timestamp meta Part-of: --- subprojects/gstreamer/gst/gstbuffer.h | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/subprojects/gstreamer/gst/gstbuffer.h b/subprojects/gstreamer/gst/gstbuffer.h index 9e487b70f5..12ad5f20dd 100644 --- a/subprojects/gstreamer/gst/gstbuffer.h +++ b/subprojects/gstreamer/gst/gstbuffer.h @@ -750,10 +750,18 @@ typedef struct _GstReferenceTimestampMeta GstReferenceTimestampMeta; * captured. * * The reference is stored as a #GstCaps in @reference. Examples of valid - * references would be `timestamp/x-drivername-stream` for timestamps that are locally - * generated by some driver named `drivername` when generating the stream, - * e.g. based on a frame counter, or `timestamp/x-ntp, host=pool.ntp.org, - * port=123` for timestamps based on a specific NTP server. + * references would be + * + * * `timestamp/x-drivername-stream`: for timestamps that are locally + * generated by some driver named `drivername` when generating the stream, + * e.g. based on a frame counter + * * `timestamp/x-ntp, host=pool.ntp.org, port=123`: for timestamps based on a + * specific NTP server. Note that the host/port parameters might not always + * be given. + * * `timestamp/x-ptp, version=IEEE1588-2008, domain=1`: for timestamps based + * on a given PTP clock. + * * `timestamp/x-unix`: for timestamps based on the UNIX epoch according to + * the local clock. * * Since: 1.14 */