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;
        relocateQueues?: boolean;
        forwardVoiceUpdate: (
            guildId: string,
            payload: VoiceUpdatePayload,
        ) => Promise<void>;
        fetchRelatedTracks?: (
            queue: Queue,
            track: Track,
        ) => Promise<Track<CommonUserData, CommonPluginInfo>[]>;
    }

    Type Parameters

    Index

    Properties

    nodes plugins? autoInit? autoSync? queryPrefix? relocateQueues? forwardVoiceUpdate fetchRelatedTracks?

    Properties

    nodes: CreateNodeOptions[]

    Options for creating node(s)

    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"
    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

    Settings

    Member Visibility

    On This Page

    Properties