Interface PlayerFilters

interface PlayerFilters {
    channelMix?: ChannelMix;
    distortion?: Distortion;
    equalizer?: Equalizer[];
    karaoke?: Karaoke;
    lowPass?: LowPass;
    pluginFilters?: Record<string, any>;
    rotation?: Rotation;
    timescale?: Timescale;
    tremolo?: Tremolo;
    vibrato?: Vibrato;
    volume?: number;
}

Properties

channelMix? distortion? equalizer? karaoke? lowPass? pluginFilters? rotation? timescale? tremolo? vibrato? volume?

Properties

OptionalchannelMix

channelMix?: ChannelMix

Mixes both channels (left and right)

Optionaldistortion

distortion?: Distortion

Distorts the audio

Optionalequalizer

equalizer?: Equalizer[]

Adjusts 15 different bands

Optionalkaraoke

karaoke?: Karaoke

Eliminates part of a band, usually targeting vocals

OptionallowPass

lowPass?: LowPass

Filters higher frequencies

OptionalpluginFilters

pluginFilters?: Record<string, any>

Filter plugin configurations

Plugins can add their own filters. The key is the name of the plugin, and the value is the configuration for that plugin. The configuration is plugin specific. See Plugins for more plugin information.

Optionalrotation

rotation?: Rotation

Rotates the audio around the stereo channels/user headphones (aka Audio Panning)

Optionaltimescale

timescale?: Timescale

Changes the speed, pitch, and rate

Optionaltremolo

tremolo?: Tremolo

Creates a shuddering effect, where the volume quickly oscillates

Optionalvibrato

vibrato?: Vibrato

Creates a shuddering effect, where the pitch quickly oscillates

Optionalvolume

volume?: number

Adjusts the player volume from 0.0 to 5.0, where 1.0 is 100%. Values >1.0 may cause clipping

Settings

Member Visibility

On This Page

Properties