mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-18 22:36:33 +00:00
Code Issues 1 Projects Releases Wiki Activity

rtpjitterbuffer: fix RTPJitterBufferMode documentation

Browse source 
Documentation lacks '@' before each enum values and there was an extra
line after symbol section which confuses GTK-Doc parser.

https://bugzilla.gnome.org/show_bug.cgi?id=767788
This commit is contained in:
Aurélien Zanelli 2016-06-17 13:58:33 +02:00 committed by Sebastian Dröge
parent 83f4c08747
commit f8f8935c77
1 changed files with 5 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
gst/rtpmanager/rtpjitterbuffer.h
View file

@ -36,20 +36,19 @@ typedef struct _RTPJitterBufferItem RTPJitterBufferItem;
/**
* RTPJitterBufferMode:
*
* RTP_JITTER_BUFFER_MODE_NONE: don't do any skew correction, outgoing
* @RTP_JITTER_BUFFER_MODE_NONE: don't do any skew correction, outgoing
* timestamps are calculated directly from the RTP timestamps. This mode is
* good for recording but not for real-time applications.
* RTP_JITTER_BUFFER_MODE_SLAVE: calculate the skew between sender and receiver
* @RTP_JITTER_BUFFER_MODE_SLAVE: calculate the skew between sender and receiver
* and produce smoothed adjusted outgoing timestamps. This mode is good for
* low latency communications.
* RTP_JITTER_BUFFER_MODE_BUFFER: buffer packets between low/high watermarks.
* @RTP_JITTER_BUFFER_MODE_BUFFER: buffer packets between low/high watermarks.
* This mode is good for streaming communication.
* RTP_JITTER_BUFFER_MODE_SYNCED: sender and receiver clocks are synchronized,
* @RTP_JITTER_BUFFER_MODE_SYNCED: sender and receiver clocks are synchronized,
* like #RTP_JITTER_BUFFER_MODE_SLAVE but skew is assumed to be 0. Good for
* low latency communication when sender and receiver clocks are
* synchronized and there is thus no clock skew.
* RTP_JITTER_BUFFER_MODE_LAST: last buffer mode.
* @RTP_JITTER_BUFFER_MODE_LAST: last buffer mode.
*
* The different buffer modes for a jitterbuffer.
*/