Documentation
Classes
@discord-player
extractor
SpotifyExtractor

SpotifyExtractor extends BaseExtractor

new SpotifyExtractor(context)
ParameterTypeOptionalDescription
contextExtractorExecutionContextContext that instantiated this extractor

Properties

private _lib: Spotify

private _stream: StreamFN

public context: ExtractorExecutionContext

  • Source: packages/discord-player/dist/index.d.ts#L83

public static identifier: 'com.discord-player.spotifyextractor'

public identifier: string

Identifier of this extractor

Methods

public activate(): Promise<void>

public createResponse(playlist?, tracks?): ExtractorInfo

Create extractor response

ParameterTypeOptionalDescription
playlistnull | PlaylistThe playlist
tracksArray<Track>The track array
  • Source: packages/discord-player/dist/index.d.ts#L137

public deactivate(): Promise<void>

This method will be executed when this extractor is deactivated

  • Source: packages/discord-player/dist/index.d.ts#L104

public debug(message): boolean

Write debug message

ParameterTypeOptionalDescription
messagestringThe debug message
  • Source: packages/discord-player/dist/index.d.ts#L142

public emit(event, args): boolean

Dispatch an event to the player

ParameterTypeOptionalDescription
eventKThe event to dispatch
argsParameters<PlayerEvents[K]>The data to dispatch
  • Source: packages/discord-player/dist/index.d.ts#L131

public handle(query, context): Promise<ExtractorInfo>

ParameterTypeOptionalDescription
querystring-
contextExtractorSearchContext-

public handlePostStream(stream, next): void

A stream middleware to handle streams before passing it to the player

ParameterTypeOptionalDescription
streamReadableThe incoming stream
nextNextFunctionThe next function
  • Source: packages/discord-player/dist/index.d.ts#L125

public stream(info): Promise<string | Readable>

ParameterTypeOptionalDescription
infoTrack-

public validate(query, type?): Promise<boolean>

ParameterTypeOptionalDescription
querystring-
typenull | SearchQueryType-