Files
play-dl-test/README.md

51 lines
1.8 KiB
Markdown
Raw Normal View History

# Why play-dl ?
2021-08-22 18:49:25 +05:30
[ytdl-core](https://github.com/fent/node-ytdl-core) has some issues with miniget and also stream abort issues. On the other hand, [youtube-dl](https://github.com/ytdl-org/youtube-dl) 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.
2021-08-22 18:49:25 +05:30
2021-09-21 13:49:27 +05:30
[![Discord](https://img.shields.io/discord/888998674716315679?color=00ff00&label=%20Discord&logo=Discord)](https://discord.gg/8H3xWcv3D7)
2021-09-21 13:30:42 +05:30
## Support
2021-09-21 14:50:13 +05:30
You can contact us for support on our [chat server](https://discord.gg/8H3xWcv3D7)
2021-09-21 13:30:42 +05:30
## Stream videos/playlists or search for videos
2021-08-22 18:49:25 +05:30
This is a **light-weight** youtube downloader and searcher.
2021-09-21 13:00:38 +05:30
- searches by video, playlist, channel
- obtains audio playback url
2021-08-22 18:49:25 +05:30
### Installation
```bash
2021-08-22 18:49:25 +05:30
npm install play-dl@latest
```
### Importing
2021-09-21 13:00:38 +05:30
```ts
import * as play from 'play-dl' // ES-6 import or TS import
const play = require('play-dl') //JS importing
```
2021-09-21 13:30:42 +05:30
## Instructions
- 1.0 release change brings some code changes, make sure to read docs once again.
2021-09-21 13:54:23 +05:30
- [Spotify](https://github.com/play-dl/play-dl/discussions/64)
2021-09-21 15:05:45 +05:30
- [SoundCloud](https://github.com/play-dl/play-dl/discussions/92)
2021-09-09 13:32:41 +05:30
### Examples
2021-09-21 13:00:38 +05:30
- [YouTube](https://github.com/play-dl/play-dl/tree/main/examples/YouTube)
- [Spotify](https://github.com/play-dl/play-dl/tree/main/examples/Spotify)
2021-09-21 14:52:30 +05:30
- [SoundCloud](https://github.com/play-dl/play-dl/tree/main/examples/SoundCloud)
2021-09-05 18:50:57 +05:30
### Docs
2021-09-21 13:00:38 +05:30
- [Main](https://github.com/play-dl/play-dl/tree/main/docs#play-dl-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)
2021-09-21 14:52:30 +05:30
- [SoundCloud](https://github.com/play-dl/play-dl/tree/main/docs/SoundCloud)
- [Deezer](https://github.com/play-dl/play-dl/tree/main/docs/Deezer)