diff --git a/README.md b/README.md index b3fa947..9824a68 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,17 @@ import play from 'play-dl'; // Everything import { video_basic_info, stream } from 'play-dl'; // Individual functions ``` +## **Compatibility issues** - discord-player + +Because discord-player doesn't work with raw opus packets you need to enable the compatibility mode in `play-dl`, if you want to use both frameworks together. + +- To fix the playback of YouTube videos with `discord-player`, you can disable some of play-dl's optimisations and fixes by setting the `discordPlayerCompatibility` option for `stream` and `stream_from_info` to true + +- The `discordPlayerCompatiblity` option breaks the playback of long YouTube videos. + +- Even with the `discordPlayerCompatibility` option set you will not be able to use the seek option for `stream` and `stream_from_info`. + + ### [Documentation](https://play-dl.github.io/modules.html) ### [Examples](./examples) ### [Instructions](./instructions) diff --git a/play-dl/index.ts b/play-dl/index.ts index 60e1bc8..f92770d 100644 --- a/play-dl/index.ts +++ b/play-dl/index.ts @@ -100,7 +100,7 @@ async function stream(url: string, options?: StreamOptions): Promise { @@ -240,7 +240,7 @@ async function stream_from_info(info: InfoData, options?: StreamOptions): Promis * - `number` quality : Quality number. [ 0 = Lowest, 1 = Medium, 2 = Highest ] * - `boolean` htmldata : given data is html data or not * - `number` precache : No of segments of data to store before looping [YouTube Live Stream only]. [ Defaults to 3 ] - * - `boolean` discordPlayerCompatibility : Conversion of Webm to Opus[ Defaults to true ] + * - `boolean` discordPlayerCompatibility : Conversion of Webm to Opus[ Defaults to false ] * @returns A {@link YouTubeStream} or {@link SoundCloudStream} Stream to play */ async function stream_from_info(