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 23, 2023
1 parent 1236310 commit 58b08ac
Show file tree
Hide file tree
Showing 91 changed files with 679 additions and 685 deletions.
34 changes: 17 additions & 17 deletions docs/classes/packets.ByePacket.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">ByePacket</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/d87c5b0/src/packets/RTCP/ByePacket.ts#L46">packets/RTCP/ByePacket.ts:46</a></li></ul></aside>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/1236310/src/packets/RTCP/ByePacket.ts#L46">packets/RTCP/ByePacket.ts:46</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 @@ -95,7 +95,7 @@ <h4>Throws</h4><ul>
</div><aside class="tsd-sources">
<p>Overrides RtcpPacket.constructor</p>
<ul>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/d87c5b0/src/packets/RTCP/ByePacket.ts#L60">packets/RTCP/ByePacket.ts:60</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/1236310/src/packets/RTCP/ByePacket.ts#L60">packets/RTCP/ByePacket.ts:60</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member"><a id="addSsrc" class="tsd-anchor"></a>
Expand All @@ -117,7 +117,7 @@ <h4>Remarks</h4><ul>
</ul>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/d87c5b0/src/packets/RTCP/ByePacket.ts#L270">packets/RTCP/ByePacket.ts:270</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/1236310/src/packets/RTCP/ByePacket.ts#L270">packets/RTCP/ByePacket.ts:270</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="clone" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>clone</span><a href="#clone" 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 Down Expand Up @@ -171,7 +171,7 @@ <h4>Throws</h4><ul>
</div><aside class="tsd-sources">
<p>Overrides <a href="packets.RtcpPacket.html">RtcpPacket</a>.<a href="packets.RtcpPacket.html#clone">clone</a></p>
<ul>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/d87c5b0/src/packets/RTCP/ByePacket.ts#L223">packets/RTCP/ByePacket.ts:223</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/1236310/src/packets/RTCP/ByePacket.ts#L223">packets/RTCP/ByePacket.ts:223</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 @@ -183,7 +183,7 @@ <h4 class="tsd-returns-title">Returns <a href="../types/packets.ByePacketDump.ht
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Overrides <a href="packets.RtcpPacket.html">RtcpPacket</a>.<a href="packets.RtcpPacket.html#dump">dump</a></p>
<ul>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/d87c5b0/src/packets/RTCP/ByePacket.ts#L125">packets/RTCP/ByePacket.ts:125</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/1236310/src/packets/RTCP/ByePacket.ts#L125">packets/RTCP/ByePacket.ts:125</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"><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 @@ -201,7 +201,7 @@ <h4>Remarks</h4><ul>
</div><aside class="tsd-sources">
<p>Overrides <a href="packets.RtcpPacket.html">RtcpPacket</a>.<a href="packets.RtcpPacket.html#getByteLength">getByteLength</a></p>
<ul>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/d87c5b0/src/packets/RTCP/ByePacket.ts#L137">packets/RTCP/ByePacket.ts:137</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/1236310/src/packets/RTCP/ByePacket.ts#L137">packets/RTCP/ByePacket.ts:137</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getCount" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Count</span><a href="#getCount" 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 tsd-is-inherited">
Expand All @@ -218,7 +218,7 @@ <h4>Remarks</h4><ul>
</div><aside class="tsd-sources">
<p>Inherited from <a href="packets.RtcpPacket.html">RtcpPacket</a>.<a href="packets.RtcpPacket.html#getCount">getCount</a></p>
<ul>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/d87c5b0/src/packets/RTCP/RtcpPacket.ts#L293">packets/RTCP/RtcpPacket.ts:293</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/1236310/src/packets/RTCP/RtcpPacket.ts#L293">packets/RTCP/RtcpPacket.ts:293</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getPacketType" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Packet<wbr/>Type</span><a href="#getPacketType" 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 tsd-is-inherited">
Expand All @@ -230,7 +230,7 @@ <h4 class="tsd-returns-title">Returns <a href="../enums/packets.RtcpPacketType.h
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from <a href="packets.RtcpPacket.html">RtcpPacket</a>.<a href="packets.RtcpPacket.html#getPacketType">getPacketType</a></p>
<ul>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/d87c5b0/src/packets/RTCP/RtcpPacket.ts#L281">packets/RTCP/RtcpPacket.ts:281</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/1236310/src/packets/RTCP/RtcpPacket.ts#L281">packets/RTCP/RtcpPacket.ts:281</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><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 tsd-is-inherited">
Expand All @@ -242,7 +242,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</s
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from <a href="packets.RtcpPacket.html">RtcpPacket</a>.<a href="packets.RtcpPacket.html#getPadding">getPadding</a></p>
<ul>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/d87c5b0/src/packets/Packet.ts#L52">packets/Packet.ts:52</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/1236310/src/packets/Packet.ts#L52">packets/Packet.ts:52</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="getReason" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Reason</span><a href="#getReason" 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 @@ -253,7 +253,7 @@ <h3 class="tsd-anchor-link"><span>get<wbr/>Reason</span><a href="#getReason" ari
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</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/d87c5b0/src/packets/RTCP/ByePacket.ts#L283">packets/RTCP/ByePacket.ts:283</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/1236310/src/packets/RTCP/ByePacket.ts#L283">packets/RTCP/ByePacket.ts:283</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="getSsrcs" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Ssrcs</span><a href="#getSsrcs" 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 @@ -264,7 +264,7 @@ <h3 class="tsd-anchor-link"><span>get<wbr/>Ssrcs</span><a href="#getSsrcs" aria-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</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/d87c5b0/src/packets/RTCP/ByePacket.ts#L243">packets/RTCP/ByePacket.ts:243</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/1236310/src/packets/RTCP/ByePacket.ts#L243">packets/RTCP/ByePacket.ts:243</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><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 tsd-is-inherited">
Expand Down Expand Up @@ -302,7 +302,7 @@ <h4>Throws</h4><ul>
</div><aside class="tsd-sources">
<p>Inherited from <a href="packets.RtcpPacket.html">RtcpPacket</a>.<a href="packets.RtcpPacket.html#getView">getView</a></p>
<ul>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/d87c5b0/src/packets/Serializable.ts#L58">packets/Serializable.ts:58</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/1236310/src/packets/Serializable.ts#L58">packets/Serializable.ts:58</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><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 tsd-is-inherited">
Expand All @@ -317,7 +317,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<p>Inherited from <a href="packets.RtcpPacket.html">RtcpPacket</a>.<a href="packets.RtcpPacket.html#needsSerialization">needsSerialization</a></p>
<ul>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/d87c5b0/src/packets/Serializable.ts#L87">packets/Serializable.ts:87</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/1236310/src/packets/Serializable.ts#L87">packets/Serializable.ts:87</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><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 tsd-is-inherited">
Expand All @@ -334,7 +334,7 @@ <h4>Remarks</h4><ul>
</div><aside class="tsd-sources">
<p>Inherited from <a href="packets.RtcpPacket.html">RtcpPacket</a>.<a href="packets.RtcpPacket.html#padTo4Bytes">padTo4Bytes</a></p>
<ul>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/d87c5b0/src/packets/Packet.ts#L64">packets/Packet.ts:64</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/1236310/src/packets/Packet.ts#L64">packets/Packet.ts:64</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"><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 Down Expand Up @@ -373,7 +373,7 @@ <h4>Throws</h4><ul>
</div><aside class="tsd-sources">
<p>Overrides <a href="packets.RtcpPacket.html">RtcpPacket</a>.<a href="packets.RtcpPacket.html#serialize">serialize</a></p>
<ul>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/d87c5b0/src/packets/RTCP/ByePacket.ts#L162">packets/RTCP/ByePacket.ts:162</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/1236310/src/packets/RTCP/ByePacket.ts#L162">packets/RTCP/ByePacket.ts:162</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="setReason" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>set<wbr/>Reason</span><a href="#setReason" 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 @@ -389,7 +389,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</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/d87c5b0/src/packets/RTCP/ByePacket.ts#L291">packets/RTCP/ByePacket.ts:291</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/1236310/src/packets/RTCP/ByePacket.ts#L291">packets/RTCP/ByePacket.ts:291</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="setSsrcs" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>set<wbr/>Ssrcs</span><a href="#setSsrcs" 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 @@ -409,7 +409,7 @@ <h4>Remarks</h4><ul>
</ul>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/d87c5b0/src/packets/RTCP/ByePacket.ts#L254">packets/RTCP/ByePacket.ts:254</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/versatica/rtp.js/blob/1236310/src/packets/RTCP/ByePacket.ts#L254">packets/RTCP/ByePacket.ts:254</a></li></ul></aside></li></ul></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
Loading

0 comments on commit 58b08ac

Please sign in to comment.