Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@ibc
ibc committed Aug 4, 2023
1 parent eafcb2f commit 30206da
Show file tree
Hide file tree
Showing 23 changed files with 963 additions and 131 deletions.
2 changes: 1 addition & 1 deletion docs/assets/search.js
View file

Large diffs are not rendered by default.

40 changes: 23 additions & 17 deletions docs/classes/ByePacket.html
View file

Large diffs are not rendered by default.

26 changes: 16 additions & 10 deletions docs/classes/Packet.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ <h4>Hierarchy</h4>
<li><a href="RtpPacket.html" class="tsd-signature-type tsd-kind-class">RtpPacket</a></li>
<li><a href="RtcpPacket.html" class="tsd-signature-type tsd-kind-class">RtcpPacket</a></li></ul></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/a6c3ab1/src/Packet.ts#L60">Packet.ts:60</a></li></ul></aside>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/eafcb2f/src/Packet.ts#L60">Packet.ts:60</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand Down Expand Up @@ -97,7 +97,7 @@ <h4>Throws</h4><ul>
</ul>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/a6c3ab1/src/Packet.ts#L201">Packet.ts:201</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/eafcb2f/src/Packet.ts#L201">Packet.ts:201</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="dump" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>dump</span><a href="#dump" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
Expand All @@ -112,7 +112,7 @@ <h4>Remarks</h4><ul>
</ul>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/a6c3ab1/src/Packet.ts#L76">Packet.ts:76</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/eafcb2f/src/Packet.ts#L76">Packet.ts:76</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="getByteLength" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagAbstract">Abstract</code> <span>get<wbr/>Byte<wbr/>Length</span><a href="#getByteLength" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
Expand All @@ -123,7 +123,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagAbstract">Abstract</code
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/a6c3ab1/src/Packet.ts#L107">Packet.ts:107</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/eafcb2f/src/Packet.ts#L107">Packet.ts:107</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="getPadding" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Padding</span><a href="#getPadding" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
Expand All @@ -134,7 +134,7 @@ <h3 class="tsd-anchor-link"><span>get<wbr/>Padding</span><a href="#getPadding" a
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/a6c3ab1/src/Packet.ts#L112">Packet.ts:112</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/eafcb2f/src/Packet.ts#L112">Packet.ts:112</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="getView" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>View</span><a href="#getView" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
Expand All @@ -154,7 +154,7 @@ <h4>Throws</h4><ul>
</ul>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/a6c3ab1/src/Packet.ts#L94">Packet.ts:94</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/eafcb2f/src/Packet.ts#L94">Packet.ts:94</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="needsSerialization" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>needs<wbr/>Serialization</span><a href="#needsSerialization" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
Expand All @@ -166,7 +166,7 @@ <h3 class="tsd-anchor-link"><span>needs<wbr/>Serialization</span><a href="#needs
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/a6c3ab1/src/Packet.ts#L165">Packet.ts:165</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/eafcb2f/src/Packet.ts#L165">Packet.ts:165</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="padTo4Bytes" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>pad<wbr/>To4<wbr/>Bytes</span><a href="#padTo4Bytes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
Expand All @@ -182,7 +182,7 @@ <h4>Remarks</h4><ul>
</ul>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/a6c3ab1/src/Packet.ts#L145">Packet.ts:145</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/eafcb2f/src/Packet.ts#L145">Packet.ts:145</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="serialize" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagAbstract">Abstract</code> <span>serialize</span><a href="#serialize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
Expand All @@ -204,7 +204,7 @@ <h4>Throws</h4><ul>
</ul>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/a6c3ab1/src/Packet.ts#L182">Packet.ts:182</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/eafcb2f/src/Packet.ts#L182">Packet.ts:182</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="setPadding" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>set<wbr/>Padding</span><a href="#setPadding" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
Expand All @@ -224,7 +224,7 @@ <h4>Remarks</h4><ul>
</ul>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/a6c3ab1/src/Packet.ts#L123">Packet.ts:123</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/eafcb2f/src/Packet.ts#L123">Packet.ts:123</a></li></ul></aside></li></ul></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
Expand Down Expand Up @@ -265,6 +265,9 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="RtpPacket.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>
<div>Rtp<wbr/>Packet
<div class="menu-item-desc">RTP packet.</div></div></a></li>
<li><a href="SenderReportPacket.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>
<div>Sender<wbr/>Report<wbr/>Packet
<div class="menu-item-desc">RTCP Sender Report packet.</div></div></a></li>
<li><a href="../types/ByePacketDump.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4194304"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg>
<div>Bye<wbr/>Packet<wbr/>Dump
<div class="menu-item-desc">RTCP Bye packet info dump.</div></div></a></li>
Expand All @@ -286,6 +289,9 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="../types/RtpPacketDump.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg>
<div>Rtp<wbr/>Packet<wbr/>Dump
<div class="menu-item-desc">RTP packet info dump.</div></div></a></li>
<li><a href="../types/SenderReportPacketDump.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg>
<div>Sender<wbr/>Report<wbr/>Packet<wbr/>Dump
<div class="menu-item-desc">RTCP Sender Report packet info dump.</div></div></a></li>
<li><a href="../types/WillSerializePacketEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg>
<div>Will<wbr/>Serialize<wbr/>Packet<wbr/>Event
<div class="menu-item-desc">Event emitted when the packet is being serialized. The user has a chance to</div></div></a></li>
Expand Down
Loading

0 comments on commit 30206da

Please sign in to comment.