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

ReadMe updated

Browse Source
This commit is contained in:
killer069 2021-08-31 09:20:47 +05:30
parent d8ba1f1b9e
commit b91cfdcf00
1 changed files with 9 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -32,22 +32,25 @@ const options = {
const results = await youtube.search('post malone sunflower', options);
```
# Validate
### validate( url : `string` )
*Much faster and easier way to validate url.*
```js
if(validate(url)) // Will return true if url is a YouTube url
```
# Stream
### stream(url : `string`, error_check? : `boolean`)
### stream(url : `string`)
*This is basic to create a youtube stream from a url.*
```js
let source = await stream(<url>) // This will create a stream Class which contains type and stream to be played.
let resource = createAudioResource(source.stream, {
inputType : source.type
}) // This creates resource for playing
let source = await stream(<url>, true) //This will check for 404 error if any
```
![#f03c15](https://via.placeholder.com/15/f03c15/000000?text=+) `Note : enabling error_check will take more time to start streaming`
### stream_from_info(info : `infoData`, error_check? : `boolean`)
### stream_from_info(info : `infoData`)
*This is basic to create a youtube stream from a info [ from video_info function ].*
```js
let info = await video_info(<url>)
@ -55,11 +58,7 @@ let info = await video_info(<url>)
let resource = createAudioResource(source.stream, {
inputType : source.type
}) // This creates resource for playing
let source = await stream_from_info(info, true) //This will check for 404 error if any
```
![#f03c15](https://via.placeholder.com/15/f03c15/000000?text=+) `Note : enabling error_check will take more time to start streaming`
# Search