Discolink
    Preparing search index...

    Interface PlayerOptions<Plugins>

    Options for creating a Player

    interface PlayerOptions<Plugins extends PlayerPlugin[] = PlayerPlugin[]> {
        nodes?: CreateNodeOptions[];
        plugins?: Plugins;
        autoInit?: boolean;
        autoSync?: boolean;
        queryPrefix?: string;
        voiceTimeout?: number;
        voiceReconnect?: boolean;
        relocateQueues?: boolean;
        forwardVoiceUpdate: (
            guildId: string,
            payload: VoiceUpdatePayload,
        ) => Promise<void>;
        fetchRelatedTracks?: (
            queue: Queue,
            track: Track,
        ) => Promise<Track<CommonUserData, CommonPluginInfo>[]>;
    }

    Type Parameters

    Index
    nodes? plugins? autoInit? autoSync? queryPrefix? voiceTimeout? voiceReconnect? relocateQueues? forwardVoiceUpdate fetchRelatedTracks?
    nodes?: CreateNodeOptions[]

    Options for creating nodes on init

    plugins?: Plugins

    Plugins to initialize after creating nodes

    autoInit?: boolean

    Whether to initialize automatically upon receiving the bot's ready event.

    true
    autoSync?: boolean

    Whether to update players for nodes that couldn't resume.

    true
    queryPrefix?: string

    The prefix to use for search queries (not URLs) by default.

    "ytsearch"
    voiceTimeout?: number

    Timeout for voice updates from Discord in ms.

    10_000
    voiceReconnect?: boolean

    Whether to reconnect (=> rejoin) for these voice close codes:

    • 4004 - incorrect token
    • 4011 - server not found
    • 4006 - session invalid

    You might want to turn this off for handling edge cases like being dragged into a private voice channel, etc.

    true
    relocateQueues?: boolean

    Whether to relocate queues when a node closes/disconnects.

    true
    forwardVoiceUpdate: (
        guildId: string,
        payload: VoiceUpdatePayload,
    ) => Promise<void>

    Forward voice state updates to your bot's gateway connection

    Type Declaration

    fetchRelatedTracks?: (
        queue: Queue,
        track: Track,
    ) => Promise<Track<CommonUserData, CommonPluginInfo>[]>

    Return empty or populated array of related tracks

    Type Declaration

    DO NOT throw an error

    Settings
    Member Visibility

    On This Page
    Properties