62 lines
9.8 KiB
HTML
62 lines
9.8 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>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"><h1>play-dl</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><div class="tsd-panel tsd-typography">
|
|
<a href="#why-play-dl-" id="why-play-dl-" style="color: inherit; text-decoration: none;">
|
|
<h1>Why play-dl ?</h1>
|
|
</a>
|
|
<p><a href="https://github.com/fent/node-ytdl-core">ytdl-core</a> has some issues with miniget and also stream abort issues. On the other hand, <a href="https://github.com/ytdl-org/youtube-dl">youtube-dl</a> is a very perfect alternative but it takes time to launch. Hence, play-dl is created to avoid these issues along with providing comparatively faster performance than others.</p>
|
|
<p><a href="https://discord.gg/8H3xWcv3D7"><img src="https://img.shields.io/discord/888998674716315679?color=00ff00&label=%20Discord&logo=Discord" alt="Discord"></a></p>
|
|
|
|
<a href="#support" id="support" style="color: inherit; text-decoration: none;">
|
|
<h2>Support</h2>
|
|
</a>
|
|
<p>You can contact us for support on our <a href="https://discord.gg/8H3xWcv3D7">chat server</a></p>
|
|
|
|
<a href="#stream-videosplaylists-or-search-for-videos" id="stream-videosplaylists-or-search-for-videos" style="color: inherit; text-decoration: none;">
|
|
<h2>Stream videos/playlists or search for videos</h2>
|
|
</a>
|
|
<p>This is a <strong>light-weight</strong> youtube downloader and searcher.</p>
|
|
<ul>
|
|
<li>searches by video, playlist, channel</li>
|
|
<li>obtains audio playback url</li>
|
|
</ul>
|
|
|
|
<a href="#installation" id="installation" style="color: inherit; text-decoration: none;">
|
|
<h3>Installation</h3>
|
|
</a>
|
|
<pre><code class="language-bash"><span class="hl-0">npm install play-dl@latest</span>
|
|
</code></pre>
|
|
|
|
<a href="#importing" id="importing" style="color: inherit; text-decoration: none;">
|
|
<h3>Importing</h3>
|
|
</a>
|
|
<pre><code class="language-ts"><span class="hl-1">import</span><span class="hl-0"> </span><span class="hl-2">*</span><span class="hl-0"> </span><span class="hl-1">as</span><span class="hl-0"> </span><span class="hl-3">play</span><span class="hl-0"> </span><span class="hl-1">from</span><span class="hl-0"> </span><span class="hl-4">'play-dl'</span><span class="hl-0"> </span><span class="hl-5">// ES-6 import or TS import</span><br/><br/><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">play</span><span class="hl-0"> = </span><span class="hl-7">require</span><span class="hl-0">(</span><span class="hl-4">'play-dl'</span><span class="hl-0">) </span><span class="hl-5">//JS importing</span>
|
|
</code></pre>
|
|
|
|
<a href="#instructions" id="instructions" style="color: inherit; text-decoration: none;">
|
|
<h2>Instructions</h2>
|
|
</a>
|
|
<ul>
|
|
<li>1.0 release change brings some code changes, make sure to read docs once again.</li>
|
|
<li><a href="https://github.com/play-dl/play-dl/discussions/64">Spotify</a></li>
|
|
<li><a href="https://github.com/play-dl/play-dl/discussions/92">SoundCloud</a></li>
|
|
</ul>
|
|
|
|
<a href="#examples" id="examples" style="color: inherit; text-decoration: none;">
|
|
<h3>Examples</h3>
|
|
</a>
|
|
<ul>
|
|
<li><a href="https://github.com/play-dl/play-dl/tree/main/examples/YouTube">YouTube</a></li>
|
|
<li><a href="https://github.com/play-dl/play-dl/tree/main/examples/Spotify">Spotify</a></li>
|
|
<li><a href="https://github.com/play-dl/play-dl/tree/main/examples/SoundCloud">SoundCloud</a></li>
|
|
</ul>
|
|
|
|
<a href="#docs" id="docs" style="color: inherit; text-decoration: none;">
|
|
<h3>Docs</h3>
|
|
</a>
|
|
<ul>
|
|
<li><a href="https://github.com/play-dl/play-dl/tree/main/docs#play-dl-commands">Main</a></li>
|
|
<li><a href="https://github.com/play-dl/play-dl/tree/main/docs/YouTube#youtube">YouTube</a></li>
|
|
<li><a href="https://github.com/play-dl/play-dl/tree/main/docs/Spotify#spotify">Spotify</a></li>
|
|
<li><a href="https://github.com/play-dl/play-dl/tree/main/docs/SoundCloud">SoundCloud</a></li>
|
|
<li><a href="https://github.com/play-dl/play-dl/tree/main/docs/Deezer">Deezer</a></li>
|
|
</ul>
|
|
</div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="modules/_internal_.html"><internal></a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-type-alias"><a href="modules.html#Deezer" class="tsd-kind-icon">Deezer</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SoundCloud" class="tsd-kind-icon">Sound<wbr/>Cloud</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SoundCloudStream" class="tsd-kind-icon">Sound<wbr/>Cloud<wbr/>Stream</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Spotify" class="tsd-kind-icon">Spotify</a></li><li class="tsd-kind-type-alias"><a href="modules.html#YouTube" class="tsd-kind-icon">You<wbr/>Tube</a></li><li class="tsd-kind-type-alias"><a href="modules.html#YouTubeStream" class="tsd-kind-icon">You<wbr/>Tube<wbr/>Stream</a></li><li class="tsd-kind-function"><a href="modules.html#attachListeners" class="tsd-kind-icon">attach<wbr/>Listeners</a></li><li class="tsd-kind-function"><a href="modules.html#authorization" class="tsd-kind-icon">authorization</a></li><li class="tsd-kind-function"><a href="modules.html#cookieHeaders" class="tsd-kind-icon">cookie<wbr/>Headers</a></li><li class="tsd-kind-function"><a href="modules.html#decipher_info" class="tsd-kind-icon">decipher_<wbr/>info</a></li><li class="tsd-kind-function"><a href="modules.html#deezer" class="tsd-kind-icon">deezer</a></li><li class="tsd-kind-function"><a href="modules.html#dz_advanced_track_search" class="tsd-kind-icon">dz_<wbr/>advanced_<wbr/>track_<wbr/>search</a></li><li class="tsd-kind-function"><a href="modules.html#dz_search" class="tsd-kind-icon">dz_<wbr/>search</a></li><li class="tsd-kind-function"><a href="modules.html#dz_validate" class="tsd-kind-icon">dz_<wbr/>validate</a></li><li class="tsd-kind-function"><a href="modules.html#extractID" class="tsd-kind-icon">extractID</a></li><li class="tsd-kind-function"><a href="modules.html#getFreeClientID" class="tsd-kind-icon">get<wbr/>Free<wbr/>ClientID</a></li><li class="tsd-kind-function"><a href="modules.html#is_expired" class="tsd-kind-icon">is_<wbr/>expired</a></li><li class="tsd-kind-function"><a href="modules.html#playlist_info" class="tsd-kind-icon">playlist_<wbr/>info</a></li><li class="tsd-kind-function"><a href="modules.html#refreshToken" class="tsd-kind-icon">refresh<wbr/>Token</a></li><li class="tsd-kind-function"><a href="modules.html#search" class="tsd-kind-icon">search</a></li><li class="tsd-kind-function"><a href="modules.html#setToken" class="tsd-kind-icon">set<wbr/>Token</a></li><li class="tsd-kind-function"><a href="modules.html#so_validate" class="tsd-kind-icon">so_<wbr/>validate</a></li><li class="tsd-kind-function"><a href="modules.html#soundcloud" class="tsd-kind-icon">soundcloud</a></li><li class="tsd-kind-function"><a href="modules.html#sp_validate" class="tsd-kind-icon">sp_<wbr/>validate</a></li><li class="tsd-kind-function"><a href="modules.html#spotify" class="tsd-kind-icon">spotify</a></li><li class="tsd-kind-function"><a href="modules.html#stream" class="tsd-kind-icon">stream</a></li><li class="tsd-kind-function"><a href="modules.html#stream_from_info" class="tsd-kind-icon">stream_<wbr/>from_<wbr/>info</a></li><li class="tsd-kind-function"><a href="modules.html#validate" class="tsd-kind-icon">validate</a></li><li class="tsd-kind-function"><a href="modules.html#video_basic_info" class="tsd-kind-icon">video_<wbr/>basic_<wbr/>info</a></li><li class="tsd-kind-function"><a href="modules.html#video_info" class="tsd-kind-icon">video_<wbr/>info</a></li><li class="tsd-kind-function"><a href="modules.html#yt_validate" class="tsd-kind-icon">yt_<wbr/>validate</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><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> |