Histmy/play-dl-fix
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Some more changes

Browse Source
This commit is contained in:
killer069 2021-11-18 16:32:54 +05:30
parent 241884d69c
commit 56b1ebeef7
50 changed files with 475 additions and 221 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/assets/search.js
View File

File diff suppressed because one or more lines are too long

2
docs/classes/SoundCloudStream.html
View File

File diff suppressed because one or more lines are too long

6
docs/classes/_internal_.DeezerAlbum.html
View File

File diff suppressed because one or more lines are too long

2
docs/classes/_internal_.DeezerArtist.html
View File

File diff suppressed because one or more lines are too long

4
docs/classes/_internal_.DeezerPlaylist.html
View File

File diff suppressed because one or more lines are too long

6
docs/classes/_internal_.DeezerTrack.html
View File

File diff suppressed because one or more lines are too long

2
docs/classes/_internal_.DeezerTrackAlbum.html
View File

File diff suppressed because one or more lines are too long

36
docs/classes/_internal_.LiveStream.html
View File

@ -1,6 +1,6 @@
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>LiveStream | play-dl</title><meta name="description" content="Documentation for play-dl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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="../index.html" class="title">play-dl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">play-dl</a></li><li><a href="../modules/_internal_.html">&lt;internal&gt;</a></li><li><a href="_internal_.LiveStream.html">LiveStream</a></li></ul><h1>Class LiveStream</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Live Stream class for playing audio from Live Stream videos.</p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">LiveStream</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_internal_.LiveStream.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.LiveStream.html#base_url" class="tsd-kind-icon">base_<wbr/>url</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.LiveStream.html#dash_timer" class="tsd-kind-icon">dash_<wbr/>timer</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.LiveStream.html#interval" class="tsd-kind-icon">interval</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.LiveStream.html#packet_count" class="tsd-kind-icon">packet_<wbr/>count</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.LiveStream.html#request" class="tsd-kind-icon">request</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.LiveStream.html#segments_urls" class="tsd-kind-icon">segments_<wbr/>urls</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.LiveStream.html#stream" class="tsd-kind-icon">stream</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.LiveStream.html#timer" class="tsd-kind-icon">timer</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.LiveStream.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.LiveStream.html#url" class="tsd-kind-icon">url</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.LiveStream.html#video_url" class="tsd-kind-icon">video_<wbr/>url</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_internal_.LiveStream.html#cleanup" class="tsd-kind-icon">cleanup</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_internal_.LiveStream.html#dash_getter" class="tsd-kind-icon">dash_<wbr/>getter</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_internal_.LiveStream.html#dash_updater" class="tsd-kind-icon">dash_<wbr/>updater</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.LiveStream.html#pause" class="tsd-kind-icon">pause</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.LiveStream.html#resume" class="tsd-kind-icon">resume</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_internal_.LiveStream.html#start" class="tsd-kind-icon">start</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Live<wbr/>Stream<span class="tsd-signature-symbol">(</span>dash_url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, target_interval<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, video_url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.LiveStream.html" class="tsd-signature-type" data-tsd-kind="Class">LiveStream</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/LiveStream.ts#L73">play-dl/YouTube/classes/LiveStream.ts:73</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">LiveStream</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_internal_.LiveStream.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.LiveStream.html#base_url" class="tsd-kind-icon">base_<wbr/>url</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.LiveStream.html#dash_timer" class="tsd-kind-icon">dash_<wbr/>timer</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.LiveStream.html#interval" class="tsd-kind-icon">interval</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.LiveStream.html#packet_count" class="tsd-kind-icon">packet_<wbr/>count</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.LiveStream.html#request" class="tsd-kind-icon">request</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.LiveStream.html#segments_urls" class="tsd-kind-icon">segments_<wbr/>urls</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.LiveStream.html#stream" class="tsd-kind-icon">stream</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.LiveStream.html#timer" class="tsd-kind-icon">timer</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.LiveStream.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.LiveStream.html#url" class="tsd-kind-icon">url</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.LiveStream.html#video_url" class="tsd-kind-icon">video_<wbr/>url</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_internal_.LiveStream.html#cleanup" class="tsd-kind-icon">cleanup</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_internal_.LiveStream.html#dash_getter" class="tsd-kind-icon">dash_<wbr/>getter</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_internal_.LiveStream.html#dash_updater" class="tsd-kind-icon">dash_<wbr/>updater</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.LiveStream.html#pause" class="tsd-kind-icon">pause</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.LiveStream.html#resume" class="tsd-kind-icon">resume</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_internal_.LiveStream.html#start" class="tsd-kind-icon">start</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Live<wbr/>Stream<span class="tsd-signature-symbol">(</span>dash_url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, target_interval<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, video_url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.LiveStream.html" class="tsd-signature-type" data-tsd-kind="Class">LiveStream</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/LiveStream.ts#L73">play-dl/YouTube/classes/LiveStream.ts:73</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Live Stream Class Constructor</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>dash_url: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>dash manifest URL</p>
@ -8,46 +8,46 @@
<p>interval time for fetching dash data again</p>
</div></div></li><li><h5>video_url: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Live Stream video url.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.LiveStream.html" class="tsd-signature-type" data-tsd-kind="Class">LiveStream</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="base_url" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> base_<wbr/>url</h3><div class="tsd-signature tsd-kind-icon">base_<wbr/>url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/LiveStream.ts#L27">play-dl/YouTube/classes/LiveStream.ts:27</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.LiveStream.html" class="tsd-signature-type" data-tsd-kind="Class">LiveStream</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="base_url" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> base_<wbr/>url</h3><div class="tsd-signature tsd-kind-icon">base_<wbr/>url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/LiveStream.ts#L27">play-dl/YouTube/classes/LiveStream.ts:27</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Base URL in dash manifest file.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="dash_timer" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> dash_<wbr/>timer</h3><div class="tsd-signature tsd-kind-icon">dash_<wbr/>timer<span class="tsd-signature-symbol">:</span> <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace">&lt;internal&gt;</a><span class="tsd-signature-symbol">.</span><a href="_internal_.Timer.html" class="tsd-signature-type" data-tsd-kind="Class">Timer</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/LiveStream.ts#L53">play-dl/YouTube/classes/LiveStream.ts:53</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="dash_timer" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> dash_<wbr/>timer</h3><div class="tsd-signature tsd-kind-icon">dash_<wbr/>timer<span class="tsd-signature-symbol">:</span> <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace">&lt;internal&gt;</a><span class="tsd-signature-symbol">.</span><a href="_internal_.Timer.html" class="tsd-signature-type" data-tsd-kind="Class">Timer</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/LiveStream.ts#L53">play-dl/YouTube/classes/LiveStream.ts:53</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Timer used to update dash url so as to avoid 404 errors after long hours of streaming.</p>
</div><div><p>It updates dash_url every 30 minutes.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="interval" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> interval</h3><div class="tsd-signature tsd-kind-icon">interval<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/LiveStream.ts#L35">play-dl/YouTube/classes/LiveStream.ts:35</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="interval" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> interval</h3><div class="tsd-signature tsd-kind-icon">interval<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/LiveStream.ts#L35">play-dl/YouTube/classes/LiveStream.ts:35</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Interval to fetch data again to dash url.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="packet_count" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> packet_<wbr/>count</h3><div class="tsd-signature tsd-kind-icon">packet_<wbr/>count<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/LiveStream.ts#L39">play-dl/YouTube/classes/LiveStream.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="packet_count" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> packet_<wbr/>count</h3><div class="tsd-signature tsd-kind-icon">packet_<wbr/>count<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/LiveStream.ts#L39">play-dl/YouTube/classes/LiveStream.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Sequence count of urls in dash file.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="request" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> request</h3><div class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="_internal_.IncomingMessage.html" class="tsd-signature-type" data-tsd-kind="Class">IncomingMessage</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/LiveStream.ts#L66">play-dl/YouTube/classes/LiveStream.ts:66</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="request" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> request</h3><div class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="_internal_.IncomingMessage.html" class="tsd-signature-type" data-tsd-kind="Class">IncomingMessage</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/LiveStream.ts#L66">play-dl/YouTube/classes/LiveStream.ts:66</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Incoming message that we recieve.</p>
</div><div><p>Storing this is essential.
This helps to destroy the TCP connection completely if you stopped player in between the stream</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="segments_urls" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> segments_<wbr/>urls</h3><div class="tsd-signature tsd-kind-icon">segments_<wbr/>urls<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/LiveStream.ts#L59">play-dl/YouTube/classes/LiveStream.ts:59</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="segments_urls" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> segments_<wbr/>urls</h3><div class="tsd-signature tsd-kind-icon">segments_<wbr/>urls<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/LiveStream.ts#L59">play-dl/YouTube/classes/LiveStream.ts:59</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Segments of url that we recieve in dash file.</p>
</div><div><p>base_url + segment_urls[0] = One complete url for one segment.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="stream" class="tsd-anchor"></a><h3>stream</h3><div class="tsd-signature tsd-kind-icon">stream<span class="tsd-signature-symbol">:</span> <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace">&lt;internal&gt;</a><span class="tsd-signature-symbol">.</span><a href="_internal_.Readable.html" class="tsd-signature-type" data-tsd-kind="Class">Readable</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/LiveStream.ts#L19">play-dl/YouTube/classes/LiveStream.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="stream" class="tsd-anchor"></a><h3>stream</h3><div class="tsd-signature tsd-kind-icon">stream<span class="tsd-signature-symbol">:</span> <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace">&lt;internal&gt;</a><span class="tsd-signature-symbol">.</span><a href="_internal_.Readable.html" class="tsd-signature-type" data-tsd-kind="Class">Readable</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/LiveStream.ts#L19">play-dl/YouTube/classes/LiveStream.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Readable Stream through which data passes</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="timer" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> timer</h3><div class="tsd-signature tsd-kind-icon">timer<span class="tsd-signature-symbol">:</span> <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace">&lt;internal&gt;</a><span class="tsd-signature-symbol">.</span><a href="_internal_.Timer.html" class="tsd-signature-type" data-tsd-kind="Class">Timer</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/LiveStream.ts#L43">play-dl/YouTube/classes/LiveStream.ts:43</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="timer" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> timer</h3><div class="tsd-signature tsd-kind-icon">timer<span class="tsd-signature-symbol">:</span> <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace">&lt;internal&gt;</a><span class="tsd-signature-symbol">.</span><a href="_internal_.Timer.html" class="tsd-signature-type" data-tsd-kind="Class">Timer</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/LiveStream.ts#L43">play-dl/YouTube/classes/LiveStream.ts:43</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Timer that creates loop from interval time provided.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../enums/_internal_.StreamType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">StreamType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/LiveStream.ts#L23">play-dl/YouTube/classes/LiveStream.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../enums/_internal_.StreamType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">StreamType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/LiveStream.ts#L23">play-dl/YouTube/classes/LiveStream.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Type of audio data that we recieved from live stream youtube url.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="url" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> url</h3><div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/LiveStream.ts#L31">play-dl/YouTube/classes/LiveStream.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="url" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> url</h3><div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/LiveStream.ts#L31">play-dl/YouTube/classes/LiveStream.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Given Dash URL.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="video_url" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> video_<wbr/>url</h3><div class="tsd-signature tsd-kind-icon">video_<wbr/>url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/LiveStream.ts#L47">play-dl/YouTube/classes/LiveStream.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="video_url" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> video_<wbr/>url</h3><div class="tsd-signature tsd-kind-icon">video_<wbr/>url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/LiveStream.ts#L47">play-dl/YouTube/classes/LiveStream.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Live Stream Video url.</p>
</div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="cleanup" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> cleanup</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">cleanup<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/LiveStream.ts#L132">play-dl/YouTube/classes/LiveStream.ts:132</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="cleanup" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> cleanup</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">cleanup<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/LiveStream.ts#L132">play-dl/YouTube/classes/LiveStream.ts:132</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>This cleans every used variable in class.</p>
</div><div><p>This is used to prevent re-use of this class and helping garbage collector to collect it.</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="dash_getter" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> dash_<wbr/>getter</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">dash_<wbr/>getter<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace">&lt;internal&gt;</a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Promise-1" class="tsd-signature-type" data-tsd-kind="Variable">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/LiveStream.ts#L115">play-dl/YouTube/classes/LiveStream.ts:115</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="dash_getter" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> dash_<wbr/>getter</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">dash_<wbr/>getter<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace">&lt;internal&gt;</a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Promise-1" class="tsd-signature-type" data-tsd-kind="Variable">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/LiveStream.ts#L115">play-dl/YouTube/classes/LiveStream.ts:115</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Parses data recieved from dash_url.</p>
</div><div><p>Updates base_url , segments_urls array.</p>
</div></div><h4 class="tsd-returns-title">Returns <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace">&lt;internal&gt;</a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Promise-1" class="tsd-signature-type" data-tsd-kind="Variable">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="dash_updater" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> dash_<wbr/>updater</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">dash_<wbr/>updater<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace">&lt;internal&gt;</a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Promise-1" class="tsd-signature-type" data-tsd-kind="Variable">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/LiveStream.ts#L100">play-dl/YouTube/classes/LiveStream.ts:100</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div><h4 class="tsd-returns-title">Returns <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace">&lt;internal&gt;</a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Promise-1" class="tsd-signature-type" data-tsd-kind="Variable">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="dash_updater" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> dash_<wbr/>updater</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">dash_<wbr/>updater<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace">&lt;internal&gt;</a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Promise-1" class="tsd-signature-type" data-tsd-kind="Variable">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/LiveStream.ts#L100">play-dl/YouTube/classes/LiveStream.ts:100</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Updates dash url.</p>
</div><div><p>Used by dash_timer for updating dash_url every 30 minutes.</p>
</div></div><h4 class="tsd-returns-title">Returns <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace">&lt;internal&gt;</a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Promise-1" class="tsd-signature-type" data-tsd-kind="Variable">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="pause" class="tsd-anchor"></a><h3>pause</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">pause<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/LiveStream.ts#L187">play-dl/YouTube/classes/LiveStream.ts:187</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div><h4 class="tsd-returns-title">Returns <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace">&lt;internal&gt;</a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Promise-1" class="tsd-signature-type" data-tsd-kind="Variable">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="pause" class="tsd-anchor"></a><h3>pause</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">pause<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/LiveStream.ts#L187">play-dl/YouTube/classes/LiveStream.ts:187</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Deprecated Functions</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="resume" class="tsd-anchor"></a><h3>resume</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">resume<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/LiveStream.ts#L191">play-dl/YouTube/classes/LiveStream.ts:191</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="resume" class="tsd-anchor"></a><h3>resume</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">resume<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/LiveStream.ts#L191">play-dl/YouTube/classes/LiveStream.ts:191</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Deprecated Functions</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="start" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> start</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace">&lt;internal&gt;</a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Promise-1" class="tsd-signature-type" data-tsd-kind="Variable">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/LiveStream.ts#L150">play-dl/YouTube/classes/LiveStream.ts:150</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="start" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> start</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace">&lt;internal&gt;</a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Promise-1" class="tsd-signature-type" data-tsd-kind="Variable">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/LiveStream.ts#L150">play-dl/YouTube/classes/LiveStream.ts:150</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>This starts function in Live Stream Class.</p>
</div><div><p>Gets data from dash url and pass it to dash getter function.
Get data from complete segment url and pass data to Stream.</p>

2
docs/classes/_internal_.SoundCloudPlaylist.html
View File

File diff suppressed because one or more lines are too long

2
docs/classes/_internal_.SoundCloudTrack.html
View File

File diff suppressed because one or more lines are too long

2
docs/classes/_internal_.SpotifyAlbum.html
View File

File diff suppressed because one or more lines are too long

39
docs/classes/_internal_.SpotifyPlaylist.html
View File

File diff suppressed because one or more lines are too long

27
docs/classes/_internal_.SpotifyTrack.html
View File

File diff suppressed because one or more lines are too long

34
docs/classes/_internal_.Stream.html
View File

File diff suppressed because one or more lines are too long

24
docs/classes/_internal_.Timer.html
View File

@ -1,36 +1,36 @@
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Timer | play-dl</title><meta name="description" content="Documentation for play-dl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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="../index.html" class="title">play-dl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">play-dl</a></li><li><a href="../modules/_internal_.html">&lt;internal&gt;</a></li><li><a href="_internal_.Timer.html">Timer</a></li></ul><h1>Class Timer</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
<p>Timer Class.</p>
</div><div><p>setTimeout + extra features ( re-starting, pausing, resuming ).</p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Timer</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_internal_.Timer.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-private tsd-is-private-protected"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.Timer.html#callback" class="tsd-kind-icon">callback</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.Timer.html#destroyed" class="tsd-kind-icon">destroyed</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.Timer.html#paused" class="tsd-kind-icon">paused</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.Timer.html#time_left" class="tsd-kind-icon">time_<wbr/>left</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.Timer.html#time_start" class="tsd-kind-icon">time_<wbr/>start</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.Timer.html#time_total" class="tsd-kind-icon">time_<wbr/>total</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.Timer.html#timer" class="tsd-kind-icon">timer</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.Timer.html#destroy" class="tsd-kind-icon">destroy</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.Timer.html#pause" class="tsd-kind-icon">pause</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.Timer.html#resume" class="tsd-kind-icon">resume</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.Timer.html#reuse" class="tsd-kind-icon">reuse</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Timer<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span>, time<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace">&lt;internal&gt;</a><span class="tsd-signature-symbol">.</span><a href="_internal_.Timer.html" class="tsd-signature-type" data-tsd-kind="Class">Timer</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/LiveStream.ts#L410">play-dl/YouTube/classes/LiveStream.ts:410</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Timer</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_internal_.Timer.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-private tsd-is-private-protected"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.Timer.html#callback" class="tsd-kind-icon">callback</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.Timer.html#destroyed" class="tsd-kind-icon">destroyed</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.Timer.html#paused" class="tsd-kind-icon">paused</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.Timer.html#time_left" class="tsd-kind-icon">time_<wbr/>left</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.Timer.html#time_start" class="tsd-kind-icon">time_<wbr/>start</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.Timer.html#time_total" class="tsd-kind-icon">time_<wbr/>total</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.Timer.html#timer" class="tsd-kind-icon">timer</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.Timer.html#destroy" class="tsd-kind-icon">destroy</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.Timer.html#pause" class="tsd-kind-icon">pause</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.Timer.html#resume" class="tsd-kind-icon">resume</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.Timer.html#reuse" class="tsd-kind-icon">reuse</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Timer<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span>, time<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace">&lt;internal&gt;</a><span class="tsd-signature-symbol">.</span><a href="_internal_.Timer.html" class="tsd-signature-type" data-tsd-kind="Class">Timer</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/LiveStream.ts#L410">play-dl/YouTube/classes/LiveStream.ts:410</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Constructor for Timer Class</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>callback: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Function to execute when timer is up.</p>
</div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li><h5>time: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Total time to wait before execution.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace">&lt;internal&gt;</a><span class="tsd-signature-symbol">.</span><a href="_internal_.Timer.html" class="tsd-signature-type" data-tsd-kind="Class">Timer</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="callback" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> callback</h3><div class="tsd-signature tsd-kind-icon">callback<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/LiveStream.ts#L392">play-dl/YouTube/classes/LiveStream.ts:392</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace">&lt;internal&gt;</a><span class="tsd-signature-symbol">.</span><a href="_internal_.Timer.html" class="tsd-signature-type" data-tsd-kind="Class">Timer</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="callback" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> callback</h3><div class="tsd-signature tsd-kind-icon">callback<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/LiveStream.ts#L392">play-dl/YouTube/classes/LiveStream.ts:392</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
<p>Callback to be executed once timer finishes.</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="destroyed" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> destroyed</h3><div class="tsd-signature tsd-kind-icon">destroyed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/LiveStream.ts#L380">play-dl/YouTube/classes/LiveStream.ts:380</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="destroyed" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> destroyed</h3><div class="tsd-signature tsd-kind-icon">destroyed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/LiveStream.ts#L380">play-dl/YouTube/classes/LiveStream.ts:380</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Boolean for checking if Timer is destroyed or not.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="paused" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> paused</h3><div class="tsd-signature tsd-kind-icon">paused<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/LiveStream.ts#L384">play-dl/YouTube/classes/LiveStream.ts:384</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="paused" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> paused</h3><div class="tsd-signature tsd-kind-icon">paused<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/LiveStream.ts#L384">play-dl/YouTube/classes/LiveStream.ts:384</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Boolean for checking if Timer is paused or not.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="time_left" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> time_<wbr/>left</h3><div class="tsd-signature tsd-kind-icon">time_<wbr/>left<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/LiveStream.ts#L400">play-dl/YouTube/classes/LiveStream.ts:400</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="time_left" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> time_<wbr/>left</h3><div class="tsd-signature tsd-kind-icon">time_<wbr/>left<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/LiveStream.ts#L400">play-dl/YouTube/classes/LiveStream.ts:400</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Total time left.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="time_start" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> time_<wbr/>start</h3><div class="tsd-signature tsd-kind-icon">time_<wbr/>start<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/LiveStream.ts#L396">play-dl/YouTube/classes/LiveStream.ts:396</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="time_start" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> time_<wbr/>start</h3><div class="tsd-signature tsd-kind-icon">time_<wbr/>start<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/LiveStream.ts#L396">play-dl/YouTube/classes/LiveStream.ts:396</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Seconds time when it is started.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="time_total" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> time_<wbr/>total</h3><div class="tsd-signature tsd-kind-icon">time_<wbr/>total<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/LiveStream.ts#L404">play-dl/YouTube/classes/LiveStream.ts:404</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="time_total" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> time_<wbr/>total</h3><div class="tsd-signature tsd-kind-icon">time_<wbr/>total<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/LiveStream.ts#L404">play-dl/YouTube/classes/LiveStream.ts:404</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Total time given by user [ Used only for re-using timer. ]</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="timer" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> timer</h3><div class="tsd-signature tsd-kind-icon">timer<span class="tsd-signature-symbol">:</span> <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace">&lt;internal&gt;</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_internal_.Timer-1.html" class="tsd-signature-type" data-tsd-kind="Interface">Timer</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/LiveStream.ts#L388">play-dl/YouTube/classes/LiveStream.ts:388</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="timer" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> timer</h3><div class="tsd-signature tsd-kind-icon">timer<span class="tsd-signature-symbol">:</span> <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace">&lt;internal&gt;</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_internal_.Timer-1.html" class="tsd-signature-type" data-tsd-kind="Interface">Timer</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/LiveStream.ts#L388">play-dl/YouTube/classes/LiveStream.ts:388</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>setTimeout function</p>
</div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="destroy" class="tsd-anchor"></a><h3>destroy</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/LiveStream.ts#L462">play-dl/YouTube/classes/LiveStream.ts:462</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="destroy" class="tsd-anchor"></a><h3>destroy</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/LiveStream.ts#L462">play-dl/YouTube/classes/LiveStream.ts:462</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Destroy timer.</p>
</div><div><p>It can&#39;t be used again.</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="pause" class="tsd-anchor"></a><h3>pause</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">pause<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/LiveStream.ts#L423">play-dl/YouTube/classes/LiveStream.ts:423</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="pause" class="tsd-anchor"></a><h3>pause</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">pause<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/LiveStream.ts#L423">play-dl/YouTube/classes/LiveStream.ts:423</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Pauses Timer</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>Boolean to tell that if it is paused or not.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="resume" class="tsd-anchor"></a><h3>resume</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">resume<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/LiveStream.ts#L435">play-dl/YouTube/classes/LiveStream.ts:435</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="resume" class="tsd-anchor"></a><h3>resume</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">resume<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/LiveStream.ts#L435">play-dl/YouTube/classes/LiveStream.ts:435</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Resumes Timer</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>Boolean to tell that if it is resumed or not.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="reuse" class="tsd-anchor"></a><h3>reuse</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">reuse<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/LiveStream.ts#L447">play-dl/YouTube/classes/LiveStream.ts:447</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="reuse" class="tsd-anchor"></a><h3>reuse</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">reuse<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/LiveStream.ts#L447">play-dl/YouTube/classes/LiveStream.ts:447</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Reusing of timer</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>Boolean to tell if it is re-used or not.</p>
</div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class="current tsd-kind-namespace"><a href="../modules/_internal_.html">&lt;internal&gt;</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_consumers_.html">&quot;node:stream/consumers&quot;</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_promises_.html">&quot;node:stream/promises&quot;</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_.EventEmitter.html">Event<wbr/>Emitter</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_.internal.html">internal</a></li></ul></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-parent-kind-namespace"><a href="_internal_.Timer.html" class="tsd-kind-icon">Timer</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_internal_.Timer.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.Timer.html#callback" class="tsd-kind-icon">callback</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.Timer.html#destroyed" class="tsd-kind-icon">destroyed</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.Timer.html#paused" class="tsd-kind-icon">paused</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.Timer.html#time_left" class="tsd-kind-icon">time_<wbr/>left</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.Timer.html#time_start" class="tsd-kind-icon">time_<wbr/>start</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.Timer.html#time_total" class="tsd-kind-icon">time_<wbr/>total</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_internal_.Timer.html#timer" class="tsd-kind-icon">timer</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.Timer.html#destroy" class="tsd-kind-icon">destroy</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.Timer.html#pause" class="tsd-kind-icon">pause</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.Timer.html#resume" class="tsd-kind-icon">resume</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.Timer.html#reuse" class="tsd-kind-icon">reuse</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

24
docs/classes/_internal_.YouTubeChannel.html
View File

@ -1,33 +1,33 @@
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>YouTubeChannel | play-dl</title><meta name="description" content="Documentation for play-dl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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="../index.html" class="title">play-dl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">play-dl</a></li><li><a href="../modules/_internal_.html">&lt;internal&gt;</a></li><li><a href="_internal_.YouTubeChannel.html">YouTubeChannel</a></li></ul><h1>Class YouTubeChannel</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Channel Class</p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">YouTubeChannel</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#artist" class="tsd-kind-icon">artist</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#icon" class="tsd-kind-icon">icon</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#subscribers" class="tsd-kind-icon">subscribers</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#url" class="tsd-kind-icon">url</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#verified" class="tsd-kind-icon">verified</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#iconURL" class="tsd-kind-icon">iconURL</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#toJSON" class="tsd-kind-icon">toJSON</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>You<wbr/>Tube<wbr/>Channel<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.YouTubeChannel.html" class="tsd-signature-type" data-tsd-kind="Class">YouTubeChannel</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Channel.ts#L55">play-dl/YouTube/classes/Channel.ts:55</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">YouTubeChannel</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#artist" class="tsd-kind-icon">artist</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#icon" class="tsd-kind-icon">icon</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#subscribers" class="tsd-kind-icon">subscribers</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#url" class="tsd-kind-icon">url</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#verified" class="tsd-kind-icon">verified</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#iconURL" class="tsd-kind-icon">iconURL</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#toJSON" class="tsd-kind-icon">toJSON</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>You<wbr/>Tube<wbr/>Channel<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.YouTubeChannel.html" class="tsd-signature-type" data-tsd-kind="Class">YouTubeChannel</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Channel.ts#L55">play-dl/YouTube/classes/Channel.ts:55</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Channel Constructor</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>data: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = {}</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Channel data that we recieve from basic info or from search</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.YouTubeChannel.html" class="tsd-signature-type" data-tsd-kind="Class">YouTubeChannel</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="artist" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> artist</h3><div class="tsd-signature tsd-kind-icon">artist<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Channel.ts#L30">play-dl/YouTube/classes/Channel.ts:30</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.YouTubeChannel.html" class="tsd-signature-type" data-tsd-kind="Class">YouTubeChannel</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="artist" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> artist</h3><div class="tsd-signature tsd-kind-icon">artist<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Channel.ts#L30">play-dl/YouTube/classes/Channel.ts:30</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Channel artist if any.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="icon" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> icon</h3><div class="tsd-signature tsd-kind-icon">icon<span class="tsd-signature-symbol">?:</span> <a href="../interfaces/_internal_.ChannelIconInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">ChannelIconInterface</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Channel.ts#L46">play-dl/YouTube/classes/Channel.ts:46</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="icon" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> icon</h3><div class="tsd-signature tsd-kind-icon">icon<span class="tsd-signature-symbol">?:</span> <a href="../interfaces/_internal_.ChannelIconInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">ChannelIconInterface</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Channel.ts#L46">play-dl/YouTube/classes/Channel.ts:46</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Channel Icon data.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="id" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Channel.ts#L34">play-dl/YouTube/classes/Channel.ts:34</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="id" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Channel.ts#L34">play-dl/YouTube/classes/Channel.ts:34</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Channel ID.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Channel.ts#L22">play-dl/YouTube/classes/Channel.ts:22</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Channel.ts#L22">play-dl/YouTube/classes/Channel.ts:22</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Channel Title</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="subscribers" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> subscribers</h3><div class="tsd-signature tsd-kind-icon">subscribers<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Channel.ts#L50">play-dl/YouTube/classes/Channel.ts:50</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="subscribers" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> subscribers</h3><div class="tsd-signature tsd-kind-icon">subscribers<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Channel.ts#L50">play-dl/YouTube/classes/Channel.ts:50</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Channel subscribers count.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;playlist&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;channel&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;video&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Channel.ts#L38">play-dl/YouTube/classes/Channel.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;playlist&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;channel&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;video&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Channel.ts#L38">play-dl/YouTube/classes/Channel.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Class type. == &quot;channel&quot;</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="url" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> url</h3><div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Channel.ts#L42">play-dl/YouTube/classes/Channel.ts:42</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="url" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> url</h3><div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Channel.ts#L42">play-dl/YouTube/classes/Channel.ts:42</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Channel Url</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="verified" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> verified</h3><div class="tsd-signature tsd-kind-icon">verified<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Channel.ts#L26">play-dl/YouTube/classes/Channel.ts:26</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="verified" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> verified</h3><div class="tsd-signature tsd-kind-icon">verified<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Channel.ts#L26">play-dl/YouTube/classes/Channel.ts:26</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Channel Verified status.</p>
</div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="iconURL" class="tsd-anchor"></a><h3>iconURL</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">iconURL<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>size<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Channel.ts#L72">play-dl/YouTube/classes/Channel.ts:72</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="iconURL" class="tsd-anchor"></a><h3>iconURL</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">iconURL<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>size<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Channel.ts#L72">play-dl/YouTube/classes/Channel.ts:72</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Returns channel icon url</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <span class="tsd-signature-symbol">{ </span>size<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Icon options</p>
</div></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5>size<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></li></ul><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></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="toJSON" class="tsd-anchor"></a><h3>toJSON</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">toJSON<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_internal_.ChannelJSON.html" class="tsd-signature-type" data-tsd-kind="Interface">ChannelJSON</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Channel.ts#L89">play-dl/YouTube/classes/Channel.ts:89</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5>size<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></li></ul><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></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="toJSON" class="tsd-anchor"></a><h3>toJSON</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">toJSON<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_internal_.ChannelJSON.html" class="tsd-signature-type" data-tsd-kind="Interface">ChannelJSON</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Channel.ts#L89">play-dl/YouTube/classes/Channel.ts:89</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Converts Channel Class to JSON format</p>
</div></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/_internal_.ChannelJSON.html" class="tsd-signature-type" data-tsd-kind="Interface">ChannelJSON</a></h4><div><p>json data of the channel</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="toString" class="tsd-anchor"></a><h3>to<wbr/>String</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">to<wbr/>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Channel.ts#L82">play-dl/YouTube/classes/Channel.ts:82</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="toString" class="tsd-anchor"></a><h3>to<wbr/>String</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">to<wbr/>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Channel.ts#L82">play-dl/YouTube/classes/Channel.ts:82</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Converts Channel Class to channel name.</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>name of channel</p>
</div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class="current tsd-kind-namespace"><a href="../modules/_internal_.html">&lt;internal&gt;</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_consumers_.html">&quot;node:stream/consumers&quot;</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_promises_.html">&quot;node:stream/promises&quot;</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_.EventEmitter.html">Event<wbr/>Emitter</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_.internal.html">internal</a></li></ul></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-parent-kind-namespace"><a href="_internal_.YouTubeChannel.html" class="tsd-kind-icon">You<wbr/>Tube<wbr/>Channel</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#artist" class="tsd-kind-icon">artist</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#icon" class="tsd-kind-icon">icon</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#subscribers" class="tsd-kind-icon">subscribers</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#url" class="tsd-kind-icon">url</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#verified" class="tsd-kind-icon">verified</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#iconURL" class="tsd-kind-icon">iconURL</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#toJSON" class="tsd-kind-icon">toJSON</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.YouTubeChannel.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

46
docs/classes/_internal_.YouTubePlayList.html
View File

File diff suppressed because one or more lines are too long

2
docs/classes/_internal_.YouTubeThumbnail.html
View File

File diff suppressed because one or more lines are too long

38
docs/classes/_internal_.YouTubeVideo.html
View File

@ -1,45 +1,45 @@
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>YouTubeVideo | play-dl</title><meta name="description" content="Documentation for play-dl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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="../index.html" class="title">play-dl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">play-dl</a></li><li><a href="../modules/_internal_.html">&lt;internal&gt;</a></li><li><a href="_internal_.YouTubeVideo.html">YouTubeVideo</a></li></ul><h1>Class YouTubeVideo</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
<p>Class for YouTube Video url</p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">YouTubeVideo</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#channel" class="tsd-kind-icon">channel</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#dislikes" class="tsd-kind-icon">dislikes</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#durationInSec" class="tsd-kind-icon">duration<wbr/>In<wbr/>Sec</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#durationRaw" class="tsd-kind-icon">duration<wbr/>Raw</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#likes" class="tsd-kind-icon">likes</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#live" class="tsd-kind-icon">live</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#private" class="tsd-kind-icon">private</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#tags" class="tsd-kind-icon">tags</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#thumbnail" class="tsd-kind-icon">thumbnail</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#title" class="tsd-kind-icon">title</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#uploadedAt" class="tsd-kind-icon">uploaded<wbr/>At</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#url" class="tsd-kind-icon">url</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#views" class="tsd-kind-icon">views</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#toJSON" class="tsd-kind-icon">toJSON</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>You<wbr/>Tube<wbr/>Video<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.YouTubeVideo.html" class="tsd-signature-type" data-tsd-kind="Class">YouTubeVideo</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Video.ts#L143">play-dl/YouTube/classes/Video.ts:143</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">YouTubeVideo</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#channel" class="tsd-kind-icon">channel</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#dislikes" class="tsd-kind-icon">dislikes</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#durationInSec" class="tsd-kind-icon">duration<wbr/>In<wbr/>Sec</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#durationRaw" class="tsd-kind-icon">duration<wbr/>Raw</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#likes" class="tsd-kind-icon">likes</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#live" class="tsd-kind-icon">live</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#private" class="tsd-kind-icon">private</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#tags" class="tsd-kind-icon">tags</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#thumbnail" class="tsd-kind-icon">thumbnail</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#title" class="tsd-kind-icon">title</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#uploadedAt" class="tsd-kind-icon">uploaded<wbr/>At</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#url" class="tsd-kind-icon">url</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#views" class="tsd-kind-icon">views</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#toJSON" class="tsd-kind-icon">toJSON</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>You<wbr/>Tube<wbr/>Video<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.YouTubeVideo.html" class="tsd-signature-type" data-tsd-kind="Class">YouTubeVideo</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Video.ts#L143">play-dl/YouTube/classes/Video.ts:143</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Constructor for YouTube Video Class</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>data: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>JSON parsed data.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.YouTubeVideo.html" class="tsd-signature-type" data-tsd-kind="Class">YouTubeVideo</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="channel" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> channel</h3><div class="tsd-signature tsd-kind-icon">channel<span class="tsd-signature-symbol">?:</span> <a href="_internal_.YouTubeChannel.html" class="tsd-signature-type" data-tsd-kind="Class">YouTubeChannel</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Video.ts#L118">play-dl/YouTube/classes/Video.ts:118</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.YouTubeVideo.html" class="tsd-signature-type" data-tsd-kind="Class">YouTubeVideo</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="channel" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> channel</h3><div class="tsd-signature tsd-kind-icon">channel<span class="tsd-signature-symbol">?:</span> <a href="_internal_.YouTubeChannel.html" class="tsd-signature-type" data-tsd-kind="Class">YouTubeChannel</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Video.ts#L118">play-dl/YouTube/classes/Video.ts:118</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Video&#39;s uploader Channel Data</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="description" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3><div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Video.ts#L94">play-dl/YouTube/classes/Video.ts:94</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="description" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3><div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Video.ts#L94">play-dl/YouTube/classes/Video.ts:94</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Video description.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="dislikes" class="tsd-anchor"></a><h3>dislikes</h3><div class="tsd-signature tsd-kind-icon">dislikes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Video.ts#L126">play-dl/YouTube/classes/Video.ts:126</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="dislikes" class="tsd-anchor"></a><h3>dislikes</h3><div class="tsd-signature tsd-kind-icon">dislikes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Video.ts#L126">play-dl/YouTube/classes/Video.ts:126</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Video&#39;s dislikes</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="durationInSec" class="tsd-anchor"></a><h3>duration<wbr/>In<wbr/>Sec</h3><div class="tsd-signature tsd-kind-icon">duration<wbr/>In<wbr/>Sec<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Video.ts#L102">play-dl/YouTube/classes/Video.ts:102</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="durationInSec" class="tsd-anchor"></a><h3>duration<wbr/>In<wbr/>Sec</h3><div class="tsd-signature tsd-kind-icon">duration<wbr/>In<wbr/>Sec<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Video.ts#L102">play-dl/YouTube/classes/Video.ts:102</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Video Duration in seconds</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="durationRaw" class="tsd-anchor"></a><h3>duration<wbr/>Raw</h3><div class="tsd-signature tsd-kind-icon">duration<wbr/>Raw<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Video.ts#L98">play-dl/YouTube/classes/Video.ts:98</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="durationRaw" class="tsd-anchor"></a><h3>duration<wbr/>Raw</h3><div class="tsd-signature tsd-kind-icon">duration<wbr/>Raw<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Video.ts#L98">play-dl/YouTube/classes/Video.ts:98</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Video Duration Formatted</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="id" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Video.ts#L78">play-dl/YouTube/classes/Video.ts:78</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="id" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Video.ts#L78">play-dl/YouTube/classes/Video.ts:78</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Video ID</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="likes" class="tsd-anchor"></a><h3>likes</h3><div class="tsd-signature tsd-kind-icon">likes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Video.ts#L122">play-dl/YouTube/classes/Video.ts:122</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="likes" class="tsd-anchor"></a><h3>likes</h3><div class="tsd-signature tsd-kind-icon">likes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Video.ts#L122">play-dl/YouTube/classes/Video.ts:122</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Video&#39;s likes</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="live" class="tsd-anchor"></a><h3>live</h3><div class="tsd-signature tsd-kind-icon">live<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Video.ts#L130">play-dl/YouTube/classes/Video.ts:130</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="live" class="tsd-anchor"></a><h3>live</h3><div class="tsd-signature tsd-kind-icon">live<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Video.ts#L130">play-dl/YouTube/classes/Video.ts:130</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Video live status</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="private" class="tsd-anchor"></a><h3>private</h3><div class="tsd-signature tsd-kind-icon">private<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Video.ts#L134">play-dl/YouTube/classes/Video.ts:134</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="private" class="tsd-anchor"></a><h3>private</h3><div class="tsd-signature tsd-kind-icon">private<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Video.ts#L134">play-dl/YouTube/classes/Video.ts:134</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Video private status</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="tags" class="tsd-anchor"></a><h3>tags</h3><div class="tsd-signature tsd-kind-icon">tags<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Video.ts#L138">play-dl/YouTube/classes/Video.ts:138</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="tags" class="tsd-anchor"></a><h3>tags</h3><div class="tsd-signature tsd-kind-icon">tags<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Video.ts#L138">play-dl/YouTube/classes/Video.ts:138</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Video tags</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="thumbnail" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> thumbnail</h3><div class="tsd-signature tsd-kind-icon">thumbnail<span class="tsd-signature-symbol">?:</span> <a href="_internal_.YouTubeThumbnail.html" class="tsd-signature-type" data-tsd-kind="Class">YouTubeThumbnail</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Video.ts#L114">play-dl/YouTube/classes/Video.ts:114</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="thumbnail" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> thumbnail</h3><div class="tsd-signature tsd-kind-icon">thumbnail<span class="tsd-signature-symbol">?:</span> <a href="_internal_.YouTubeThumbnail.html" class="tsd-signature-type" data-tsd-kind="Class">YouTubeThumbnail</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Video.ts#L114">play-dl/YouTube/classes/Video.ts:114</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Thumbnail Data</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="title" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> title</h3><div class="tsd-signature tsd-kind-icon">title<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Video.ts#L90">play-dl/YouTube/classes/Video.ts:90</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="title" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> title</h3><div class="tsd-signature tsd-kind-icon">title<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Video.ts#L90">play-dl/YouTube/classes/Video.ts:90</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Video title</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;playlist&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;channel&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;video&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Video.ts#L86">play-dl/YouTube/classes/Video.ts:86</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;playlist&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;channel&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;video&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Video.ts#L86">play-dl/YouTube/classes/Video.ts:86</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Class type. == &quot;video&quot;</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="uploadedAt" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> uploaded<wbr/>At</h3><div class="tsd-signature tsd-kind-icon">uploaded<wbr/>At<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Video.ts#L106">play-dl/YouTube/classes/Video.ts:106</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="uploadedAt" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> uploaded<wbr/>At</h3><div class="tsd-signature tsd-kind-icon">uploaded<wbr/>At<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Video.ts#L106">play-dl/YouTube/classes/Video.ts:106</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Video Uploaded Date</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="url" class="tsd-anchor"></a><h3>url</h3><div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Video.ts#L82">play-dl/YouTube/classes/Video.ts:82</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="url" class="tsd-anchor"></a><h3>url</h3><div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Video.ts#L82">play-dl/YouTube/classes/Video.ts:82</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube video url</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="views" class="tsd-anchor"></a><h3>views</h3><div class="tsd-signature tsd-kind-icon">views<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Video.ts#L110">play-dl/YouTube/classes/Video.ts:110</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="views" class="tsd-anchor"></a><h3>views</h3><div class="tsd-signature tsd-kind-icon">views<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Video.ts#L110">play-dl/YouTube/classes/Video.ts:110</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Views</p>
</div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="toJSON" class="tsd-anchor"></a><h3>toJSON</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">toJSON<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_internal_.VideoOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">VideoOptions</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Video.ts#L174">play-dl/YouTube/classes/Video.ts:174</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="toJSON" class="tsd-anchor"></a><h3>toJSON</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">toJSON<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_internal_.VideoOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">VideoOptions</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Video.ts#L174">play-dl/YouTube/classes/Video.ts:174</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Converts class to JSON data</p>
</div></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/_internal_.VideoOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">VideoOptions</a></h4><div><p>JSON data.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="toString" class="tsd-anchor"></a><h3>to<wbr/>String</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">to<wbr/>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Video.ts#L167">play-dl/YouTube/classes/Video.ts:167</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="toString" class="tsd-anchor"></a><h3>to<wbr/>String</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">to<wbr/>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Video.ts#L167">play-dl/YouTube/classes/Video.ts:167</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Converts class to title name of video.</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>Title name</p>
</div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class="current tsd-kind-namespace"><a href="../modules/_internal_.html">&lt;internal&gt;</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_consumers_.html">&quot;node:stream/consumers&quot;</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_promises_.html">&quot;node:stream/promises&quot;</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_.EventEmitter.html">Event<wbr/>Emitter</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_.internal.html">internal</a></li></ul></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-parent-kind-namespace"><a href="_internal_.YouTubeVideo.html" class="tsd-kind-icon">You<wbr/>Tube<wbr/>Video</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#channel" class="tsd-kind-icon">channel</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#dislikes" class="tsd-kind-icon">dislikes</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#durationInSec" class="tsd-kind-icon">duration<wbr/>In<wbr/>Sec</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#durationRaw" class="tsd-kind-icon">duration<wbr/>Raw</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#likes" class="tsd-kind-icon">likes</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#live" class="tsd-kind-icon">live</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#private" class="tsd-kind-icon">private</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#tags" class="tsd-kind-icon">tags</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#thumbnail" class="tsd-kind-icon">thumbnail</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#title" class="tsd-kind-icon">title</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#uploadedAt" class="tsd-kind-icon">uploaded<wbr/>At</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#url" class="tsd-kind-icon">url</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#views" class="tsd-kind-icon">views</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#toJSON" class="tsd-kind-icon">toJSON</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="_internal_.YouTubeVideo.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

2
docs/enums/_internal_.StreamType.html
View File

File diff suppressed because one or more lines are too long

6
docs/interfaces/_internal_.ChannelIconInterface.html
View File

@ -1,7 +1,7 @@
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ChannelIconInterface | play-dl</title><meta name="description" content="Documentation for play-dl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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="../index.html" class="title">play-dl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">play-dl</a></li><li><a href="../modules/_internal_.html">&lt;internal&gt;</a></li><li><a href="_internal_.ChannelIconInterface.html">ChannelIconInterface</a></li></ul><h1>Interface ChannelIconInterface</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">ChannelIconInterface</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.ChannelIconInterface.html#height" class="tsd-kind-icon">height</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.ChannelIconInterface.html#url" class="tsd-kind-icon">url</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.ChannelIconInterface.html#width" class="tsd-kind-icon">width</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="height" class="tsd-anchor"></a><h3>height</h3><div class="tsd-signature tsd-kind-icon">height<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Channel.ts#L13">play-dl/YouTube/classes/Channel.ts:13</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ChannelIconInterface | play-dl</title><meta name="description" content="Documentation for play-dl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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="../index.html" class="title">play-dl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">play-dl</a></li><li><a href="../modules/_internal_.html">&lt;internal&gt;</a></li><li><a href="_internal_.ChannelIconInterface.html">ChannelIconInterface</a></li></ul><h1>Interface ChannelIconInterface</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">ChannelIconInterface</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.ChannelIconInterface.html#height" class="tsd-kind-icon">height</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.ChannelIconInterface.html#url" class="tsd-kind-icon">url</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.ChannelIconInterface.html#width" class="tsd-kind-icon">width</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="height" class="tsd-anchor"></a><h3>height</h3><div class="tsd-signature tsd-kind-icon">height<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Channel.ts#L13">play-dl/YouTube/classes/Channel.ts:13</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Channel Icon Height</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="url" class="tsd-anchor"></a><h3>url</h3><div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Channel.ts#L5">play-dl/YouTube/classes/Channel.ts:5</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="url" class="tsd-anchor"></a><h3>url</h3><div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Channel.ts#L5">play-dl/YouTube/classes/Channel.ts:5</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Channel Icon URL</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="width" class="tsd-anchor"></a><h3>width</h3><div class="tsd-signature tsd-kind-icon">width<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Channel.ts#L9">play-dl/YouTube/classes/Channel.ts:9</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="width" class="tsd-anchor"></a><h3>width</h3><div class="tsd-signature tsd-kind-icon">width<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Channel.ts#L9">play-dl/YouTube/classes/Channel.ts:9</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Channel Icon Width</p>
</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class="current tsd-kind-namespace"><a href="../modules/_internal_.html">&lt;internal&gt;</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_consumers_.html">&quot;node:stream/consumers&quot;</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_promises_.html">&quot;node:stream/promises&quot;</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_.EventEmitter.html">Event<wbr/>Emitter</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_.internal.html">internal</a></li></ul></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-namespace"><a href="_internal_.ChannelIconInterface.html" class="tsd-kind-icon">Channel<wbr/>Icon<wbr/>Interface</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.ChannelIconInterface.html#height" class="tsd-kind-icon">height</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.ChannelIconInterface.html#url" class="tsd-kind-icon">url</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.ChannelIconInterface.html#width" class="tsd-kind-icon">width</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

16
docs/interfaces/_internal_.ChannelJSON.html
View File

@ -1,17 +1,17 @@
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ChannelJSON | play-dl</title><meta name="description" content="Documentation for play-dl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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="../index.html" class="title">play-dl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">play-dl</a></li><li><a href="../modules/_internal_.html">&lt;internal&gt;</a></li><li><a href="_internal_.ChannelJSON.html">ChannelJSON</a></li></ul><h1>Interface ChannelJSON</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">ChannelJSON</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.ChannelJSON.html#artist" class="tsd-kind-icon">artist</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.ChannelJSON.html#icon" class="tsd-kind-icon">icon</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.ChannelJSON.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.ChannelJSON.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.ChannelJSON.html#subscribers" class="tsd-kind-icon">subscribers</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.ChannelJSON.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.ChannelJSON.html#url" class="tsd-kind-icon">url</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.ChannelJSON.html#verified" class="tsd-kind-icon">verified</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="artist" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> artist</h3><div class="tsd-signature tsd-kind-icon">artist<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Channel.ts#L115">play-dl/YouTube/classes/Channel.ts:115</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ChannelJSON | play-dl</title><meta name="description" content="Documentation for play-dl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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="../index.html" class="title">play-dl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">play-dl</a></li><li><a href="../modules/_internal_.html">&lt;internal&gt;</a></li><li><a href="_internal_.ChannelJSON.html">ChannelJSON</a></li></ul><h1>Interface ChannelJSON</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">ChannelJSON</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.ChannelJSON.html#artist" class="tsd-kind-icon">artist</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.ChannelJSON.html#icon" class="tsd-kind-icon">icon</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.ChannelJSON.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.ChannelJSON.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.ChannelJSON.html#subscribers" class="tsd-kind-icon">subscribers</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.ChannelJSON.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.ChannelJSON.html#url" class="tsd-kind-icon">url</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.ChannelJSON.html#verified" class="tsd-kind-icon">verified</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="artist" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> artist</h3><div class="tsd-signature tsd-kind-icon">artist<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Channel.ts#L115">play-dl/YouTube/classes/Channel.ts:115</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Channel artist if any.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="icon" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> icon</h3><div class="tsd-signature tsd-kind-icon">icon<span class="tsd-signature-symbol">?:</span> <a href="_internal_.ChannelIconInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">ChannelIconInterface</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Channel.ts#L131">play-dl/YouTube/classes/Channel.ts:131</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="icon" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> icon</h3><div class="tsd-signature tsd-kind-icon">icon<span class="tsd-signature-symbol">?:</span> <a href="_internal_.ChannelIconInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">ChannelIconInterface</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Channel.ts#L131">play-dl/YouTube/classes/Channel.ts:131</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Channel Icon data.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="id" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Channel.ts#L119">play-dl/YouTube/classes/Channel.ts:119</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="id" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Channel.ts#L119">play-dl/YouTube/classes/Channel.ts:119</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Channel ID.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Channel.ts#L107">play-dl/YouTube/classes/Channel.ts:107</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Channel.ts#L107">play-dl/YouTube/classes/Channel.ts:107</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Channel Title</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="subscribers" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> subscribers</h3><div class="tsd-signature tsd-kind-icon">subscribers<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Channel.ts#L135">play-dl/YouTube/classes/Channel.ts:135</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="subscribers" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> subscribers</h3><div class="tsd-signature tsd-kind-icon">subscribers<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Channel.ts#L135">play-dl/YouTube/classes/Channel.ts:135</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Channel subscribers count.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;playlist&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;channel&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;video&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Channel.ts#L123">play-dl/YouTube/classes/Channel.ts:123</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;playlist&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;channel&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;video&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Channel.ts#L123">play-dl/YouTube/classes/Channel.ts:123</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Type of Class [ Channel ]</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="url" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> url</h3><div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Channel.ts#L127">play-dl/YouTube/classes/Channel.ts:127</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="url" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> url</h3><div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Channel.ts#L127">play-dl/YouTube/classes/Channel.ts:127</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Channel Url</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="verified" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> verified</h3><div class="tsd-signature tsd-kind-icon">verified<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Channel.ts#L111">play-dl/YouTube/classes/Channel.ts:111</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="verified" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> verified</h3><div class="tsd-signature tsd-kind-icon">verified<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Channel.ts#L111">play-dl/YouTube/classes/Channel.ts:111</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Channel Verified status.</p>
</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class="current tsd-kind-namespace"><a href="../modules/_internal_.html">&lt;internal&gt;</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_consumers_.html">&quot;node:stream/consumers&quot;</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_promises_.html">&quot;node:stream/promises&quot;</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_.EventEmitter.html">Event<wbr/>Emitter</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_.internal.html">internal</a></li></ul></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-namespace"><a href="_internal_.ChannelJSON.html" class="tsd-kind-icon">ChannelJSON</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.ChannelJSON.html#artist" class="tsd-kind-icon">artist</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.ChannelJSON.html#icon" class="tsd-kind-icon">icon</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.ChannelJSON.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.ChannelJSON.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.ChannelJSON.html#subscribers" class="tsd-kind-icon">subscribers</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.ChannelJSON.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.ChannelJSON.html#url" class="tsd-kind-icon">url</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.ChannelJSON.html#verified" class="tsd-kind-icon">verified</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

2
docs/interfaces/_internal_.DeezerAdvancedSearchOptions.html
View File

File diff suppressed because one or more lines are too long

2
docs/interfaces/_internal_.DeezerGenre.html
View File

File diff suppressed because one or more lines are too long

2
docs/interfaces/_internal_.DeezerImage.html
View File

File diff suppressed because one or more lines are too long

2
docs/interfaces/_internal_.DeezerUser.html
View File

File diff suppressed because one or more lines are too long

2
docs/interfaces/_internal_.InfoData.html
View File

File diff suppressed because one or more lines are too long

2
docs/interfaces/_internal_.InfoOptions.html
View File

File diff suppressed because one or more lines are too long

2
docs/interfaces/_internal_.LiveStreamData.html
View File

File diff suppressed because one or more lines are too long

20
docs/interfaces/_internal_.PlaylistJSON.html
View File

@ -1,21 +1,21 @@
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PlaylistJSON | play-dl</title><meta name="description" content="Documentation for play-dl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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="../index.html" class="title">play-dl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">play-dl</a></li><li><a href="../modules/_internal_.html">&lt;internal&gt;</a></li><li><a href="_internal_.PlaylistJSON.html">PlaylistJSON</a></li></ul><h1>Interface PlaylistJSON</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">PlaylistJSON</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.PlaylistJSON.html#channel" class="tsd-kind-icon">channel</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.PlaylistJSON.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.PlaylistJSON.html#lastUpdate" class="tsd-kind-icon">last<wbr/>Update</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.PlaylistJSON.html#link" class="tsd-kind-icon">link</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.PlaylistJSON.html#thumbnail" class="tsd-kind-icon">thumbnail</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.PlaylistJSON.html#title" class="tsd-kind-icon">title</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.PlaylistJSON.html#url-1" class="tsd-kind-icon">url</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.PlaylistJSON.html#videoCount" class="tsd-kind-icon">video<wbr/>Count</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.PlaylistJSON.html#videos" class="tsd-kind-icon">videos</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.PlaylistJSON.html#views" class="tsd-kind-icon">views</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="channel" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> channel</h3><div class="tsd-signature tsd-kind-icon">channel<span class="tsd-signature-symbol">?:</span> <a href="../classes/_internal_.YouTubeChannel.html" class="tsd-signature-type" data-tsd-kind="Class">YouTubeChannel</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Playlist.ts#L277">play-dl/YouTube/classes/Playlist.ts:277</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PlaylistJSON | play-dl</title><meta name="description" content="Documentation for play-dl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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="../index.html" class="title">play-dl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">play-dl</a></li><li><a href="../modules/_internal_.html">&lt;internal&gt;</a></li><li><a href="_internal_.PlaylistJSON.html">PlaylistJSON</a></li></ul><h1>Interface PlaylistJSON</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">PlaylistJSON</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.PlaylistJSON.html#channel" class="tsd-kind-icon">channel</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.PlaylistJSON.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.PlaylistJSON.html#lastUpdate" class="tsd-kind-icon">last<wbr/>Update</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.PlaylistJSON.html#link" class="tsd-kind-icon">link</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.PlaylistJSON.html#thumbnail" class="tsd-kind-icon">thumbnail</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.PlaylistJSON.html#title" class="tsd-kind-icon">title</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.PlaylistJSON.html#url-1" class="tsd-kind-icon">url</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.PlaylistJSON.html#videoCount" class="tsd-kind-icon">video<wbr/>Count</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.PlaylistJSON.html#videos" class="tsd-kind-icon">videos</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.PlaylistJSON.html#views" class="tsd-kind-icon">views</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="channel" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> channel</h3><div class="tsd-signature tsd-kind-icon">channel<span class="tsd-signature-symbol">?:</span> <a href="../classes/_internal_.YouTubeChannel.html" class="tsd-signature-type" data-tsd-kind="Class">YouTubeChannel</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Playlist.ts#L277">play-dl/YouTube/classes/Playlist.ts:277</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Playlist channel data</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="id" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Playlist.ts#L249">play-dl/YouTube/classes/Playlist.ts:249</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="id" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Playlist.ts#L249">play-dl/YouTube/classes/Playlist.ts:249</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Playlist ID</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="lastUpdate" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> last<wbr/>Update</h3><div class="tsd-signature tsd-kind-icon">last<wbr/>Update<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Playlist.ts#L261">play-dl/YouTube/classes/Playlist.ts:261</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="lastUpdate" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> last<wbr/>Update</h3><div class="tsd-signature tsd-kind-icon">last<wbr/>Update<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Playlist.ts#L261">play-dl/YouTube/classes/Playlist.ts:261</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Time when playlist was last updated</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="link" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> link</h3><div class="tsd-signature tsd-kind-icon">link<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Playlist.ts#L273">play-dl/YouTube/classes/Playlist.ts:273</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="link" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> link</h3><div class="tsd-signature tsd-kind-icon">link<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Playlist.ts#L273">play-dl/YouTube/classes/Playlist.ts:273</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Playlist url with starting video url.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="thumbnail" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> thumbnail</h3><div class="tsd-signature tsd-kind-icon">thumbnail<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span>height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Playlist.ts#L281">play-dl/YouTube/classes/Playlist.ts:281</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="thumbnail" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> thumbnail</h3><div class="tsd-signature tsd-kind-icon">thumbnail<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span>height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Playlist.ts#L281">play-dl/YouTube/classes/Playlist.ts:281</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Playlist thumbnail Data</p>
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="title" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> title</h3><div class="tsd-signature tsd-kind-icon">title<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Playlist.ts#L253">play-dl/YouTube/classes/Playlist.ts:253</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="title" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> title</h3><div class="tsd-signature tsd-kind-icon">title<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Playlist.ts#L253">play-dl/YouTube/classes/Playlist.ts:253</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Playlist Name</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="url-1" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> url</h3><div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Playlist.ts#L269">play-dl/YouTube/classes/Playlist.ts:269</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="url-1" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> url</h3><div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Playlist.ts#L269">play-dl/YouTube/classes/Playlist.ts:269</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>YouTube Playlist url</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="videoCount" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> video<wbr/>Count</h3><div class="tsd-signature tsd-kind-icon">video<wbr/>Count<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Playlist.ts#L257">play-dl/YouTube/classes/Playlist.ts:257</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="videoCount" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> video<wbr/>Count</h3><div class="tsd-signature tsd-kind-icon">video<wbr/>Count<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Playlist.ts#L257">play-dl/YouTube/classes/Playlist.ts:257</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Total no of videos in that playlist</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="videos" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> videos</h3><div class="tsd-signature tsd-kind-icon">videos<span class="tsd-signature-symbol">?:</span> <a href="../classes/_internal_.YouTubeVideo.html" class="tsd-signature-type" data-tsd-kind="Class">YouTubeVideo</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Playlist.ts#L290">play-dl/YouTube/classes/Playlist.ts:290</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="videos" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> videos</h3><div class="tsd-signature tsd-kind-icon">videos<span class="tsd-signature-symbol">?:</span> <a href="../classes/_internal_.YouTubeVideo.html" class="tsd-signature-type" data-tsd-kind="Class">YouTubeVideo</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Playlist.ts#L290">play-dl/YouTube/classes/Playlist.ts:290</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>first 100 videos in that playlist</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="views" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> views</h3><div class="tsd-signature tsd-kind-icon">views<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/YouTube/classes/Playlist.ts#L265">play-dl/YouTube/classes/Playlist.ts:265</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="views" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> views</h3><div class="tsd-signature tsd-kind-icon">views<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/classes/Playlist.ts#L265">play-dl/YouTube/classes/Playlist.ts:265</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Total views of that playlist</p>
</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class="current tsd-kind-namespace"><a href="../modules/_internal_.html">&lt;internal&gt;</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_consumers_.html">&quot;node:stream/consumers&quot;</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_promises_.html">&quot;node:stream/promises&quot;</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_.EventEmitter.html">Event<wbr/>Emitter</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_.internal.html">internal</a></li></ul></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-namespace"><a href="_internal_.PlaylistJSON.html" class="tsd-kind-icon">PlaylistJSON</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.PlaylistJSON.html#channel" class="tsd-kind-icon">channel</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.PlaylistJSON.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.PlaylistJSON.html#lastUpdate" class="tsd-kind-icon">last<wbr/>Update</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.PlaylistJSON.html#link" class="tsd-kind-icon">link</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.PlaylistJSON.html#thumbnail" class="tsd-kind-icon">thumbnail</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.PlaylistJSON.html#title" class="tsd-kind-icon">title</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.PlaylistJSON.html#url-1" class="tsd-kind-icon">url</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.PlaylistJSON.html#videoCount" class="tsd-kind-icon">video<wbr/>Count</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.PlaylistJSON.html#videos" class="tsd-kind-icon">videos</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.PlaylistJSON.html#views" class="tsd-kind-icon">views</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

2
docs/interfaces/_internal_.PlaylistOptions.html
View File

File diff suppressed because one or more lines are too long

2
docs/interfaces/_internal_.ProxyOpts.html
View File

File diff suppressed because one or more lines are too long

2
docs/interfaces/_internal_.SearchOptions.html
View File

File diff suppressed because one or more lines are too long

2
docs/interfaces/_internal_.SoundCloudTrackDeprecated.html
View File

File diff suppressed because one or more lines are too long

2
docs/interfaces/_internal_.SoundCloudTrackFormat.html
View File

File diff suppressed because one or more lines are too long

2
docs/interfaces/_internal_.SoundCloudUser.html
View File

File diff suppressed because one or more lines are too long

8
docs/interfaces/_internal_.SpotifyArtists.html
View File

File diff suppressed because one or more lines are too long

6
docs/interfaces/_internal_.SpotifyCopyright.html
View File

File diff suppressed because one or more lines are too long

2
docs/interfaces/_internal_.SpotifyDataOptions.html
View File

File diff suppressed because one or more lines are too long

8
docs/interfaces/_internal_.SpotifyThumbnail.html
View File

File diff suppressed because one or more lines are too long

12
docs/interfaces/_internal_.SpotifyTrackAlbum.html
View File

@ -1,9 +1,13 @@
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SpotifyTrackAlbum | play-dl</title><meta name="description" content="Documentation for play-dl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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="../index.html" class="title">play-dl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">play-dl</a></li><li><a href="../modules/_internal_.html">&lt;internal&gt;</a></li><li><a href="_internal_.SpotifyTrackAlbum.html">SpotifyTrackAlbum</a></li></ul><h1>Interface SpotifyTrackAlbum</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">SpotifyTrackAlbum</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.SpotifyTrackAlbum.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.SpotifyTrackAlbum.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.SpotifyTrackAlbum.html#release_date" class="tsd-kind-icon">release_<wbr/>date</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.SpotifyTrackAlbum.html#release_date_precision" class="tsd-kind-icon">release_<wbr/>date_<wbr/>precision</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.SpotifyTrackAlbum.html#total_tracks" class="tsd-kind-icon">total_<wbr/>tracks</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.SpotifyTrackAlbum.html#url" class="tsd-kind-icon">url</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="id" class="tsd-anchor"></a><h3>id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/Spotify/classes.ts#L16">play-dl/Spotify/classes.ts:16</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SpotifyTrackAlbum | play-dl</title><meta name="description" content="Documentation for play-dl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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="../index.html" class="title">play-dl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">play-dl</a></li><li><a href="../modules/_internal_.html">&lt;internal&gt;</a></li><li><a href="_internal_.SpotifyTrackAlbum.html">SpotifyTrackAlbum</a></li></ul><h1>Interface SpotifyTrackAlbum</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">SpotifyTrackAlbum</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.SpotifyTrackAlbum.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.SpotifyTrackAlbum.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.SpotifyTrackAlbum.html#release_date" class="tsd-kind-icon">release_<wbr/>date</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.SpotifyTrackAlbum.html#release_date_precision" class="tsd-kind-icon">release_<wbr/>date_<wbr/>precision</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.SpotifyTrackAlbum.html#total_tracks" class="tsd-kind-icon">total_<wbr/>tracks</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.SpotifyTrackAlbum.html#url" class="tsd-kind-icon">url</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="id" class="tsd-anchor"></a><h3>id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/Spotify/classes.ts#L17">play-dl/Spotify/classes.ts:17</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Spotify Track Album id</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="name" class="tsd-anchor"></a><h3>name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/Spotify/classes.ts#L8">play-dl/Spotify/classes.ts:8</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="name" class="tsd-anchor"></a><h3>name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/Spotify/classes.ts#L9">play-dl/Spotify/classes.ts:9</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Spotify Track Album name</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="release_date" class="tsd-anchor"></a><h3>release_<wbr/>date</h3><div class="tsd-signature tsd-kind-icon">release_<wbr/>date<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/Spotify/classes.ts#L20">play-dl/Spotify/classes.ts:20</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="release_date" class="tsd-anchor"></a><h3>release_<wbr/>date</h3><div class="tsd-signature tsd-kind-icon">release_<wbr/>date<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/Spotify/classes.ts#L21">play-dl/Spotify/classes.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Spotify Track Album release date</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="release_date_precision" class="tsd-anchor"></a><h3>release_<wbr/>date_<wbr/>precision</h3><div class="tsd-signature tsd-kind-icon">release_<wbr/>date_<wbr/>precision<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/Spotify/classes.ts#L21">play-dl/Spotify/classes.ts:21</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="total_tracks" class="tsd-anchor"></a><h3>total_<wbr/>tracks</h3><div class="tsd-signature tsd-kind-icon">total_<wbr/>tracks<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/Spotify/classes.ts#L22">play-dl/Spotify/classes.ts:22</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="url" class="tsd-anchor"></a><h3>url</h3><div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/81e6bc0/play-dl/Spotify/classes.ts#L12">play-dl/Spotify/classes.ts:12</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="release_date_precision" class="tsd-anchor"></a><h3>release_<wbr/>date_<wbr/>precision</h3><div class="tsd-signature tsd-kind-icon">release_<wbr/>date_<wbr/>precision<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/Spotify/classes.ts#L25">play-dl/Spotify/classes.ts:25</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Spotify Track Album release date <strong>precise</strong></p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="total_tracks" class="tsd-anchor"></a><h3>total_<wbr/>tracks</h3><div class="tsd-signature tsd-kind-icon">total_<wbr/>tracks<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/Spotify/classes.ts#L29">play-dl/Spotify/classes.ts:29</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Spotify Track Album total tracks number</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="url" class="tsd-anchor"></a><h3>url</h3><div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/play-dl/play-dl/blob/241884d/play-dl/Spotify/classes.ts#L13">play-dl/Spotify/classes.ts:13</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Spotify Track Album url</p>
</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class="current tsd-kind-namespace"><a href="../modules/_internal_.html">&lt;internal&gt;</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_consumers_.html">&quot;node:stream/consumers&quot;</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_promises_.html">&quot;node:stream/promises&quot;</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_.EventEmitter.html">Event<wbr/>Emitter</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_.internal.html">internal</a></li></ul></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-namespace"><a href="_internal_.SpotifyTrackAlbum.html" class="tsd-kind-icon">Spotify<wbr/>Track<wbr/>Album</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.SpotifyTrackAlbum.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.SpotifyTrackAlbum.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.SpotifyTrackAlbum.html#release_date" class="tsd-kind-icon">release_<wbr/>date</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.SpotifyTrackAlbum.html#release_date_precision" class="tsd-kind-icon">release_<wbr/>date_<wbr/>precision</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.SpotifyTrackAlbum.html#total_tracks" class="tsd-kind-icon">total_<wbr/>tracks</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.SpotifyTrackAlbum.html#url" class="tsd-kind-icon">url</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

2
docs/interfaces/_internal_.StreamOptions.html
View File

File diff suppressed because one or more lines are too long

19
docs/interfaces/_internal_.TrackJSON.html Normal file
View File

@ -0,0 +1,19 @@
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TrackJSON | play-dl</title><meta name="description" content="Documentation for play-dl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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="../index.html" class="title">play-dl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">play-dl</a></li><li><a href="../modules/_internal_.html">&lt;internal&gt;</a></li><li><a href="_internal_.TrackJSON.html">TrackJSON</a></li></ul><h1>Interface TrackJSON</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">TrackJSON</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.TrackJSON.html#album" class="tsd-kind-icon">album</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.TrackJSON.html#artists" class="tsd-kind-icon">artists</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.TrackJSON.html#durationInMs" class="tsd-kind-icon">duration<wbr/>In<wbr/>Ms</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.TrackJSON.html#durationInSec" class="tsd-kind-icon">duration<wbr/>In<wbr/>Sec</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.TrackJSON.html#explicit" class="tsd-kind-icon">explicit</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.TrackJSON.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.TrackJSON.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.TrackJSON.html#thumbnail" class="tsd-kind-icon">thumbnail</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.TrackJSON.html#url" class="tsd-kind-icon">url</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="album" class="tsd-anchor"></a><h3>album</h3><div class="tsd-signature tsd-kind-icon">album<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="_internal_.SpotifyTrackAlbum.html" class="tsd-signature-type" data-tsd-kind="Interface">SpotifyTrackAlbum</a></div><aside class="tsd-sources"><ul><li>Defined in play-dl/Spotify/constants.ts:35</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Spotify Track Album data</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="artists" class="tsd-anchor"></a><h3>artists</h3><div class="tsd-signature tsd-kind-icon">artists<span class="tsd-signature-symbol">:</span> <a href="_internal_.SpotifyArtists.html" class="tsd-signature-type" data-tsd-kind="Interface">SpotifyArtists</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in play-dl/Spotify/constants.ts:31</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Spotify Track Artists data [ array ]</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="durationInMs" class="tsd-anchor"></a><h3>duration<wbr/>In<wbr/>Ms</h3><div class="tsd-signature tsd-kind-icon">duration<wbr/>In<wbr/>Ms<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in play-dl/Spotify/constants.ts:27</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Spotify Track Duration in milli seconds</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="durationInSec" class="tsd-anchor"></a><h3>duration<wbr/>In<wbr/>Sec</h3><div class="tsd-signature tsd-kind-icon">duration<wbr/>In<wbr/>Sec<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in play-dl/Spotify/constants.ts:23</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Spotify Track Duration in seconds</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="explicit" class="tsd-anchor"></a><h3>explicit</h3><div class="tsd-signature tsd-kind-icon">explicit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in play-dl/Spotify/constants.ts:19</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Spotify Track explicit info.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="id" class="tsd-anchor"></a><h3>id</h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in play-dl/Spotify/constants.ts:11</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Spotify Track ID</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="name" class="tsd-anchor"></a><h3>name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in play-dl/Spotify/constants.ts:7</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Spotify Track Name</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="thumbnail" class="tsd-anchor"></a><h3>thumbnail</h3><div class="tsd-signature tsd-kind-icon">thumbnail<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="_internal_.SpotifyThumbnail.html" class="tsd-signature-type" data-tsd-kind="Interface">SpotifyThumbnail</a></div><aside class="tsd-sources"><ul><li>Defined in play-dl/Spotify/constants.ts:39</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Spotify Track Thumbnail Data</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="url" class="tsd-anchor"></a><h3>url</h3><div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in play-dl/Spotify/constants.ts:15</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Spotify Track url</p>
</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class="current tsd-kind-namespace"><a href="../modules/_internal_.html">&lt;internal&gt;</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_consumers_.html">&quot;node:stream/consumers&quot;</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_promises_.html">&quot;node:stream/promises&quot;</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_.EventEmitter.html">Event<wbr/>Emitter</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_.internal.html">internal</a></li></ul></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-namespace"><a href="_internal_.TrackJSON.html" class="tsd-kind-icon">TrackJSON</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.TrackJSON.html#album" class="tsd-kind-icon">album</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.TrackJSON.html#artists" class="tsd-kind-icon">artists</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.TrackJSON.html#durationInMs" class="tsd-kind-icon">duration<wbr/>In<wbr/>Ms</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.TrackJSON.html#durationInSec" class="tsd-kind-icon">duration<wbr/>In<wbr/>Sec</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.TrackJSON.html#explicit" class="tsd-kind-icon">explicit</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.TrackJSON.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.TrackJSON.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.TrackJSON.html#thumbnail" class="tsd-kind-icon">thumbnail</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="_internal_.TrackJSON.html#url" class="tsd-kind-icon">url</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

30
docs/interfaces/_internal_.VideoOptions.html
View File

File diff suppressed because one or more lines are too long

2
docs/interfaces/_internal_.formatData.html
View File

File diff suppressed because one or more lines are too long

2
docs/interfaces/_internal_.tokenOptions.html
View File

File diff suppressed because one or more lines are too long

52
docs/modules.html
View File

File diff suppressed because one or more lines are too long

6
docs/modules/_internal_.html
View File

File diff suppressed because one or more lines are too long

137
play-dl/Spotify/classes.ts
View File

@ -1,7 +1,8 @@
import { request } from '../Request';
import { SpotifyDataOptions } from '.';
import { TrackJSON } from './constants';
interface SpotifyTrackAlbum {
export interface SpotifyTrackAlbum {
/**
* Spotify Track Album name
*/
@ -18,40 +19,104 @@ interface SpotifyTrackAlbum {
* Spotify Track Album release date
*/
release_date: string;
/**
* Spotify Track Album release date **precise**
*/
release_date_precision: string;
/**
* Spotify Track Album total tracks number
*/
total_tracks: number;
}
interface SpotifyArtists {
export interface SpotifyArtists {
/**
* Spotify Artist Name
*/
name: string;
/**
* Spotify Artist Url
*/
url: string;
/**
* Spotify Artist ID
*/
id: string;
}
interface SpotifyThumbnail {
export interface SpotifyThumbnail {
/**
* Spotify Thumbnail height
*/
height: number;
/**
* Spotify Thumbnail width
*/
width: number;
/**
* Spotify Thumbnail url
*/
url: string;
}
interface SpotifyCopyright {
export interface SpotifyCopyright {
/**
* Spotify Copyright Text
*/
text: string;
/**
* Spotify Copyright Type
*/
type: string;
}
/**
* Class for Spotify Track
* Spotify Track Class
*/
export class SpotifyTrack {
/**
* Spotify Track Name
*/
name: string;
/**
* Spotify Class type. == "track"
*/
type: 'track' | 'playlist' | 'album';
/**
* Spotify Track ID
*/
id: string;
/**
* Spotify Track url
*/
url: string;
/**
* Spotify Track explicit info.
*/
explicit: boolean;
/**
* Spotify Track Duration in seconds
*/
durationInSec: number;
/**
* Spotify Track Duration in milli seconds
*/
durationInMs: number;
/**
* Spotify Track Artists data [ array ]
*/
artists: SpotifyArtists[];
/**
* Spotify Track Album data
*/
album: SpotifyTrackAlbum | undefined;
/**
* Spotify Track Thumbnail Data
*/
thumbnail: SpotifyThumbnail | undefined;
/**
* Constructor for Spotify Track
* @param data
*/
constructor(data: any) {
this.name = data.name;
this.id = data.id;
@ -84,11 +149,10 @@ export class SpotifyTrack {
else this.thumbnail = data.album.images[0];
}
toJSON() {
toJSON() : TrackJSON {
return {
name: this.name,
id: this.id,
type: this.type,
url: this.url,
explicit: this.explicit,
durationInMs: this.durationInMs,
@ -100,20 +164,62 @@ export class SpotifyTrack {
}
}
/**
* Class for Spotify Playlist
* Spotify Playlist Class
*/
export class SpotifyPlaylist {
/**
* Spotify Playlist Name
*/
name: string;
/**
* Spotify Class type. == "playlist"
*/
type: 'track' | 'playlist' | 'album';
/**
* Spotify Playlist collaborative boolean.
*/
collaborative: boolean;
/**
* Spotify Playlist Description
*/
description: string;
/**
* Spotify Playlist URL
*/
url: string;
/**
* Spotify Playlist ID
*/
id: string;
/**
* Spotify Playlist Thumbnail Data
*/
thumbnail: SpotifyThumbnail;
/**
* Spotify Playlist Owner Artist data
*/
owner: SpotifyArtists;
/**
* Spotify Playlist total tracks Count
*/
tracksCount: number;
/**
* Spotify Playlist Spotify data
*
* @private
*/
private spotifyData: SpotifyDataOptions;
/**
* Spotify Playlist fetched tracks Map
*
* @private
*/
private fetched_tracks: Map<string, SpotifyTrack[]>;
/**
* Constructor for Spotify Playlist Class
* @param data JSON parsed data of playlist
* @param spotifyData Data about sporify token for furhter fetching.
*/
constructor(data: any, spotifyData: SpotifyDataOptions) {
this.name = data.name;
this.type = 'playlist';
@ -136,7 +242,12 @@ export class SpotifyPlaylist {
this.fetched_tracks.set('1', videos);
this.spotifyData = spotifyData;
}
/**
* Fetches Spotify Playlist tracks more than 100 tracks.
*
* For getting whole data, see `total_pages` property.
* @returns Playlist Class.
*/
async fetch() {
let fetching: number;
if (this.tracksCount > 1000) fetching = 1000;
@ -170,7 +281,13 @@ export class SpotifyPlaylist {
await Promise.allSettled(work);
return this;
}
/**
* Spotify Playlist tracks are divided in pages.
*
* For example getting data
* @param num
* @returns
*/
page(num: number) {
if (!num) throw new Error('Page number is not provided');
if (!this.fetched_tracks.has(`${num}`)) throw new Error('Given Page number is invalid');

40
play-dl/Spotify/constants.ts Normal file
View File

@ -0,0 +1,40 @@
import { SpotifyArtists, SpotifyThumbnail, SpotifyTrackAlbum } from './classes'
export interface TrackJSON{
/**
* Spotify Track Name
*/
name: string;
/**
* Spotify Track ID
*/
id: string;
/**
* Spotify Track url
*/
url: string;
/**
* Spotify Track explicit info.
*/
explicit: boolean;
/**
* Spotify Track Duration in seconds
*/
durationInSec: number;
/**
* Spotify Track Duration in milli seconds
*/
durationInMs: number;
/**
* Spotify Track Artists data [ array ]
*/
artists: SpotifyArtists[];
/**
* Spotify Track Album data
*/
album: SpotifyTrackAlbum | undefined;
/**
* Spotify Track Thumbnail Data
*/
thumbnail: SpotifyThumbnail | undefined;
}