spike-player

import { AudioPlayerError, AudioResource } from "@discordjs/voice"; import { User } from "discord.js"; import { Song, Queue, Playlist } from ".."; /** * Player options * @typedef {object} PlayerOptions * @param {boolean} [leaveOnEnd=true] If it should leave on end * @param {boolean} [leaveOnStop=true] If it should leave on stop * @param {boolean} [leaveOnEmpty=true] If it should leave on empty voice channel * @param {boolean} [deafenOnJoin=false] If it should deafen on join * @param {number} [timeout=0] Voice channel leave timeout * @param {number} [volume=100] Player volume * @param {string} [quality=high] Player quality * @param {string} [localAddress] Custom ipv4/ipv6 address * @param {string} [ytdlRequestOptions] Custom YTDL Request Options object */ export interface PlayerOptions { leaveOnEnd?: boolean; leaveOnStop?: boolean; leaveOnEmpty?: boolean; deafenOnJoin?: boolean; timeout?: number; volume?: number; quality?: "low" | "high"; localAddress?: string; ytdlRequestOptions?: object; } /** * Play options * @typedef {object} PlayOptions * @param {string} [uploadDate] Search sort by Upload date * @param {string} [duration] Search sort by Duration * @param {string} [sortBy=relevance] Search sort by Sort by * @param {boolean} [timecode=false] If url with timecode (?t=) provided, will play from that moment * @param {number} [index] If the index was provided, it will add the song after the provided index in the Queue * @param {number} [seek] Seek to a specific time * @param {User} [requestedBy] The User who requested the Song * @param {string} [localAddress] Custom ipv4/ipv6 address */ export interface PlayOptions { uploadDate?: "hour" | "today" | "week" | "month" | "year"; duration?: "short" | "long"; sortBy?: "relevance" | "date" | "view count" | "rating"; timecode?: boolean; seek?: number; index?: number; requestedBy?: User; localAddress?: string; } /** * Playlist options * @typedef {object} PlaylistOptions * @param {number} [maxSongs=-1] Max songs * @param {User} [requestedBy] The User who requested the Song * @param {boolean} [shuffle=false] If it should shuffle the Songs * @param {number} [index] If the index was provided, it will add all songs of the playlist after the provided index in the Queue * @param {string} [localAddress] Custom ipv4/ipv6 address */ export interface PlaylistOptions { maxSongs?: number; requestedBy?: User; shuffle?: boolean; index?: number; localAddress?: string; } /** * @typedef {object} ProgressBarOptions * @property {boolean} [time=true] If it should add time near the ProgressBar * @property {number} [size=20] Bar size * @property {string} [block==] Bar block * @property {string} [arrow=>] Bar ending */ export interface ProgressBarOptions { time?: boolean; size?: number; block?: string; arrow?: string; } /** * Default player options object * @typedef {PlayerOptions} * @param {boolean} [leaveOnEnd=true] If it should leave on end * @param {boolean} [leaveOnStop=true] If it should leave on stop * @param {boolean} [leaveOnEmpty=true] If it should leave on empty voice channel * @param {boolean} [deafenOnJoin=false] If it should deafen on join * @param {number} [timeout=0] Voice channel leave timeout * @param {number} [volume=100] Player volume * @param {string} [quality=high] Player quality */ export declare const DefaultPlayerOptions: PlayerOptions; /** * Default play options object * @typedef {PlayOptions} * @param {string} [sortBy=relevance] Search sort by Sort by * @param {boolean} [timecode=false] If url with timecode (?t=) provided, will play from that moment */ export declare const DefaultPlayOptions: PlayOptions; /** * Default playlist options object * @typedef {PlaylistOptions} * @param {number} [maxSongs=-1] Max songs * @param {boolean} [shuffle=false] If it should shuffle the Songs */ export declare const DefaultPlaylistOptions: PlaylistOptions; /** * Default progress bar options object * @typedef {ProgressBarOptions} * @param {boolean} [time=true] If it should add time near the ProgressBar * @param {number} [size=20] Bar size * @param {string} [block==] Bar block * @param {string} [arrow=>] Bar ending */ export declare const DefaultProgressBarOptions: ProgressBarOptions; /** * Raw Song object * @typedef {object} RawSong * @property {string} name * @property {string} author * @property {string} url * @property {string} thumbnail * @property {string} duration * @property {boolean} isLive */ export interface RawSong { name: string; author: string; url: string; thumbnail: string; duration: string; isLive: boolean; seekTime?: number; data?: any; } /** * Raw Playlist object * @typedef {object} PlayerOptions * @property {string} name * @property {string} author * @property {string} url * @property {Song[]} songs * @property {string} type */ export interface RawPlaylist { name: string; author: string; url: string; songs: Song[]; type: "playlist" | "album"; } /** * The queue repeat mode. * Following modes exists: * - `OFF` = 0 * - `SONG` = 1 * - `QUEUE` = 2 * @typedef {number} RepeatMode */ export declare enum RepeatMode { DISABLED = 0, SONG = 1, QUEUE = 2 } /** * Emitted when channel was empty * @event Player#channelEmpty * @param {Queue} queue Queue */ /** * Emitted when a song was added to the queue * @event Player#songAdd * @param {Queue} queue Queue * @param {Song} song Song */ /** * Emitted when a playlist was added to the queue * @event Player#playlistAdd * @param {Queue} queue Queue * @param {Playlist} playlist Playlist */ /** * Emitted when there was no more music to play * @event Player#queueEnd * @param {Queue} queue Queue */ /** * Emitted when the queue was destroyed * @event Player#queueDestroyed * @param {Queue} queue Queue */ /** * Emitted when a song changed * @event Player#songChanged * @param {Queue} queue Queue * @param {Song} newSong Song * @param {Song} oldSong Song */ /** * Emitted when a first song in the queue started playing * @event Player#songFirst * @param {Queue} queue Queue * @param {Song} song Song */ /** * Emitted when someone disconnected the bot from the channel * @event Player#clientDisconnect * @param {Queue} queue Queue */ /** * Emitted when deafenOnJoin is true and the bot was undeafened * @event Player#clientUndeafen * @param {Queue} queue Queue */ /** * Emitted when there was an error with the Player * @event Player#error * @param {string} error Error string * @param {Queue} queue Queue */ export interface PlayerEvents { channelEmpty: [queue: Queue]; songAdd: [queue: Queue, song: Song]; playlistAdd: [queue: Queue, playlist: Playlist]; queueEnd: [queue: Queue]; queueDestroyed: [queue: Queue]; songChanged: [queue: Queue, newSong: Song, oldSong: Song]; songFirst: [queue: Queue, song: Song]; clientDisconnect: [queue: Queue]; clientUndeafen: [queue: Queue]; error: [error: string, queue: Queue]; } /** * Emitted when StreamConnection started * @event StreamConnection#start * @param {AudioResource<Song>} AudioResource AudioResource */ /** * Emitted when StreamConnection ended * @event StreamConnection#end * @param {AudioResource<Song>} AudioResource AudioResource */ /** * Emitted when there was an error with the StreamConnection * @event StreamConnection#error * @param {AudioPlayerError} error AudioPlayerError */ export interface StreamConnectionEvents { start: [AudioResource<Song>]; end: [AudioResource<Song>]; error: [AudioPlayerError]; } export interface RawApplePlaylist { name: string; type: "playlist" | "album"; author: string; tracks: { artist: string; title: string; }[]; }