Interface KazagumoOptions

interface KazagumoOptions {
    defaultSearchEngine: string;
    defaultSource?: string;
    defaultYoutubeThumbnail?: YoutubeThumbnail;
    extends?: {
        player?: Constructor<KazagumoPlayer>;
    };
    plugins?: KazagumoPlugin[];
    send: ((guildId, payload) => void);
    sourceForceResolve?: string[];
    trackResolver?: ((this, options?) => Promise<boolean>);
}

Properties

defaultSearchEngine defaultSource? defaultYoutubeThumbnail? extends? plugins? send sourceForceResolve? trackResolver?

Properties

defaultSearchEngine

defaultSearchEngine: string

Default search engine if no engine was provided. Default to youtube. If defaultSource is provided, this will be ignored

Optional defaultSource

defaultSource?: string

Default source if no source was provided. Default to defaultSearchEngine

Optional defaultYoutubeThumbnail

defaultYoutubeThumbnail?: YoutubeThumbnail

The default youtube thumbnail's size

Optional extends

extends?: {
    player?: Constructor<KazagumoPlayer>;
}

Extend some of the Structures

Type declaration

Optional plugins

plugins?: KazagumoPlugin[]

Kazagumo plugins

send

send: ((guildId, payload) => void)

Type declaration

    • (guildId, payload): void

    • Send to guild's shard

      Parameters

      Returns void

Optional sourceForceResolve

sourceForceResolve?: string[]

Source that will be forced to resolve when playing it

Optional trackResolver

trackResolver?: ((this, options?) => Promise<boolean>)

Type declaration

    • (this, options?): Promise<boolean>

    • The track resolver. Make sure you set .track for it to work. (I'm not responsible for any error during playback if you don't set it right)

      Parameters

      Returns Promise<boolean>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc