yuzu/play-dl-test
1
0
Fork 0
mirror of https://github.com/YuzuZensai/play-dl-test.git synced 2026-01-06 04:32:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added Docs for stream seek

Browse Source
This commit is contained in:
killer069
2021-12-14 15:33:18 +05:30
parent 4b4875b97f
commit f6287bc1b7
3 changed files with 38 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
play-dl/index.ts
View File

@@ -86,6 +86,8 @@ import { YouTubeChannel } from './YouTube/classes/Channel';
import { SpotifyAlbum, SpotifyPlaylist, SpotifyTrack } from './Spotify/classes';
import { DeezerAlbum, DeezerPlaylist, DeezerTrack } from './Deezer/classes';
export async function stream(url: string, options: { seek? : number , seekMode?: 'precise' | 'granular'} & StreamOptions) : Promise<YouTubeStream>
export async function stream(url: string, options? : StreamOptions) : Promise<YouTubeStream | SoundCloudStream>
/**
* Creates a Stream [ YouTube or SoundCloud ] class from a url for playing.
*
@@ -94,7 +96,14 @@ import { DeezerAlbum, DeezerPlaylist, DeezerTrack } from './Deezer/classes';
* const source = await play.stream('youtube video URL') // YouTube Video Stream
*
* const source = await play.stream('soundcloud track URL') // SoundCloud Track Stream
*
*
* const source = await play.stream('youtube video URL', { seek : 45 }) // Seeks 45 seconds (approx.) in YouTube Video Stream [ seekMode = "granular" ]
* // Granular = 1 - 9 seconds before given time. [ Fast ]
* // Precise = Exact seek [ Little bit Slow ]
* // Above command seeks to 45 seconds approximately while below command seeks to 45 seconds precisely
*
* const source = await play.stream('youtube video URL', { seek : 45, seekMode: "precise" }) // Seeks precisely to 45 seconds in YouTube Video Stream
*
* const resource = createAudioResource(source.stream, {
* inputType : source.type
* }) // Use discordjs voice createAudioResource function.
@@ -215,6 +224,8 @@ export async function search(
else throw new Error('Not possible to reach Here LOL. Easter Egg of play-dl if someone get this.');
}
export async function stream_from_info(info: SoundCloudTrack, options? : StreamOptions) : Promise<SoundCloudStream>
export async function stream_from_info(info: InfoData, options? : StreamOptions) : Promise<YouTubeStream>
/**
* Creates a Stream [ YouTube or SoundCloud ] class from video or track info for playing.
*
@@ -225,6 +236,13 @@ export async function search(
*
* const soundInfo = await play.soundcloud('SoundCloud URL')
* const source = await play.stream_from_info(soundInfo) // SoundCloud Track Stream
*
* const source = await play.stream_from_info(info, { seek : 45 }) // Seeks 45 seconds (approx.) in YouTube Video Stream [ seekMode = "granular" ]
* // Granular = 1 - 9 seconds before given time. [ Fast ]
* // Precise = Exact seek [ Little bit Slow ]
* // Above command seeks to 45 seconds approximately while below command seeks to 45 seconds precisely
*
* const source = await play.stream_from_info(info, { seek : 45, seekMode: "precise" }) // Seeks precisely to 45 seconds in YouTube Video Stream
*
* const resource = createAudioResource(source.stream, {
* inputType : source.type