Discord Player

FFmpegFilterer

No description provided

FFmpegFilterer

new FFmpegFilterer(af);
ParameterTypeOptional
afGuildQueueAudioFilters<Meta>

Properties

public af: any

public args: any

Get final ffmpeg args

public encoderArgs: any

Get encoder args

public filters: any

Currently active ffmpeg filters

public inputArgs: any

Get input args

public skippable: any

Indicates whether ffmpeg may be skipped

Methods

public createStream(source, options): Duplex | Readable

Create ffmpeg stream

ParameterTypeOptionalDescription
sourcestring | ReadableThe stream source
optionsFFmpegStreamOptionsThe stream options

public getFiltersDisabled(): Array<keyof |QueueFilters>

Get list of disabled filters

public getFiltersEnabled(): Array<keyof |QueueFilters>

Get list of enabled filters

public isDisabled(filter): boolean

Check if the given filter is disabled

ParameterTypeOptionalDescription
filterTThe filter

public isEnabled(filter): boolean

Check if the given filter is enabled

ParameterTypeOptionalDescription
filterTThe filter

public isValidFilter(filter): is | keyof |QueueFilters

Check if the given filter is a valid filter

ParameterTypeOptionalDescription
filterstringThe filter to test

public setDefaults(ff): void

Set default filters

ParameterTypeOptionalDescription
ffArray<keyof | QueueFilters>Filters list

public setFilters(filters): Promise<boolean>

Set ffmpeg filters

ParameterTypeOptionalDescription
filtersboolean | Array<string>Array<keyof QueueFilters>Record<keyof QueueFilters | boolean>The filters

public setInputArgs(args): void

Set input args for FFmpeg

ParameterTypeOptional
argsArray<string>

public toArray(): Array<string>

Convert current filters to array

public toJSON(): Record<keyof |QueueFilters | string>

Convert current filters to JSON object

public toString(): string

String representation of current filters

public toggle(filters): Promise<boolean>

Toggle given ffmpeg filter(s)

ParameterTypeOptionalDescription
filterskeyof QueueFilters | Array<keyof QueueFilters>The filter(s)