Update docs

versatica · Jan 10, 2024 · 012fdcc · 012fdcc
1 parent 609b60f
commit 012fdcc
Show file tree

Hide file tree

Showing 101 changed files with 841 additions and 829 deletions.
diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js
diff --git a/docs/assets/search.js b/docs/assets/search.js
diff --git a/docs/classes/packets.ByePacket.html b/docs/classes/packets.ByePacket.html
diff --git a/docs/classes/packets.CompoundPacket.html b/docs/classes/packets.CompoundPacket.html
diff --git a/docs/classes/packets.DLRRExtendedReport.html b/docs/classes/packets.DLRRExtendedReport.html
diff --git a/docs/classes/packets.DRLEExtendedReport.html b/docs/classes/packets.DRLEExtendedReport.html
diff --git a/docs/classes/packets.ECNExtendedReport.html b/docs/classes/packets.ECNExtendedReport.html
diff --git a/docs/classes/packets.EcnPacket.html b/docs/classes/packets.EcnPacket.html
diff --git a/docs/classes/packets.ExtendedJitterReportsPacket.html b/docs/classes/packets.ExtendedJitterReportsPacket.html
diff --git a/docs/classes/packets.ExtendedReport.html b/docs/classes/packets.ExtendedReport.html
diff --git a/docs/classes/packets.FeedbackPacket.html b/docs/classes/packets.FeedbackPacket.html
diff --git a/docs/classes/packets.GenericExtendedReport.html b/docs/classes/packets.GenericExtendedReport.html
diff --git a/docs/classes/packets.GenericFeedbackPacket.html b/docs/classes/packets.GenericFeedbackPacket.html
diff --git a/docs/classes/packets.GenericPacket.html b/docs/classes/packets.GenericPacket.html
diff --git a/docs/classes/packets.LRLEExtendedReport.html b/docs/classes/packets.LRLEExtendedReport.html
diff --git a/docs/classes/packets.NackPacket.html b/docs/classes/packets.NackPacket.html
diff --git a/docs/classes/packets.PRTExtendedReport.html b/docs/classes/packets.PRTExtendedReport.html
diff --git a/docs/classes/packets.Packet.html b/docs/classes/packets.Packet.html
diff --git a/docs/classes/packets.PliPacket.html b/docs/classes/packets.PliPacket.html
diff --git a/docs/classes/packets.RRTExtendedReport.html b/docs/classes/packets.RRTExtendedReport.html
diff --git a/docs/classes/packets.ReceiverReportPacket.html b/docs/classes/packets.ReceiverReportPacket.html
diff --git a/docs/classes/packets.ReceptionReport.html b/docs/classes/packets.ReceptionReport.html
diff --git a/docs/classes/packets.RpsiPacket.html b/docs/classes/packets.RpsiPacket.html
diff --git a/docs/classes/packets.RtcpPacket.html b/docs/classes/packets.RtcpPacket.html
diff --git a/docs/classes/packets.RtpPacket.html b/docs/classes/packets.RtpPacket.html
diff --git a/docs/classes/packets.SSExtendedReport.html b/docs/classes/packets.SSExtendedReport.html
diff --git a/docs/classes/packets.SdesChunk.html b/docs/classes/packets.SdesChunk.html
diff --git a/docs/classes/packets.SdesPacket.html b/docs/classes/packets.SdesPacket.html
diff --git a/docs/classes/packets.SenderReportPacket.html b/docs/classes/packets.SenderReportPacket.html
diff --git a/docs/classes/packets.Serializable.html b/docs/classes/packets.Serializable.html
diff --git a/docs/classes/packets.SliPacket.html b/docs/classes/packets.SliPacket.html
diff --git a/docs/classes/packets.SrReqPacket.html b/docs/classes/packets.SrReqPacket.html
diff --git a/docs/classes/packets.VMExtendedReport.html b/docs/classes/packets.VMExtendedReport.html
diff --git a/docs/classes/packets.XrPacket.html b/docs/classes/packets.XrPacket.html
diff --git a/docs/enums/packets.ExtendedReportType.html b/docs/enums/packets.ExtendedReportType.html
diff --git a/docs/enums/packets.PsFeedbackMessageType.html b/docs/enums/packets.PsFeedbackMessageType.html
diff --git a/docs/enums/packets.RtcpPacketType.html b/docs/enums/packets.RtcpPacketType.html
diff --git a/docs/enums/packets.RtpExtensionType.html b/docs/enums/packets.RtpExtensionType.html
diff --git a/docs/enums/packets.RtpFeedbackMessageType.html b/docs/enums/packets.RtpFeedbackMessageType.html
diff --git a/docs/enums/packets.SdesItemType.html b/docs/enums/packets.SdesItemType.html
diff --git a/docs/functions/packets.createExtendedReportBitVectorChunk.html b/docs/functions/packets.createExtendedReportBitVectorChunk.html
diff --git a/docs/functions/packets.createExtendedReportRunLengthChunk.html b/docs/functions/packets.createExtendedReportRunLengthChunk.html
diff --git a/docs/functions/packets.createNackItem.html b/docs/functions/packets.createNackItem.html
diff --git a/docs/functions/packets.isRtcp.html b/docs/functions/packets.isRtcp.html
diff --git a/docs/functions/packets.isRtp.html b/docs/functions/packets.isRtp.html
diff --git a/docs/functions/packets.parseExtendedReportChunk.html b/docs/functions/packets.parseExtendedReportChunk.html
diff --git a/docs/functions/packets.parseNackItem.html b/docs/functions/packets.parseNackItem.html
diff --git a/docs/functions/packets.rtpExtensionUriToType.html b/docs/functions/packets.rtpExtensionUriToType.html
diff --git a/docs/functions/packets.timeMsToAbsSendTime.html b/docs/functions/packets.timeMsToAbsSendTime.html
diff --git a/docs/functions/utils.arrayBufferToNodeBuffer.html b/docs/functions/utils.arrayBufferToNodeBuffer.html
diff --git a/docs/functions/utils.arrayBufferToString.html b/docs/functions/utils.arrayBufferToString.html
diff --git a/docs/functions/utils.dataViewToNodeBuffer.html b/docs/functions/utils.dataViewToNodeBuffer.html
diff --git a/docs/functions/utils.dataViewToString.html b/docs/functions/utils.dataViewToString.html
diff --git a/docs/functions/utils.getStringByteLength.html b/docs/functions/utils.getStringByteLength.html
diff --git a/docs/functions/utils.nodeBufferToArrayBuffer.html b/docs/functions/utils.nodeBufferToArrayBuffer.html
diff --git a/docs/functions/utils.nodeBufferToDataView.html b/docs/functions/utils.nodeBufferToDataView.html
diff --git a/docs/functions/utils.numberToDataView.html b/docs/functions/utils.numberToDataView.html
diff --git a/docs/functions/utils.numericArrayToDataView.html b/docs/functions/utils.numericArrayToDataView.html
diff --git a/docs/functions/utils.padTo4Bytes.html b/docs/functions/utils.padTo4Bytes.html
diff --git a/docs/functions/utils.stringToDataView.html b/docs/functions/utils.stringToDataView.html
diff --git a/docs/hierarchy.html b/docs/hierarchy.html
diff --git a/docs/index.html b/docs/index.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>rtp.js - v0.11.4</title><meta name="description" content="Documentation for rtp.js"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css?cache=1704883783823"/><link rel="stylesheet" href="assets/highlight.css?cache=1704883783823"/><link rel="stylesheet" href="assets/custom.css?cache=1704883783823"/><script defer src="assets/main.js?cache=1704883783823"></script><script async src="assets/search.js?cache=1704883783823" id="tsd-search-script"></script><script async src="assets/navigation.js?cache=1704883783823" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/versatica/rtp.js">GitHub</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="https://versatica.github.io/rtp.js" class="title">rtp.js - v0.11.4</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>rtp.js - v0.11.4</h2></div><div class="tsd-panel tsd-typography"><a id="md:rtpjs" class="tsd-anchor"></a><h1><a href="#md:rtpjs">rtp.js</a></h1><p><a href="https://npmjs.org/package/rtp.js"><img src="https://img.shields.io/npm/v/rtp.js.svg" alt=""></a>
+<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>rtp.js - v0.11.4</title><meta name="description" content="Documentation for rtp.js"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css?cache=1704883961169"/><link rel="stylesheet" href="assets/highlight.css?cache=1704883961169"/><link rel="stylesheet" href="assets/custom.css?cache=1704883961169"/><script defer src="assets/main.js?cache=1704883961169"></script><script async src="assets/search.js?cache=1704883961169" id="tsd-search-script"></script><script async src="assets/navigation.js?cache=1704883961169" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/versatica/rtp.js">GitHub</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="https://versatica.github.io/rtp.js" class="title">rtp.js - v0.11.4</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>rtp.js - v0.11.4</h2></div><div class="tsd-panel tsd-typography"><a id="md:rtpjs" class="tsd-anchor"></a><h1><a href="#md:rtpjs">rtp.js</a></h1><p><a href="https://npmjs.org/package/rtp.js"><img src="https://img.shields.io/npm/v/rtp.js.svg" alt=""></a>
 <a href="https://github.com/versatica/rtp.js/actions/workflows/rtp.js.yaml"><img src="https://github.com/versatica/rtp.js/actions/workflows/rtp.js.yaml/badge.svg" alt=""></a></p>
 <p>RTP stack for Node.js and browser written in TypeScript. <strong>rtp.js</strong> provides with an API to parse, generate and modify RTP and RTCP packets.</p>
 <a id="md:installation" class="tsd-anchor"></a><h2><a href="#md:installation">Installation</a></h2><pre><code class="language-text">npm install rtp.js

diff --git a/docs/modules/packets.html b/docs/modules/packets.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>packets | rtp.js - v0.11.4</title><meta name="description" content="Documentation for rtp.js"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1704883783823"/><link rel="stylesheet" href="../assets/highlight.css?cache=1704883783823"/><link rel="stylesheet" href="../assets/custom.css?cache=1704883783823"/><script defer src="../assets/main.js?cache=1704883783823"></script><script async src="../assets/search.js?cache=1704883783823" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1704883783823" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/versatica/rtp.js">GitHub</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="https://versatica.github.io/rtp.js" class="title">rtp.js - v0.11.4</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">rtp.js</a></li><li><a href="packets.html">packets</a></li></ul><h1>Module packets</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/versatica/rtp.js/blob/1ef006e/src/packets/public.ts#L1">packets/public.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">RTP</h3><div class="tsd-index-list"><a href="../enums/packets.RtpExtensionType.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Rtp<wbr/>Extension<wbr/>Type</span></a>
+<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>packets | rtp.js - v0.11.4</title><meta name="description" content="Documentation for rtp.js"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css?cache=1704883961169"/><link rel="stylesheet" href="../assets/highlight.css?cache=1704883961169"/><link rel="stylesheet" href="../assets/custom.css?cache=1704883961169"/><script defer src="../assets/main.js?cache=1704883961169"></script><script async src="../assets/search.js?cache=1704883961169" id="tsd-search-script"></script><script async src="../assets/navigation.js?cache=1704883961169" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/versatica/rtp.js">GitHub</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="https://versatica.github.io/rtp.js" class="title">rtp.js - v0.11.4</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">rtp.js</a></li><li><a href="packets.html">packets</a></li></ul><h1>Module packets</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/versatica/rtp.js/blob/1aa060c/src/packets/public.ts#L1">packets/public.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">RTP</h3><div class="tsd-index-list"><a href="../enums/packets.RtpExtensionType.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Rtp<wbr/>Extension<wbr/>Type</span></a>
 <a href="../classes/packets.RtpPacket.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Rtp<wbr/>Packet</span></a>
 <a href="../types/packets.RtpExtensionMapping.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Rtp<wbr/>Extension<wbr/>Mapping</span></a>
 <a href="../types/packets.RtpPacketDump.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Rtp<wbr/>Packet<wbr/>Dump</span></a>