2021-11-18 16:32:54 +05:30
<!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" > < 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 > Namespaces< / h3 > < ul class = "tsd-index-list" > < li class = "tsd-kind-namespace" > < a href = "modules/_internal_.html" class = "tsd-kind-icon" > < internal> < / a > < / li > < / ul > < / section > < section class = "tsd-index-section " > < h3 > Classes< / h3 > < ul class = "tsd-index-list" > < li class = "tsd-kind-class" > < a href = "classes/SoundCloudStream.html" class = "tsd-kind-icon" > Sound< wbr / > Cloud< wbr / > Stream< / a > < / li > < / ul > < / section > < section class = "tsd-index-section " > < h3 > Type aliases< / h3 > < ul class = "tsd-index-list" > < 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#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 > < / ul > < / section > < section class = "tsd-index-section " > < h3 > Functions< / h3 > < ul class = "tsd-index-list" > < 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_validate" class = "tsd-kind-icon" > d
2021-11-17 12:38:48 +05:30
< p > Shared type for Deezer tracks, playlists and albums< / p >
2021-11-18 16:32:54 +05:30
< / div > < / div > < / section > < section class = "tsd-panel tsd-member tsd-kind-type-alias" > < a id = "SoundCloud" class = "tsd-anchor" > < / a > < h3 > Sound< wbr / > Cloud< / h3 > < div class = "tsd-signature tsd-kind-icon" > Sound< wbr / > Cloud< span class = "tsd-signature-symbol" > :< / span > < a href = "classes/_internal_.SoundCloudTrack.html" class = "tsd-signature-type" data-tsd-kind = "Class" > SoundCloudTrack< / a > < span class = "tsd-signature-symbol" > | < / span > < a href = "classes/_internal_.SoundCloudPlaylist.html" class = "tsd-signature-type" data-tsd-kind = "Class" > SoundCloudPlaylist< / a > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/play-dl/play-dl/blob/241884d/play-dl/SoundCloud/index.ts#L42" > play-dl/SoundCloud/index.ts:42< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2021-11-17 12:38:48 +05:30
< p > Type of SoundCloud< / p >
2021-11-18 16:32:54 +05:30
< / div > < / div > < / section > < section class = "tsd-panel tsd-member tsd-kind-type-alias" > < a id = "Spotify" class = "tsd-anchor" > < / a > < h3 > Spotify< / h3 > < div class = "tsd-signature tsd-kind-icon" > Spotify< span class = "tsd-signature-symbol" > :< / span > < a href = "classes/_internal_.SpotifyAlbum.html" class = "tsd-signature-type" data-tsd-kind = "Class" > SpotifyAlbum< / a > < span class = "tsd-signature-symbol" > | < / span > < a href = "classes/_internal_.SpotifyPlaylist.html" class = "tsd-signature-type" data-tsd-kind = "Class" > SpotifyPlaylist< / a > < span class = "tsd-signature-symbol" > | < / span > < a href = "classes/_internal_.SpotifyTrack.html" class = "tsd-signature-type" data-tsd-kind = "Class" > SpotifyTrack< / a > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/play-dl/play-dl/blob/241884d/play-dl/Spotify/index.ts#L141" > play-dl/Spotify/index.ts:141< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2021-11-17 12:38:48 +05:30
< p > type for Spotify Class< / p >
2021-11-18 16:32:54 +05:30
< / div > < / div > < / section > < section class = "tsd-panel tsd-member tsd-kind-type-alias" > < a id = "YouTube" class = "tsd-anchor" > < / a > < h3 > You< wbr / > Tube< / h3 > < div class = "tsd-signature tsd-kind-icon" > You< wbr / > Tube< 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 > < a href = "classes/_internal_.YouTubeChannel.html" class = "tsd-signature-type" data-tsd-kind = "Class" > YouTubeChannel< / a > < span class = "tsd-signature-symbol" > | < / span > < a href = "classes/_internal_.YouTubePlayList.html" class = "tsd-signature-type" data-tsd-kind = "Class" > YouTubePlayList< / a > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/search.ts#L16" > play-dl/YouTube/search.ts:16< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2021-11-17 12:38:48 +05:30
< p > Type for YouTube returns< / p >
2021-11-18 16:32:54 +05:30
< / div > < / div > < / section > < section class = "tsd-panel tsd-member tsd-kind-type-alias" > < a id = "YouTubeStream" class = "tsd-anchor" > < / a > < h3 > You< wbr / > Tube< wbr / > Stream< / h3 > < div class = "tsd-signature tsd-kind-icon" > You< wbr / > Tube< wbr / > Stream< span class = "tsd-signature-symbol" > :< / span > < a href = "modules/_internal_.html" class = "tsd-signature-type" data-tsd-kind = "Namespace" > < internal> < / a > < span class = "tsd-signature-symbol" > .< / span > < a href = "classes/_internal_.Stream.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Stream< / a > < span class = "tsd-signature-symbol" > | < / span > < a href = "classes/_internal_.LiveStream.html" class = "tsd-signature-type" data-tsd-kind = "Class" > LiveStream< / a > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/play-dl/play-dl/blob/241884d/play-dl/YouTube/stream.ts#L40" > play-dl/YouTube/stream.ts:40< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2021-11-17 12:38:48 +05:30
< p > Type for YouTube Stream< / p >
2021-11-18 16:32:54 +05:30
< / div > < / div > < / section > < / section > < section class = "tsd-panel-group tsd-member-group " > < h2 > Functions< / h2 > < section class = "tsd-panel tsd-member tsd-kind-function" > < a id = "attachListeners" class = "tsd-anchor" > < / a > < h3 > attach< wbr / > Listeners< / h3 > < ul class = "tsd-signatures tsd-kind-function" > < li class = "tsd-signature tsd-kind-icon" > attach< wbr / > Listeners< span class = "tsd-signature-symbol" > (< / span > player< span class = "tsd-signature-symbol" > : < / span > < a href = "modules/_internal_.html" class = "tsd-signature-type" data-tsd-kind = "Namespace" > < internal> < / a > < span class = "tsd-signature-symbol" > .< / span > < a href = "classes/_internal_.EventEmitter-1.html" class = "tsd-signature-type" data-tsd-kind = "Class" > EventEmitter< / a > , resource< span class = "tsd-signature-symbol" > : < / span > < a href = "modules.html#YouTubeStream" class = "tsd-signature-type" data-tsd-kind = "Type alias" > YouTubeStream< / a > < span class = "tsd-signature-symbol" > | < / span > < a href = "classes/SoundCloudStream.html" class = "tsd-signature-type" data-tsd-kind = "Class" > SoundCloudStream< / a > < 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/index.ts#L285" > play-dl/index.ts:285< / a > < / li > < / ul > < / aside > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > player: < a href = "modules/_internal_.html" class = "tsd-signature-type" data-tsd-kind = "Namespace" > < internal> < / a > < span class = "tsd-signature-symbol" > .< / span > < a href = "classes/_internal_.EventEmitter-1.html" class = "tsd-signature-type" data-tsd-kind = "Class" > EventEmitter< / a > < / h5 > < / li > < li > < h5 > resource: < a href = "modules.html#YouTubeStream" class = "tsd-signature-type" data-tsd-kind = "Type alias" > YouTubeStream< / a > < span class = "tsd-signature-symbol" > | < / span > < a href = "classes/SoundCloudStream.html" class = "tsd-signature-type" data-tsd-kind = "Class" > SoundCloudStream< / a > < / h5 > < / li > < / ul > < 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-function" > < a id = "authorization" class = "tsd-anchor" > < / a > < h3 > authorization< / h3 > < ul class = "tsd-signatures tsd-kind-function" > < li class = "tsd-signature tsd-kind-icon" > authorization< 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/index.ts#L172" > play-dl/index.ts:172< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2021-11-17 12:38:48 +05:30
< p > Authorization interface for Spotify and SoundCloud.< / p >
2021-11-18 16:32:54 +05:30
< / 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-function" > < a id = "cookieHeaders" class = "tsd-anchor" > < / a > < h3 > cookie< wbr / > Headers< / h3 > < ul class = "tsd-signatures tsd-kind-function" > < li class = "tsd-signature tsd-kind-icon" > cookie< wbr / > Headers< span class = "tsd-signature-symbol" > (< / span > headCookie< 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 > < 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/utils/cookie.ts#L50" > play-dl/YouTube/utils/cookie.ts:50< / a > < / li > < / ul > < / aside > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > headCookie: < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > []< / span > < / h5 > < / li > < / ul > < 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-function" > < a id = "decipher_info" class = "tsd-anchor" > < / a > < h3 > decipher_< wbr / > info< / h3 > < ul class = "tsd-signatures tsd-kind-function" > < li class = "tsd-signature tsd-kind-icon" > decipher_< wbr / > info< span class = "tsd-signature-symbol" > (< / span > data< span class = "tsd-signature-symbol" > : < / span > < a href = "interfaces/_internal_.InfoData.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > InfoData< / a > < 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" > < internal> < / 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" > < < / span > < a href = "interfaces/_internal_.InfoData.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > InfoData< / a > < span class = "tsd-signature-symbol" > > < / 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/utils/extractor.ts#L206" > play-dl/YouTube/utils/extractor.ts:206< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2021-11-17 12:38:48 +05:30
< p > Function uses data from video_basic_info and deciphers it if it contains signatures.< / p >
< / div > < / div > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > data: < a href = "interfaces/_internal_.InfoData.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > InfoData< / a > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
< p > basic_video_info data< / p >
< / div > < / div > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < a href = "modules/_internal_.html" class = "tsd-signature-type" data-tsd-kind = "Namespace" > < internal> < / 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" > < < / span > < a href = "interfaces/_internal_.InfoData.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > InfoData< / a > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div > < p > Data containing video_details, LiveStreamData and formats of video url.< / p >
2021-11-18 16:32:54 +05:30
< / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-function" > < a id = "deezer" class = "tsd-anchor" > < / a > < h3 > deezer< / h3 > < ul class = "tsd-signatures tsd-kind-function" > < li class = "tsd-signature tsd-kind-icon" > deezer< span class = "tsd-signature-symbol" > (< / span > 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 = "modules/_internal_.html" class = "tsd-signature-type" data-tsd-kind = "Namespace" > < internal> < / 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" > < < / span > < a href = "modules.html#Deezer" class = "tsd-signature-type" data-tsd-kind = "Type alias" > Deezer< / a > < span class = "tsd-signature-symbol" > > < / 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/Deezer/index.ts#L111" > play-dl/Deezer/index.ts:111< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2021-11-17 12:38:48 +05:30
< p > Fetches the information for a track, playlist or album on Deezer< / p >
< / div > < / div > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > url: < span class = "tsd-signature-type" > string< / span > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
< p > The track, playlist or album URL< / p >
< / div > < / div > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < a href = "modules/_internal_.html" class = "tsd-signature-type" data-tsd-kind = "Namespace" > < internal> < / 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" > < < / span > < a href = "modules.html#Deezer" class = "tsd-signature-type" data-tsd-kind = "Type alias" > Deezer< / a > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div > < p > A < a href = "classes/_internal_.DeezerTrack.html" > DeezerTrack< / a > , < a href = "classes/_internal_.DeezerPlaylist.html" > DeezerPlaylist< / a > or < a href = "classes/_internal_.DeezerAlbum.html" > DeezerAlbum< / a >
object depending on the provided URL.< / p >
2021-11-18 16:32:54 +05:30
< / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-function" > < a id = "dz_advanced_track_search" class = "tsd-anchor" > < / a > < h3 > dz_< wbr / > advanced_< wbr / > track_< wbr / > search< / h3 > < ul class = "tsd-signatures tsd-kind-function" > < li class = "tsd-signature tsd-kind-icon" > dz_< wbr / > advanced_< wbr / > track_< wbr / > search< span class = "tsd-signature-symbol" > (< / span > options< span class = "tsd-signature-symbol" > : < / span > < a href = "interfaces/_internal_.DeezerAdvancedSearchOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DeezerAdvancedSearchOptions< / a > < 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" > < internal> < / 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" > < < / span > < a href = "classes/_internal_.DeezerTrack.html" class = "tsd-signature-type" data-tsd-kind = "Class" > DeezerTrack< / a > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > > < / 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/Deezer/index.ts#L217" > play-dl/Deezer/index.ts:217< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2021-11-17 12:38:48 +05:30
< p > Searches Deezer for tracks using the specified metadata.< / p >
< / div > < / div > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > options: < a href = "interfaces/_internal_.DeezerAdvancedSearchOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > DeezerAdvancedSearchOptions< / a > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
< p > The metadata and limit for the search< / p >
< ul >
< li > limit?: The maximum number of results to return, maximum < code > 100< / code > , defaults to < code > 10< / code > .< / li >
< li > artist?: The name of the artist< / li >
< li > album?: The title of the album< / li >
< li > title?: The title of the track< / li >
< li > label?: The label that released the track< / li >
< li > minDurationInSec?: The minimum duration in seconds< / li >
< li > maxDurationInSec?: The maximum duration in seconds< / li >
< li > minBpm?: The minimum BPM< / li >
< li > maxBpm?: The minimum BPM< / li >
< / ul >
< / div > < / div > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < a href = "modules/_internal_.html" class = "tsd-signature-type" data-tsd-kind = "Namespace" > < internal> < / 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" > < < / span > < a href = "classes/_internal_.DeezerTrack.html" class = "tsd-signature-type" data-tsd-kind = "Class" > DeezerTrack< / a > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div > < p > An array of tracks matching the metadata< / p >
2021-11-18 16:32:54 +05:30
< / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-function" > < a id = "dz_validate" class = "tsd-anchor" > < / a > < h3 > dz_< wbr / > validate< / h3 > < ul class = "tsd-signatures tsd-kind-function" > < li class = "tsd-signature tsd-kind-icon" > dz_< wbr / > validate< span class = "tsd-signature-symbol" > (< / span > 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 = "modules/_internal_.html" class = "tsd-signature-type" data-tsd-kind = "Namespace" > < internal> < / 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" > < < / span > < span class = "tsd-signature-type" > " track" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " playlist" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " album" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " search" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > false< / span > < span class = "tsd-signature-symbol" > > < / 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/Deezer/index.ts#L145" > play-dl/Deezer/index.ts:145< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2021-11-17 12:38:48 +05:30
< p > Validates a Deezer URL< / p >
< / div > < / div > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > url: < span class = "tsd-signature-type" > string< / span > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
< p > The URL to validate< / p >
< / div > < / div > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < a href = "modules/_internal_.html" class = "tsd-signature-type" data-tsd-kind = "Namespace" > < internal> < / 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" > < < / span > < span class = "tsd-signature-type" > " track" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " playlist" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " album" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " search" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > false< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div > < p > The type of the URL either ' track' , ' playlist' , ' album' , ' search' or false.
false means that the provided URL was a wrongly formatted or unsupported Deezer URL.< / p >
2021-11-18 16:32:54 +05:30
< / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-function" > < a id = "extractID" class = "tsd-anchor" > < / a > < h3 > extractID< / h3 > < ul class = "tsd-signatures tsd-kind-function" > < li class = "tsd-signature tsd-kind-icon" > extractID< span class = "tsd-signature-symbol" > (< / span > 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 > < 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/utils/extractor.ts#L58" > play-dl/YouTube/utils/extractor.ts:58< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2021-11-17 12:38:48 +05:30
< p > Function to extract ID of YouTube url.< / p >
< / div > < / div > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > url: < span class = "tsd-signature-type" > string< / span > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
< p > ID or url of YouTube< / p >
< / div > < / div > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > string< / span > < / h4 > < div > < p > ID of video or playlist.< / p >
2021-11-18 16:32:54 +05:30
< / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-function" > < a id = "getFreeClientID" class = "tsd-anchor" > < / a > < h3 > get< wbr / > Free< wbr / > ClientID< / h3 > < ul class = "tsd-signatures tsd-kind-function" > < li class = "tsd-signature tsd-kind-icon" > get< wbr / > Free< wbr / > ClientID< 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" > < internal> < / 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" > < < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > > < / 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/SoundCloud/index.ts#L92" > play-dl/SoundCloud/index.ts:92< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2021-11-17 12:38:48 +05:30
< p > Function to get Free Client ID of soundcloud.< / p >
< / div > < / div > < h4 class = "tsd-returns-title" > Returns < a href = "modules/_internal_.html" class = "tsd-signature-type" data-tsd-kind = "Namespace" > < internal> < / 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" > < < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div > < p > client ID< / p >
2021-11-18 16:32:54 +05:30
< / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-function" > < a id = "is_expired" class = "tsd-anchor" > < / a > < h3 > is_< wbr / > expired< / h3 > < ul class = "tsd-signatures tsd-kind-function" > < li class = "tsd-signature tsd-kind-icon" > is_< wbr / > expired< 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/Spotify/index.ts#L134" > play-dl/Spotify/index.ts:134< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2021-11-17 12:38:48 +05:30
< p > Function to check if authorization token is expired or not.< / p >
< / div > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > boolean< / span > < / h4 > < div > < p > boolean< / p >
2021-11-18 16:32:54 +05:30
< / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-function" > < a id = "playlist_info" class = "tsd-anchor" > < / a > < h3 > playlist_< wbr / > info< / h3 > < ul class = "tsd-signatures tsd-kind-function" > < li class = "tsd-signature tsd-kind-icon" > playlist_< wbr / > info< span class = "tsd-signature-symbol" > (< / span > url< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > , options< span class = "tsd-signature-symbol" > ?: < / span > < a href = "interfaces/_internal_.PlaylistOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > PlaylistOptions< / a > < 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" > < internal> < / 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" > < < / span > < a href = "classes/_internal_.YouTubePlayList.html" class = "tsd-signature-type" data-tsd-kind = "Class" > YouTubePlayList< / a > < span class = "tsd-signature-symbol" > > < / 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/utils/extractor.ts#L222" > play-dl/YouTube/utils/extractor.ts:222< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2021-11-17 12:38:48 +05:30
< p > Function to get YouTube playlist info from a playlist url.< / p >
< / div > < / div > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > url: < span class = "tsd-signature-type" > string< / span > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
< p > Playlist URL< / p >
< / div > < / div > < / li > < li > < h5 > options: < a href = "interfaces/_internal_.PlaylistOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > PlaylistOptions< / a > < span class = "tsd-signature-symbol" > = {}< / span > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
< p > incomplete and proxy to add.< / p >
< / div > < / div > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < a href = "modules/_internal_.html" class = "tsd-signature-type" data-tsd-kind = "Namespace" > < internal> < / 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" > < < / span > < a href = "classes/_internal_.YouTubePlayList.html" class = "tsd-signature-type" data-tsd-kind = "Class" > YouTubePlayList< / a > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div > < p > YouTube Playlist< / p >
2021-11-18 16:32:54 +05:30
< / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-function" > < a id = "refreshToken" class = "tsd-anchor" > < / a > < h3 > refresh< wbr / > Token< / h3 > < ul class = "tsd-signatures tsd-kind-function" > < li class = "tsd-signature tsd-kind-icon" > refresh< wbr / > Token< 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" > < internal> < / 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" > < < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > > < / 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/Spotify/index.ts#L189" > play-dl/Spotify/index.ts:189< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2021-11-17 12:38:48 +05:30
< p > Function to refresh Token< / p >
< / div > < / div > < h4 class = "tsd-returns-title" > Returns < a href = "modules/_internal_.html" class = "tsd-signature-type" data-tsd-kind = "Namespace" > < internal> < / 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" > < < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div > < p > boolean to check whether token is refreshed or not< / p >
2021-11-18 16:32:54 +05:30
< / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-function" > < a id = "search" class = "tsd-anchor" > < / a > < h3 > search< / h3 > < ul class = "tsd-signatures tsd-kind-function" > < li class = "tsd-signature tsd-kind-icon" > search< span class = "tsd-signature-symbol" > (< / span > query< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > , options< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > { < / span > source< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > { < / span > deezer< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > " album" < / span > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > & < / span > < a href = "interfaces/_internal_.SearchOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > SearchOptions< / a > < 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" > < internal> < / 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" > < < / span > < a href = "classes/_internal_.DeezerAlbum.html" class = "tsd-signature-type" data-tsd-kind = "Class" > DeezerAlbum< / a > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > > < / span > < / li > < li class = "tsd-signature tsd-kind-icon" > search< span class = "tsd-signature-symbol" > (< / span > query< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > , options< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > { < / span > source< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > { < / span > deezer< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > " playlist" < / span > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > & < / span > < a href = "interfaces/_internal_.SearchOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > SearchOptions< / a > < 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" > < internal> < / 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" > < < / span > < a href = "classes/_internal_.DeezerPlaylist.html" class = "tsd-signature-type" data-tsd-kind = "Class" > DeezerPlaylist< / a > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > > < / span > < / li > < li class = "tsd-signature tsd-kind-icon" > search< span class = "tsd-signature-symbol" > (< / span > query< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > , options< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > { < / span > source< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > { < / span > deezer< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > " track" < / span > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > & < / span > < a href = "interfaces/_internal_.SearchOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > SearchOptions< / a > < 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" > < internal> < / 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" > < < / span > < a href = "classes/_internal_.DeezerTrack.html" class = "tsd-signature-type" data-tsd-kind = "Class" > DeezerTrack
2021-11-17 12:38:48 +05:30
< p > Main Search Command for searching through various sources< / p >
< / div > < / div > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > query: < span class = "tsd-signature-type" > string< / span > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
< p > string to search.< / p >
2021-11-18 15:38:25 +05:30
< / div > < / div > < / li > < li > < h5 > options: < span class = "tsd-signature-symbol" > { < / span > source< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > { < / span > deezer< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > " album" < / span > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > & < / span > < a href = "interfaces/_internal_.SearchOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > SearchOptions< / a > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2021-11-17 12:38:48 +05:30
< p > contains limit and source to choose.< / p >
2021-11-18 15:38:25 +05:30
< / div > < / div > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < a href = "modules/_internal_.html" class = "tsd-signature-type" data-tsd-kind = "Namespace" > < internal> < / 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" > < < / span > < a href = "classes/_internal_.DeezerAlbum.html" class = "tsd-signature-type" data-tsd-kind = "Class" > DeezerAlbum< / a > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div > < p > Array of YouTube or Spotify or SoundCloud or Deezer
deezer?: ' track' | ' playlist' | ' album' ;< / p >
2021-11-18 16:32:54 +05:30
< / div > < / li > < 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/index.ts#L93" > play-dl/index.ts:93< / a > < / li > < / ul > < / aside > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > query: < span class = "tsd-signature-type" > string< / span > < / h5 > < / li > < li > < h5 > options: < span class = "tsd-signature-symbol" > { < / span > source< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > { < / span > deezer< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > " playlist" < / span > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > & < / span > < a href = "interfaces/_internal_.SearchOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > SearchOptions< / a > < / h5 > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < a href = "modules/_internal_.html" class = "tsd-signature-type" data-tsd-kind = "Namespace" > < internal> < / 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" > < < / span > < a href = "classes/_internal_.DeezerPlaylist.html" class = "tsd-signature-type" data-tsd-kind = "Class" > DeezerPlaylist< / a > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < / li > < 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/index.ts#L94" > play-dl/index.ts:94< / a > < / li > < / ul > < / aside > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > query: < span class = "tsd-signature-type" > string< / span > < / h5 > < / li > < li > < h5 > options: < span class = "tsd-signature-symbol" > { < / span > source< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > { < / span > deezer< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > " track" < / span > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > & < / span > < a href = "interfaces/_internal_.SearchOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > SearchOptions< / a > < / h5 > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < a href = "modules/_internal_.html" class = "tsd-signature-type" data-tsd-kind = "Namespace" > < internal> < / 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" > < < / span > < a href = "classes/_internal_.DeezerTrack.html" class = "tsd-signature-type" data-tsd-kind = "Class" > DeezerTrack< / a > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < / li > < 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/index.ts#L95" > play-dl/index.ts:95< / a > < / li > < / ul > < / aside > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > query: < span class = "tsd-signature-type" > string< / span > < / h5 > < / li > < li > < h5 > options: < span class = "tsd-signature-symbol" > { < / span > source< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > { < / span > soundcloud< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > " albums" < / span > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > & < / span > < a href = "interfaces/_internal_.SearchOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > SearchOptions< / a > < / h5 > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < a href = "modules/_internal_.html" class = "tsd-signature-type" data-tsd-kind = "Namespace" > < internal> < / 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" > < < / span > < a
2021-11-17 12:38:48 +05:30
< p > Function to validate for a soundcloud url< / p >
< / div > < / div > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > url: < span class = "tsd-signature-type" > string< / span > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
< p > soundcloud url< / p >
< / div > < / div > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < a href = "modules/_internal_.html" class = "tsd-signature-type" data-tsd-kind = "Namespace" > < internal> < / 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" > < < / span > < span class = "tsd-signature-type" > false< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " track" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " playlist" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " search" < / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div > < p > " false" | ' track' | ' playlist' < / p >
2021-11-18 16:32:54 +05:30
< / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-function" > < a id = "soundcloud" class = "tsd-anchor" > < / a > < h3 > soundcloud< / h3 > < ul class = "tsd-signatures tsd-kind-function" > < li class = "tsd-signature tsd-kind-icon" > soundcloud< span class = "tsd-signature-symbol" > (< / span > 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 = "modules/_internal_.html" class = "tsd-signature-type" data-tsd-kind = "Namespace" > < internal> < / 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" > < < / span > < a href = "modules.html#SoundCloud" class = "tsd-signature-type" data-tsd-kind = "Type alias" > SoundCloud< / a > < span class = "tsd-signature-symbol" > > < / 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/SoundCloud/index.ts#L21" > play-dl/SoundCloud/index.ts:21< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2021-11-17 12:38:48 +05:30
< p > Function to get info from a soundcloud url< / p >
< / div > < / div > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > url: < span class = "tsd-signature-type" > string< / span > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
< p > soundcloud url< / p >
< / div > < / div > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < a href = "modules/_internal_.html" class = "tsd-signature-type" data-tsd-kind = "Namespace" > < internal> < / 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" > < < / span > < a href = "modules.html#SoundCloud" class = "tsd-signature-type" data-tsd-kind = "Type alias" > SoundCloud< / a > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div > < p > SoundCloud Track or SoundCloud Playlist< / p >
2021-11-18 16:32:54 +05:30
< / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-function" > < a id = "sp_validate" class = "tsd-anchor" > < / a > < h3 > sp_< wbr / > validate< / h3 > < ul class = "tsd-signatures tsd-kind-function" > < li class = "tsd-signature tsd-kind-icon" > sp_< wbr / > validate< span class = "tsd-signature-symbol" > (< / span > 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 > < span class = "tsd-signature-type" > " track" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " playlist" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " album" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " search" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > false< / 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/Spotify/index.ts#L79" > play-dl/Spotify/index.ts:79< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2021-11-17 12:38:48 +05:30
< p > Function to validate Spotify url< / p >
< / div > < / div > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > url: < span class = "tsd-signature-type" > string< / span > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
< p > url for validation< / p >
< / div > < / div > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > " track" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " playlist" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " album" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " search" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > false< / span > < / h4 > < div > < p > type of url or false.< / p >
2021-11-18 16:32:54 +05:30
< / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-function" > < a id = "spotify" class = "tsd-anchor" > < / a > < h3 > spotify< / h3 > < ul class = "tsd-signatures tsd-kind-function" > < li class = "tsd-signature tsd-kind-icon" > spotify< span class = "tsd-signature-symbol" > (< / span > 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 = "modules/_internal_.html" class = "tsd-signature-type" data-tsd-kind = "Namespace" > < internal> < / 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" > < < / span > < a href = "modules.html#Spotify" class = "tsd-signature-type" data-tsd-kind = "Type alias" > Spotify< / a > < span class = "tsd-signature-symbol" > > < / 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/Spotify/index.ts#L33" > play-dl/Spotify/index.ts:33< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2021-11-17 12:38:48 +05:30
< p > Function to get Playlist | Album | Track< / p >
< / div > < / div > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > url: < span class = "tsd-signature-type" > string< / span > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
< p > url of spotify from which you want info< / p >
< / div > < / div > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < a href = "modules/_internal_.html" class = "tsd-signature-type" data-tsd-kind = "Namespace" > < internal> < / 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" > < < / span > < a href = "modules.html#Spotify" class = "tsd-signature-type" data-tsd-kind = "Type alias" > Spotify< / a > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div > < p > Spotify type.< / p >
2021-11-18 16:32:54 +05:30
< / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-function" > < a id = "stream" class = "tsd-anchor" > < / a > < h3 > stream< / h3 > < ul class = "tsd-signatures tsd-kind-function" > < li class = "tsd-signature tsd-kind-icon" > stream< span class = "tsd-signature-symbol" > (< / span > url< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > , options< span class = "tsd-signature-symbol" > ?: < / span > < a href = "modules/_internal_.html" class = "tsd-signature-type" data-tsd-kind = "Namespace" > < internal> < / a > < span class = "tsd-signature-symbol" > .< / span > < a href = "interfaces/_internal_.StreamOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > StreamOptions< / a > < 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" > < internal> < / 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" > < < / span > < a href = "modules.html#YouTubeStream" class = "tsd-signature-type" data-tsd-kind = "Type alias" > YouTubeStream< / a > < span class = "tsd-signature-symbol" > | < / span > < a href = "classes/SoundCloudStream.html" class = "tsd-signature-type" data-tsd-kind = "Class" > SoundCloudStream< / a > < span class = "tsd-signature-symbol" > > < / 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/index.ts#L68" > play-dl/index.ts:68< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2021-11-17 12:38:48 +05:30
< p > Main stream Command for streaming through various sources< / p >
< / div > < / div > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > url: < span class = "tsd-signature-type" > string< / span > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
< p > The video / track url to make stream of< / p >
< / div > < / div > < / li > < li > < h5 > options: < a href = "modules/_internal_.html" class = "tsd-signature-type" data-tsd-kind = "Namespace" > < internal> < / a > < span class = "tsd-signature-symbol" > .< / span > < a href = "interfaces/_internal_.StreamOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > StreamOptions< / a > < span class = "tsd-signature-symbol" > = {}< / span > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
< p > contains quality, cookie and proxy to set for stream< / p >
2021-11-18 15:48:33 +05:30
< / div > < / div > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < a href = "modules/_internal_.html" class = "tsd-signature-type" data-tsd-kind = "Namespace" > < internal> < / 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" > < < / span > < a href = "modules.html#YouTubeStream" class = "tsd-signature-type" data-tsd-kind = "Type alias" > YouTubeStream< / a > < span class = "tsd-signature-symbol" > | < / span > < a href = "classes/SoundCloudStream.html" class = "tsd-signature-type" data-tsd-kind = "Class" > SoundCloudStream< / a > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div > < p > YouTube / SoundCloud Stream to play< / p >
2021-11-18 16:32:54 +05:30
< / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-function" > < a id = "stream_from_info" class = "tsd-anchor" > < / a > < h3 > stream_< wbr / > from_< wbr / > info< / h3 > < ul class = "tsd-signatures tsd-kind-function" > < li class = "tsd-signature tsd-kind-icon" > stream_< wbr / > from_< wbr / > info< span class = "tsd-signature-symbol" > (< / span > info< span class = "tsd-signature-symbol" > : < / span > < a href = "classes/_internal_.SoundCloudTrack.html" class = "tsd-signature-type" data-tsd-kind = "Class" > SoundCloudTrack< / a > < span class = "tsd-signature-symbol" > | < / span > < a href = "interfaces/_internal_.InfoData.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > InfoData< / a > , options< span class = "tsd-signature-symbol" > ?: < / span > < a href = "modules/_internal_.html" class = "tsd-signature-type" data-tsd-kind = "Namespace" > < internal> < / a > < span class = "tsd-signature-symbol" > .< / span > < a href = "interfaces/_internal_.StreamOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > StreamOptions< / a > < 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" > < internal> < / 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" > < < / span > < a href = "modules.html#YouTubeStream" class = "tsd-signature-type" data-tsd-kind = "Type alias" > YouTubeStream< / a > < span class = "tsd-signature-symbol" > | < / span > < a href = "classes/SoundCloudStream.html" class = "tsd-signature-type" data-tsd-kind = "Class" > SoundCloudStream< / a > < span class = "tsd-signature-symbol" > > < / 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/index.ts#L125" > play-dl/index.ts:125< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2021-11-17 12:38:48 +05:30
< p > stream Command for streaming through various sources using data from video_info or soundcloud
SoundCloud Track is only supported< / p >
< / div > < / div > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > info: < a href = "classes/_internal_.SoundCloudTrack.html" class = "tsd-signature-type" data-tsd-kind = "Class" > SoundCloudTrack< / a > < span class = "tsd-signature-symbol" > | < / span > < a href = "interfaces/_internal_.InfoData.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > InfoData< / a > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
< p > video_info data or SoundCloud Track data.< / p >
< / div > < / div > < / li > < li > < h5 > options: < a href = "modules/_internal_.html" class = "tsd-signature-type" data-tsd-kind = "Namespace" > < internal> < / a > < span class = "tsd-signature-symbol" > .< / span > < a href = "interfaces/_internal_.StreamOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > StreamOptions< / a > < span class = "tsd-signature-symbol" > = {}< / span > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
< p > contains quality, cookie and proxy to set for stream< / p >
2021-11-18 15:48:33 +05:30
< / div > < / div > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < a href = "modules/_internal_.html" class = "tsd-signature-type" data-tsd-kind = "Namespace" > < internal> < / 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" > < < / span > < a href = "modules.html#YouTubeStream" class = "tsd-signature-type" data-tsd-kind = "Type alias" > YouTubeStream< / a > < span class = "tsd-signature-symbol" > | < / span > < a href = "classes/SoundCloudStream.html" class = "tsd-signature-type" data-tsd-kind = "Class" > SoundCloudStream< / a > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div > < p > YouTube / SoundCloud Stream to play< / p >
2021-11-18 16:32:54 +05:30
< / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-function" > < a id = "validate" class = "tsd-anchor" > < / a > < h3 > validate< / h3 > < ul class = "tsd-signatures tsd-kind-function" > < li class = "tsd-signature tsd-kind-icon" > validate< span class = "tsd-signature-symbol" > (< / span > 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 = "modules/_internal_.html" class = "tsd-signature-type" data-tsd-kind = "Namespace" > < internal> < / 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" > < < / span > < span class = "tsd-signature-type" > " so_playlist" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " so_track" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " sp_track" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " sp_album" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " sp_playlist" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " dz_track" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " dz_playlist" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " dz_album" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " yt_video" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " yt_playlist" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " search" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > false< / span > < span class = "tsd-signature-symbol" > > < / 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/index.ts#L137" > play-dl/index.ts:137< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2021-11-17 12:38:48 +05:30
< p > Command to validate the provided url. It checks whether it supports play-dl or not.< / p >
< / div > < / div > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > url: < span class = "tsd-signature-type" > string< / span > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
< p > url to validate< / p >
< / div > < / div > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < a href = "modules/_internal_.html" class = "tsd-signature-type" data-tsd-kind = "Namespace" > < internal> < / 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" > < < / span > < span class = "tsd-signature-type" > " so_playlist" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " so_track" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " sp_track" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " sp_album" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " sp_playlist" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " dz_track" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " dz_playlist" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " dz_album" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " yt_video" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " yt_playlist" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " search" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > false< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div > < p > On failure, returns false else type of url.< / p >
2021-11-18 16:32:54 +05:30
< / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-function" > < a id = "video_basic_info" class = "tsd-anchor" > < / a > < h3 > video_< wbr / > basic_< wbr / > info< / h3 > < ul class = "tsd-signatures tsd-kind-function" > < li class = "tsd-signature tsd-kind-icon" > video_< wbr / > basic_< wbr / > info< span class = "tsd-signature-symbol" > (< / span > url< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > , options< span class = "tsd-signature-symbol" > ?: < / span > < a href = "interfaces/_internal_.InfoOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > InfoOptions< / a > < 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" > < internal> < / 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" > < < / span > < a href = "interfaces/_internal_.InfoData.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > InfoData< / a > < span class = "tsd-signature-symbol" > > < / 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/utils/extractor.ts#L82" > play-dl/YouTube/utils/extractor.ts:82< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2021-11-17 12:38:48 +05:30
< p > Basic function to get data from a YouTube url or ID.< / p >
< / div > < / div > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > url: < span class = "tsd-signature-type" > string< / span > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
< p > YouTube url or ID< / p >
< / div > < / div > < / li > < li > < h5 > options: < a href = "interfaces/_internal_.InfoOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > InfoOptions< / a > < span class = "tsd-signature-symbol" > = {}< / span > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
< p > cookie and proxy parameters to add< / p >
2021-11-18 15:38:25 +05:30
< / div > < / div > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < a href = "modules/_internal_.html" class = "tsd-signature-type" data-tsd-kind = "Namespace" > < internal> < / 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" > < < / span > < a href = "interfaces/_internal_.InfoData.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > InfoData< / a > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div > < p > Data containing video_details, LiveStreamData and formats of video url.< / p >
2021-11-18 16:32:54 +05:30
< / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-function" > < a id = "video_info" class = "tsd-anchor" > < / a > < h3 > video_< wbr / > info< / h3 > < ul class = "tsd-signatures tsd-kind-function" > < li class = "tsd-signature tsd-kind-icon" > video_< wbr / > info< span class = "tsd-signature-symbol" > (< / span > url< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > , options< span class = "tsd-signature-symbol" > ?: < / span > < a href = "interfaces/_internal_.InfoOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > InfoOptions< / a > < 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" > < internal> < / 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" > < < / span > < a href = "interfaces/_internal_.InfoData.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > InfoData< / a > < span class = "tsd-signature-symbol" > > < / 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/utils/extractor.ts#L190" > play-dl/YouTube/utils/extractor.ts:190< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2021-11-17 12:38:48 +05:30
< p > Function which gets data from video_basic_info and deciphers it if it contains signatures.< / p >
< / div > < / div > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > url: < span class = "tsd-signature-type" > string< / span > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
< p > YouTube Video URL< / p >
< / div > < / div > < / li > < li > < h5 > options: < a href = "interfaces/_internal_.InfoOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > InfoOptions< / a > < span class = "tsd-signature-symbol" > = {}< / span > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
< p > cookie and proxy parameters to add< / p >
2021-11-18 15:38:25 +05:30
< / div > < / div > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < a href = "modules/_internal_.html" class = "tsd-signature-type" data-tsd-kind = "Namespace" > < internal> < / 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" > < < / span > < a href = "interfaces/_internal_.InfoData.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > InfoData< / a > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < div > < p > Data containing video_details, LiveStreamData and formats of video url.< / p >
2021-11-18 16:32:54 +05:30
< / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-function" > < a id = "yt_validate" class = "tsd-anchor" > < / a > < h3 > yt_< wbr / > validate< / h3 > < ul class = "tsd-signatures tsd-kind-function" > < li class = "tsd-signature tsd-kind-icon" > yt_< wbr / > validate< span class = "tsd-signature-symbol" > (< / span > 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 > < span class = "tsd-signature-type" > " playlist" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " video" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " search" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > false< / 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/utils/extractor.ts#L29" > play-dl/YouTube/utils/extractor.ts:29< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2021-11-17 12:38:48 +05:30
< p > Command to validate a YouTube url< / p >
< / div > < / div > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > url: < span class = "tsd-signature-type" > string< / span > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
< p > Url for validation< / p >
< / div > < / div > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > " playlist" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " video" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > " search" < / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > false< / span > < / h4 > < div > < p > type of url or false.< / p >
2021-11-18 15:48:33 +05:30
< / 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 = "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-class" > < a href = "classes/SoundCloudStream.html" class = "tsd-kind-icon" > Sound< wbr / > Cloud< wbr / > Stream< / a > < / li > < 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#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_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 > 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< /sp
