Interface DamonJsOptions

Hierarchy

  • DamonJsOptions

Properties

defaultSearchEngine defaultYoutubeThumbnail? exceptions extends? plugins? resolveError skipOnException? skipOnStuck? skipResolveError? sourceForceResolve? stuck trackResolver?

Properties

defaultSearchEngine

defaultSearchEngine: string

Default search engine if no engine was provided. Default to youtube

Optional defaultYoutubeThumbnail

defaultYoutubeThumbnail?: YoutubeThumbnail

The default youtube thumbnail's size

exceptions

exceptions: {
    max: number;
    time: number;
}

Exception config until skip stops

Type declaration

  • max: number
  • time: number

Optional extends

extends?: {
    player?: Utils_Constructor<DamonJsPlayer>;
}

Extend some of the Structures

Type declaration

Optional plugins

plugins?: DamonJsPlugin[]

DamonJs plugins

resolveError

resolveError: {
    max: number;
    time: number;
}

Type declaration

  • max: number
  • time: number

Optional skipOnException

skipOnException?: boolean

Skip the track on exception

Optional skipOnStuck

skipOnStuck?: boolean

Skip the track on stuck

Optional skipResolveError

skipResolveError?: boolean

Skip the track on stuck

Optional sourceForceResolve

sourceForceResolve?: string[]

Source that will be forced to resolve when playing it

stuck

stuck: {
    max: number;
    time: number;
}

Stuck config until skip stops

Type declaration

  • max: number
  • time: number

Optional trackResolver

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

Type declaration

    • (this: DamonJsTrack, options?: ResolveOptions): 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

Generated using TypeDoc