for-modules 1.0.0

package/dist/Structures/Player.d.ts

@@ -0,0 +1,250 @@
+import { Filters } from "./Filters";
+import { Manager, SearchQuery, SearchResult } from "./Manager";
+import { Node } from "./Node";
+import { Queue } from "./Queue";
+import { Sizes, State, TrackSourceName, VoiceState } from "./Utils";
+import { ClientUser, Message, User } from "discord.js";
+export declare class Player {
+    options: PlayerOptions;
+    /** The Queue for the Player. */
+    readonly queue: Queue;
+    /** The filters applied to the audio. */
+    filters: Filters;
+    /** Whether the queue repeats the track. */
+    trackRepeat: boolean;
+    /** Whether the queue repeats the queue. */
+    queueRepeat: boolean;
+    /**Whether the queue repeats and shuffles after each song. */
+    dynamicRepeat: boolean;
+    /** The time the player is in the track. */
+    position: number;
+    /** Whether the player is playing. */
+    playing: boolean;
+    /** Whether the player is paused. */
+    paused: boolean;
+    /** The volume for the player */
+    volume: number;
+    /** The Node for the Player. */
+    node: Node;
+    /** The guild for the player. */
+    guild: string;
+    /** The voice channel for the player. */
+    voiceChannel: string | null;
+    /** The text channel for the player. */
+    textChannel: string | null;
+    /**The now playing message. */
+    nowPlayingMessage?: Message;
+    /** The current state of the player. */
+    state: State;
+    /** The equalizer bands array. */
+    bands: number[];
+    /** The voice state object from Discord. */
+    voiceState: VoiceState;
+    /** The Manager. */
+    manager: Manager;
+    /** The autoplay state of the player. */
+    isAutoplay: boolean;
+    private static _manager;
+    private readonly data;
+    private dynamicLoopInterval;
+    /**
+     * Set custom data.
+     * @param key
+     * @param value
+     */
+    set(key: string, value: unknown): void;
+    /**
+     * Get custom data.
+     * @param key
+     */
+    get<T>(key: string): T;
+    /** @hidden */
+    static init(manager: Manager): void;
+    /**
+     * Creates a new player, returns one if it already exists.
+     * @param options
+     */
+    constructor(options: PlayerOptions);
+    /**
+     * Same as Manager#search() but a shortcut on the player itself.
+     * @param query
+     * @param requester
+     */
+    search(query: string | SearchQuery, requester?: User | ClientUser): Promise<SearchResult>;
+    /** Connect to the voice channel. */
+    connect(): this;
+    /**
+     * Moves the player to a different node.
+     *
+     * @param {string} [node] - The ID of the node to move to.
+     * @returns {this} - The player instance.
+     */
+    moveNode(node?: string): Promise<this>;
+    /** Disconnect from the voice channel. */
+    disconnect(): this;
+    /** Destroys the player. */
+    destroy(disconnect?: boolean): void;
+    /**
+     * Sets the player voice channel.
+     * @param channel
+     */
+    setVoiceChannel(channel: string): this;
+    /**
+     * Sets the player text channel.
+     * @param channel
+     */
+    setTextChannel(channel: string): this;
+    /** Sets the now playing message. */
+    setNowPlayingMessage(message: Message): Message;
+    /** Plays the next track. */
+    play(): Promise<void>;
+    /**
+     * Plays the specified track.
+     * @param track
+     */
+    play(track: Track | UnresolvedTrack): Promise<void>;
+    /**
+     * Plays the next track with some options.
+     * @param options
+     */
+    play(options: PlayOptions): Promise<void>;
+    /**
+     * Plays the specified track with some options.
+     * @param track
+     * @param options
+     */
+    play(track: Track | UnresolvedTrack, options: PlayOptions): Promise<void>;
+    /**
+     * Sets the autoplay-state of the player.
+     * @param autoplayState
+     * @param botUser
+     */
+    setAutoplay(autoplayState: boolean, botUser: object): this;
+    /**
+     * Gets recommended tracks and returns an array of tracks.
+     * @param track
+     * @param requester
+     */
+    getRecommended(track: Track, requester?: User | ClientUser): Promise<Track[]>;
+    /**
+     * Sets the player volume.
+     * @param volume
+     */
+    setVolume(volume: number): this;
+    /**
+     * Sets the track repeat.
+     * @param repeat
+     */
+    setTrackRepeat(repeat: boolean): this;
+    /**
+     * Sets the queue repeat.
+     * @param repeat
+     */
+    setQueueRepeat(repeat: boolean): this;
+    /**
+     * Sets the queue to repeat and shuffles the queue after each song.
+     * @param repeat "true" or "false".
+     * @param ms After how many milliseconds to trigger dynamic repeat.
+     */
+    setDynamicRepeat(repeat: boolean, ms: number): this;
+    /** Restarts the current track to the start. */
+    restart(): void;
+    /** Stops the current track, optionally give an amount to skip to, e.g 5 would play the 5th song. */
+    stop(amount?: number): this;
+    /**
+     * Pauses the current track.
+     * @param pause
+     */
+    pause(pause: boolean): this;
+    /** Go back to the previous song. */
+    previous(): this;
+    /**
+     * Seeks to the position in the current track.
+     * @param position
+     */
+    seek(position: number): this;
+}
+export interface PlayerOptions {
+    /** The guild the Player belongs to. */
+    guild: string;
+    /** The text channel the Player belongs to. */
+    textChannel: string;
+    /** The voice channel the Player belongs to. */
+    voiceChannel?: string;
+    /** The node the Player uses. */
+    node?: string;
+    /** The initial volume the Player will use. */
+    volume?: number;
+    /** If the player should mute itself. */
+    selfMute?: boolean;
+    /** If the player should deaf itself. */
+    selfDeafen?: boolean;
+}
+/** If track partials are set some of these will be `undefined` as they were removed. */
+export interface Track {
+    /** The base64 encoded track. */
+    readonly track: string;
+    /** The artwork url of the track. */
+    readonly artworkUrl: string;
+    /** The track source name. */
+    readonly sourceName: TrackSourceName;
+    /** The title of the track. */
+    title: string;
+    /** The identifier of the track. */
+    readonly identifier: string;
+    /** The author of the track. */
+    author: string;
+    /** The duration of the track. */
+    readonly duration: number;
+    /** The ISRC of the track. */
+    readonly isrc: string;
+    /** If the track is seekable. */
+    readonly isSeekable: boolean;
+    /** If the track is a stream.. */
+    readonly isStream: boolean;
+    /** The uri of the track. */
+    readonly uri: string;
+    /** The thumbnail of the track or null if it's a unsupported source. */
+    readonly thumbnail: string | null;
+    /** The user that requested the track. */
+    readonly requester: User | ClientUser | null;
+    /** Displays the track thumbnail with optional size or null if it's a unsupported source. */
+    displayThumbnail(size?: Sizes): string;
+    /** Additional track info provided by plugins. */
+    pluginInfo: TrackPluginInfo;
+    /** Add your own data to the track. */
+    customData: Record<string, unknown>;
+}
+export interface TrackPluginInfo {
+    albumName?: string;
+    albumUrl?: string;
+    artistArtworkUrl?: string;
+    artistUrl?: string;
+    isPreview?: string;
+    previewUrl?: string;
+}
+/** Unresolved tracks can't be played normally, they will resolve before playing into a Track. */
+export interface UnresolvedTrack extends Partial<Track> {
+    /** The title to search against. */
+    title: string;
+    /** The author to search against. */
+    author?: string;
+    /** The duration to search within 1500 milliseconds of the results from YouTube. */
+    duration?: number;
+    /** Resolves into a Track. */
+    resolve(): Promise<void>;
+}
+export interface PlayOptions {
+    /** The position to start the track. */
+    readonly startTime?: number;
+    /** The position to end the track. */
+    readonly endTime?: number;
+    /** Whether to not replace the track if a play payload is sent. */
+    readonly noReplace?: boolean;
+}
+export interface EqualizerBand {
+    /** The band number being 0 to 14. */
+    band: number;
+    /** The gain amount being -0.25 to 1.00, 0.25 being double. */
+    gain: number;
+}