mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-27 04:01:08 +00:00
rtpmanager: fix various documentation issues
Improper naming of properties, improper links, misc Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-plugins-good/-/merge_requests/684>
This commit is contained in:
Mathieu Duponchelle
GStreamer Merge Bot
parent
435c2acdc5
commit
aa34c29d3b
4 changed files with 24 additions and 23 deletions
|
|
@ -731,7 +731,7 @@ gst_rtp_jitter_buffer_class_init (GstRtpJitterBufferClass * klass)
|
|||
-1, G_MAXINT, DEFAULT_RTX_DELAY_REORDER,
|
||||
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
|
||||
/**
|
||||
* GstRtpJitterBuffer::rtx-retry-timeout:
|
||||
* GstRtpJitterBuffer:rtx-retry-timeout:
|
||||
*
|
||||
* When no packet has been received after sending a retransmission event
|
||||
* for this time, retry sending a retransmission event.
|
||||
|
|
@ -747,7 +747,7 @@ gst_rtp_jitter_buffer_class_init (GstRtpJitterBufferClass * klass)
|
|||
"ms (-1 automatic)", -1, G_MAXINT, DEFAULT_RTX_RETRY_TIMEOUT,
|
||||
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
|
||||
/**
|
||||
* GstRtpJitterBuffer::rtx-min-retry-timeout:
|
||||
* GstRtpJitterBuffer:rtx-min-retry-timeout:
|
||||
*
|
||||
* The minimum amount of time between retry timeouts. When
|
||||
* GstRtpJitterBuffer::rtx-retry-timeout is -1, this value ensures a
|
||||
|
|
@ -809,7 +809,7 @@ gst_rtp_jitter_buffer_class_init (GstRtpJitterBufferClass * klass)
|
|||
"(-1 automatic)", -1, G_MAXINT, DEFAULT_RTX_DEADLINE,
|
||||
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
|
||||
/**
|
||||
* GstRtpJitterBuffer::rtx-stats-timeout:
|
||||
* GstRtpJitterBuffer:rtx-stats-timeout:
|
||||
*
|
||||
* The time to wait for a retransmitted packet after it has been
|
||||
* considered lost in order to collect RTX statistics.
|
||||
|
|
|
|||
|
|
@ -736,14 +736,14 @@ gst_rtp_session_class_init (GstRtpSessionClass * klass)
|
|||
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
|
||||
|
||||
/**
|
||||
* GstRtpSession::stats:
|
||||
* GstRtpSession:stats:
|
||||
*
|
||||
* Various session statistics. This property returns a GstStructure
|
||||
* with name application/x-rtp-session-stats with the following fields:
|
||||
* Various session statistics. This property returns a #GstStructure
|
||||
* with name `application/x-rtp-session-stats` with the following fields:
|
||||
*
|
||||
* "recv-rtx-req-count G_TYPE_UINT The number of retransmission event
|
||||
* "recv-rtx-req-count" G_TYPE_UINT The number of retransmission events
|
||||
* received from downstream (in receiver mode) (Since 1.16)
|
||||
* "sent-rtx-req-count" G_TYPE_UINT The number of retransmission event
|
||||
* "sent-rtx-req-count" G_TYPE_UINT The number of retransmission events
|
||||
* sent downstream (in sender mode) (Since 1.16)
|
||||
* "rtx-count" G_TYPE_UINT DEPRECATED Since 1.16, same as
|
||||
* "recv-rtx-req-count".
|
||||
|
|
@ -751,7 +751,7 @@ gst_rtp_session_class_init (GstRtpSessionClass * klass)
|
|||
* dropped (due to bandwidth constraints)
|
||||
* "sent-nack-count" G_TYPE_UINT Number of NACKs sent
|
||||
* "recv-nack-count" G_TYPE_UINT Number of NACKs received
|
||||
* "source-stats" G_TYPE_BOXED GValueArray of #RTPSource::stats for all
|
||||
* "source-stats" G_TYPE_BOXED GValueArray of #RTPSource:stats for all
|
||||
* RTP sources (Since 1.8)
|
||||
*
|
||||
* Since: 1.4
|
||||
|
|
@ -762,7 +762,7 @@ gst_rtp_session_class_init (GstRtpSessionClass * klass)
|
|||
G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
|
||||
|
||||
/**
|
||||
* GstRtpSession::twcc-stats:
|
||||
* GstRtpSession:twcc-stats:
|
||||
*
|
||||
* Various statistics derived from TWCC. This property returns a GstStructure
|
||||
* with name RTPTWCCStats with the following fields:
|
||||
|
|
@ -772,11 +772,11 @@ gst_rtp_session_class_init (GstRtpSessionClass * klass)
|
|||
* "packets-sent" G_TYPE_UINT Number of packets sent
|
||||
* "packets-recv" G_TYPE_UINT Number of packets reported recevied
|
||||
* "packet-loss-pct" G_TYPE_DOUBLE Packetloss percentage, based on
|
||||
packets reported as lost from the recevier.
|
||||
* packets reported as lost from the recevier.
|
||||
* "avg-delta-of-delta", G_TYPE_INT64 In nanoseconds, a moving window
|
||||
average of the difference in inter-packet spacing between
|
||||
sender and receiver. A sudden increase in this number can indicate
|
||||
network congestion.
|
||||
* average of the difference in inter-packet spacing between
|
||||
* sender and receiver. A sudden increase in this number can indicate
|
||||
* network congestion.
|
||||
*
|
||||
* Since: 1.18
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -508,12 +508,13 @@ rtp_session_class_init (RTPSessionClass * klass)
|
|||
DEFAULT_NUM_ACTIVE_SOURCES,
|
||||
G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
|
||||
/**
|
||||
* RTPSource::sources
|
||||
* RTPSource:sources
|
||||
*
|
||||
* Get a GValue Array of all sources in the session.
|
||||
*
|
||||
* ## Getting the #RTPSources of a session
|
||||
* |[
|
||||
*
|
||||
* ``` C
|
||||
* {
|
||||
* GValueArray *arr;
|
||||
* GValue *val;
|
||||
|
|
@ -529,7 +530,7 @@ rtp_session_class_init (RTPSessionClass * klass)
|
|||
* }
|
||||
* g_value_array_free (arr);
|
||||
* }
|
||||
* ]|
|
||||
* ```
|
||||
*/
|
||||
g_object_class_install_property (gobject_class, PROP_SOURCES,
|
||||
g_param_spec_boxed ("sources", "Sources",
|
||||
|
|
@ -583,7 +584,7 @@ rtp_session_class_init (RTPSessionClass * klass)
|
|||
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
|
||||
|
||||
/**
|
||||
* RTPSession::stats:
|
||||
* RTPSession:stats:
|
||||
*
|
||||
* Various session statistics. This property returns a GstStructure
|
||||
* with name application/x-rtp-session-stats with the following fields:
|
||||
|
|
@ -592,7 +593,7 @@ rtp_session_class_init (RTPSessionClass * klass)
|
|||
* dropped (due to bandwidth constraints)
|
||||
* "sent-nack-count" G_TYPE_UINT Number of NACKs sent
|
||||
* "recv-nack-count" G_TYPE_UINT Number of NACKs received
|
||||
* "source-stats" G_TYPE_BOXED GValueArray of #RTPSource::stats for all
|
||||
* "source-stats" G_TYPE_BOXED GValueArray of #RTPSource:stats for all
|
||||
* RTP sources (Since 1.8)
|
||||
*
|
||||
* Since: 1.4
|
||||
|
|
@ -614,7 +615,7 @@ rtp_session_class_init (RTPSessionClass * klass)
|
|||
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
|
||||
|
||||
/**
|
||||
* RTPSession::disable-sr-timestamp:
|
||||
* RTPSession:disable-sr-timestamp:
|
||||
*
|
||||
* Whether sender reports should be timestamped.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -105,7 +105,7 @@ rtp_source_class_init (RTPSourceClass * klass)
|
|||
G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
|
||||
|
||||
/**
|
||||
* RTPSource::sdes
|
||||
* RTPSource:sdes
|
||||
*
|
||||
* The current SDES items of the source. Returns a structure with name
|
||||
* application/x-rtp-source-sdes and may contain the following fields:
|
||||
|
|
@ -127,7 +127,7 @@ rtp_source_class_init (RTPSourceClass * klass)
|
|||
GST_TYPE_STRUCTURE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
|
||||
|
||||
/**
|
||||
* RTPSource::stats
|
||||
* RTPSource:stats
|
||||
*
|
||||
* This property returns a GstStructure named application/x-rtp-source-stats with
|
||||
* fields useful for statistics and diagnostics.
|
||||
|
|
@ -241,7 +241,7 @@ rtp_source_class_init (RTPSourceClass * klass)
|
|||
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
|
||||
|
||||
/**
|
||||
* RTPSession::disable-rtcp:
|
||||
* RTPSource:disable-rtcp:
|
||||
*
|
||||
* Allow disabling the sending of RTCP packets for this source.
|
||||
*/
|
||||
|
|
|
|||
Loading…
Reference in a new issue