mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-19 08:11:16 +00:00
Code Issues 1 Projects Releases Wiki Activity

gstreamer: Document various caps for the reference timestamp meta

Browse source 
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/2132>
This commit is contained in:
Sebastian Dröge 2022-04-19 14:05:16 +03:00 committed by GStreamer Marge Bot
parent c7e12974ba
commit 1eb7f81f9d
1 changed files with 12 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
subprojects/gstreamer/gst/gstbuffer.h
View file

@ -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
*/