From eef4f50144003579c3c432e782df7d50bb9d98e9 Mon Sep 17 00:00:00 2001 From: Snowflake107 Date: Wed, 21 Apr 2021 16:24:51 +0545 Subject: [PATCH] docs --- docs/extractors/extractor.md | 16 ++++++++++++++-- docs/youtube/cookies.md | 5 ++++- src/Player.ts | 2 +- src/Structures/Track.ts | 2 +- 4 files changed, 20 insertions(+), 5 deletions(-) diff --git a/docs/extractors/extractor.md b/docs/extractors/extractor.md index c4c5bd0..9510969 100644 --- a/docs/extractors/extractor.md +++ b/docs/extractors/extractor.md @@ -73,5 +73,17 @@ player.use("GiveItSomeName", myExtractor); player.unuse("GiveItSomeName"); ``` -# Examples -### You can check out **[@discord-player/extractor](https://github.com/Snowflake107/discord-player-extractors)** \ No newline at end of file +# Readymade Extractors +## **[@discord-player/extractor](https://github.com/Snowflake107/discord-player-extractors)** +This extractor enables optional sources such as `Discord Attachments`, `Vimeo`, `Facebook` and `Reverbnation`. It also enables the `Lyrics` feature! + +## **[@discord-player/downloader](https://github.com/DevSnowflake/discord-player-downloader)** +This extractor is based on **[YouTube DL](https://youtube-dl.org)**. This extractor enables `700+ websites` support. However, this extractor can get buggy and is not updated frequently. So, it is suggested to make your own extractor if you want to use it! + +```js +const downloader = require("@discord-player/downloader").Downloader; + +player.use("YOUTUBE_DL", downloader); +``` + +> Discord Player auto-detects and uses `@discord-player/extractor` if it is installed! \ No newline at end of file diff --git a/docs/youtube/cookies.md b/docs/youtube/cookies.md index 3149972..2405dcf 100644 --- a/docs/youtube/cookies.md +++ b/docs/youtube/cookies.md @@ -12,4 +12,7 @@ const player = new Player(client, { } } }); -``` \ No newline at end of file +``` + +> Keep in mind that using `cookies` after getting `429` **does not fix the problem**. +> You should use `cookies` before getting `429` which helps to **_reduce_** `Error: Status Code 429` \ No newline at end of file diff --git a/src/Player.ts b/src/Player.ts index ca5298c..1fb1be0 100644 --- a/src/Player.ts +++ b/src/Player.ts @@ -1232,7 +1232,7 @@ export default Player; * @param {DiscordMessage} message The message * @param {String} query The query * @param {Track[]} tracks The tracks - * @param {DiscordCollector} collector The collector + * @param {DiscordMessageCollector} collector The collector */ /** diff --git a/src/Structures/Track.ts b/src/Structures/Track.ts index 9ac73ad..b2759f1 100644 --- a/src/Structures/Track.ts +++ b/src/Structures/Track.ts @@ -23,7 +23,7 @@ export class Track { */ constructor(player: Player, data: TrackData) { /** - * The player that instantiated this Queue + * The player that instantiated this Track * @name Track#player * @type {Player} * @readonly