play-dl-test/docs/README.md

# Play-dl commands

For source specific commands :-

-   [YouTube](https://github.com/play-dl/play-dl/tree/main/docs/YouTube#youtube)
-   [Spotify](https://github.com/play-dl/play-dl/tree/main/docs/Spotify#spotify)
-   [SoundCloud](https://github.com/play-dl/play-dl/tree/main/docs/SoundCloud)

### Validate

#### validate(url : `string`)

_This checks all type of urls that are supported by play-dl._

**Returns :** `so_playlist` | `so_track` | `sp_track` | `sp_album` | `sp_playlist` | `yt_video` | `yt_playlist` | `false`

`so` = **SoundCloud**

`sp` = **Spotify**

`yt` = **YouTube**

```js
let check = await validate(url)

if(!check) // Invalid URL

if(check === 'yt_video') // YouTube Video

if(check === 'sp_track') // Spotify Track

if(check === 'so_track') // SoundCloud Track
```

### authorization()

_This creates basic spotify / soundcloud data to be stored locally._

```js
authorization() //After then you will be asked about type of data you want to create and then follow the steps properly.
```

### Search

#### SearchOptions :

-   limit : `number` :- Sets total amount of results you want.
-   source : {

    youtube: `video` | `playlist` | `channel` ;

    spotify: `album` | `playlist` | `track` ;

    soundcloud: `tracks` | `playlists` | `albums` ;

    }

#### search(query : `string`, options? : [`SearchOptions`](https://github.com/play-dl/play-dl/tree/main/docs#searchoptions-))

_This is basic to search with any source._

**NOTE :-** If options.source is not specified, then it will default to youtube video search.

```js
let data = await search('Rick Roll', { limit : 1 }) // Searches for youtube video

let data = await search('Rick Roll', { limit : 1, source { youtube : "video" } }) // Searches for youtube video

let data = await search('Rick Roll', { limit: 1, source { spotify : "track" } }) // Searches for spotify track.

let data = await search('Rick Roll', { limit: 1, source { soundcloud : "tracks" } }) // Searches for soundcloud track.
```

### Stream

#### StreamOptions :

-   quality : `number` :- Sets quality of stream [ 0 = Lowest, 1 = Medium ]. Leave this empty to get highest audio quality.
-   cookie : `string` :- **[Cookies](https://github.com/play-dl/play-dl/discussions/34)** are optional and are required for playing age restricted videos.

#### stream(url : `string`, options? : [`StreamOptions`](https://github.com/play-dl/play-dl/tree/main/docs#streamoptions-))

_This is basic to create a stream from a youtube or soundcloud url._

```js
let source = await stream("url") // This will create a stream Class. Highest Quality

let source = await stream("url", { quality : 0 }) // Lowest quality

let source = await stream("url", { quality : 1 }) // Next to Lowest quality.

let source = await stream("url", { cookie: COOKIE }) //This will create a stream Class and also give cookies.

let resource = createAudioResource(source.stream, {
            inputType : source.type
        }) // This creates resource for playing
```

#### stream_from_info(info : `infoData`, options? : [`StreamOptions`](https://github.com/play-dl/play-dl/tree/main/docs#streamoptions-))

_This is basic to create a stream from a info [ from [video_info](https://github.com/play-dl/play-dl#video_infourl--string) function or [soundcloud](https://github.com/play-dl/play-dl/tree/main/docs/SoundCloud#soundcloudurl--string) function [**Only SoundCloudTrack class is allowed**] ]._

**Note :** Here, cookies are required only for retrying purposes.

```js
let source = await stream_from_info(info) // This will create a stream Class from video_info or SoundCoudTrack Class. Highest Quality
 
let source = await stream_from_info(info, { quality : 0 }) // Lowest quality

let source = await stream_from_info(info, { quality : 1 }) // Next to Lowest quality.

let source = await stream_from_info(info, { cookie: COOKIE }) //This will create a stream Class and also give cookies if retrying.


 let resource = createAudioResource(source.stream, {
            inputType : source.type
        }) // This creates resource for playing
```