BaseExtractor

BaseExtractor

new BaseExtractor(context, options);

Properties

public context: any

Context that instantiated this extractor

• Source

public options: any

Initialization options for this extractor

• Source

public priority: any

Priority of this extractor. Higher value means higher priority (will be executed first).

• Source

public protocols: any

A list of query protocols that this extractor supports.

• Source

public static identifier: any

Identifier for this extractor

• Source

public identifier: any

Identifier of this extractor

• Source

public supportsDemux: any

A flag to indicate Demuxable stream support for opus/ogg/opus/webm/opus formats.

• Source

Methods

public activate(): Promise<void>

This method will be executed when this extractor is activated

• Source

public bridge(track, sourceExtractor): Promise<null | ExtractorStreamable>

Handle stream extraction for another extractor

• Source

public createBridgeQuery(track): string

Handle bridge query creation

• Source

public createResponse(playlist?, tracks): ExtractorInfo

Create extractor response

• Source

public deactivate(): Promise<void>

This method will be executed when this extractor is deactivated

• Source

public debug(message): boolean

Write debug message

• Source

public emit(event, args): boolean

Dispatch an event to the player

• Source

public getRelatedTracks(track, history): Promise<ExtractorInfo>

Get related tracks for the given track

• Source

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

Handle the given query

• Source

public handlePostStream(stream, next): void

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

• Source

public reconfigure(options): Promise<void>

Reconfigures this extractor

• Source

public stream(info): Promise<ExtractorStreamable>

Stream the given track

• Source

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

Validate incoming query

• Source