summaryrefslogtreecommitdiff
path: root/vendor/github.com/pion/rtcp/doc.go
diff options
context:
space:
mode:
authorkali kaneko (leap communications) <kali@leap.se>2021-11-29 01:46:27 +0100
committerkali kaneko (leap communications) <kali@leap.se>2021-11-29 18:14:16 +0100
commit18f52af5be3a9a0c73811706108f790d65ee9c67 (patch)
treee13cbacb47d56919caa9c44a2b45dec1497a7860 /vendor/github.com/pion/rtcp/doc.go
parentebcef0d57b6ecb5a40c6579f6be07182dd3033ba (diff)
[pkg] update vendor
Diffstat (limited to 'vendor/github.com/pion/rtcp/doc.go')
-rw-r--r--vendor/github.com/pion/rtcp/doc.go39
1 files changed, 39 insertions, 0 deletions
diff --git a/vendor/github.com/pion/rtcp/doc.go b/vendor/github.com/pion/rtcp/doc.go
new file mode 100644
index 0000000..fa948df
--- /dev/null
+++ b/vendor/github.com/pion/rtcp/doc.go
@@ -0,0 +1,39 @@
+/*
+Package rtcp implements encoding and decoding of RTCP packets according to RFCs 3550 and 5506.
+
+RTCP is a sister protocol of the Real-time Transport Protocol (RTP). Its basic functionality
+and packet structure is defined in RFC 3550. RTCP provides out-of-band statistics and control
+information for an RTP session. It partners with RTP in the delivery and packaging of multimedia data,
+but does not transport any media data itself.
+
+The primary function of RTCP is to provide feedback on the quality of service (QoS)
+in media distribution by periodically sending statistics information such as transmitted octet
+and packet counts, packet loss, packet delay variation, and round-trip delay time to participants
+in a streaming multimedia session. An application may use this information to control quality of
+service parameters, perhaps by limiting flow, or using a different codec.
+
+Decoding RTCP packets:
+
+ pkt, err := rtcp.Unmarshal(rtcpData)
+ // ...
+
+ switch p := pkt.(type) {
+ case *rtcp.CompoundPacket:
+ ...
+ case *rtcp.PictureLossIndication:
+ ...
+ default:
+ ...
+ }
+
+Encoding RTCP packets:
+
+ pkt := &rtcp.PictureLossIndication{
+ SenderSSRC: senderSSRC,
+ MediaSSRC: mediaSSRC
+ }
+ pliData, err := pkt.Marshal()
+ // ...
+
+*/
+package rtcp