Discolink
    Preparing search index...

    Interface PlayerOptions<Plugins>

    Options for creating a Player

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

    Type Parameters

    Index

    Properties

    nodes plugins? queryPrefix? relocateQueues? forwardVoiceUpdate fetchRelatedTracks?

    Properties

    nodes: CreateNodeOptions[]

    Options for creating node(s)

    plugins?: Plugins

    Plugins to initialize after creating nodes

    queryPrefix?: string

    Default prefix to use for search queries (not URLs). Default: ytsearch

    relocateQueues?: boolean

    Whether to relocate queues across nodes on disruption. Default: 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<EmptyObject, EmptyObject>[]>

    Return empty or populated array of related tracks

    Type Declaration

    Settings

    Member Visibility

    On This Page

    Properties