pylav.players.filters package

Subpackages

• pylav.players.filters.plugins package
  • Submodules
  • pylav.players.filters.plugins.echo module
    • Echo
      • Echo.decay
      • Echo.default()
      • Echo.delay
      • Echo.from_dict()
      • Echo.get()
      • Echo.reset()
      • Echo.to_dict()
  • Module contents
    • Echo
      • Echo.decay
      • Echo.default()
      • Echo.delay
      • Echo.from_dict()
      • Echo.get()
      • Echo.reset()
      • Echo.to_dict()
    • Reverb
      • Reverb.default()
      • Reverb.delays
      • Reverb.from_dict()
      • Reverb.gains
      • Reverb.get()
      • Reverb.reset()
      • Reverb.to_dict()

Submodules

pylav.players.filters.channel_mix module

class pylav.players.filters.channel_mix.ChannelMix(left_to_left=None, left_to_right=None, right_to_left=None, right_to_right=None)

Bases: FilterMixin

classmethod default()

classmethod from_dict(data)

get()

property left_to_left

property left_to_right

reset()

property right_to_left

property right_to_right

to_dict()

Returns a dictionary representation of the Filter

pylav.players.filters.distortion module

class pylav.players.filters.distortion.Distortion(sin_offset=None, sin_scale=None, cos_offset=None, cos_scale=None, tan_offset=None, tan_scale=None, offset=None, scale=None)

Bases: FilterMixin

property cos_offset

property cos_scale

classmethod default()

classmethod from_dict(data)

get()

property offset

reset()

property scale

property sin_offset

property sin_scale

property tan_offset

property tan_scale

to_dict()

Returns a dictionary representation of the Filter

pylav.players.filters.equalizer module

class pylav.players.filters.equalizer.Equalizer(*, levels, name='CustomEqualizer')

Bases: FilterMixin

Class representing a usable equalizer.

Parameters:

• levels (List[Tuple[int, float]]) – A list of tuple pairs containing a band int and gain float.

• name (str) – An Optional string to name this Equalizer. Defaults to ‘CustomEqualizer’

__eq__(other)

Overrides the default implementation

classmethod build(*, levels, name='CustomEqualizer')

Build a custom Equalizer class with the provided levels.

Parameters:

• levels (list[dict[str, int | float]]) – A list of dictionaries containing the band and gain for each band.

• name (str) – An Optional string to name this Equalizer. Defaults to ‘CustomEqualizer’

classmethod default()

classmethod flat()

Flat Equalizer. Resets your EQ to Flat.

classmethod from_dict(data)

Creates an Equalizer from a dictionary

get()

get_gain(band)

property index

property name

The Equalizers friendly name

reset()

set_gain(band, gain)

to_dict()

Returns a dictionary representation of the Equalizer

visualise()

pylav.players.filters.karaoke module

class pylav.players.filters.karaoke.Karaoke(level=None, mono_level=None, filter_band=None, filter_width=None)

Bases: FilterMixin

classmethod default()

property filter_band

property filter_width

classmethod from_dict(data)

get()

property level

property mono_level

reset()

to_dict()

Returns a dictionary representation of the Filter

pylav.players.filters.low_pass module

class pylav.players.filters.low_pass.LowPass(smoothing=None)

Bases: FilterMixin

classmethod default()

classmethod from_dict(data)

get()

reset()

property smoothing

to_dict()

Returns a dictionary representation of the Filter

pylav.players.filters.misc module

class pylav.players.filters.misc.FilterMixin

Bases: object

__eq__(other)

Overrides the default implementation

__hash__()

Overrides the default implementation

property changed

classmethod default()

property off

abstract to_dict()

Returns a dictionary representation of the Filter

pylav.players.filters.rotation module

class pylav.players.filters.rotation.Rotation(hertz=None)

Bases: FilterMixin

classmethod default()

classmethod from_dict(data)

get()

property hertz

reset()

to_dict()

Returns a dictionary representation of the Filter

pylav.players.filters.timescale module

class pylav.players.filters.timescale.Timescale(speed=None, pitch=None, rate=None)

Bases: FilterMixin

adjust_position(position)

classmethod default()

classmethod from_dict(data)

get()

property pitch

property rate

reset()

reverse_position(position)

property speed

to_dict()

Returns a dictionary representation of the Filter

pylav.players.filters.tremolo module

class pylav.players.filters.tremolo.Tremolo(frequency=None, depth=None)

Bases: FilterMixin

classmethod default()

property depth

property frequency

classmethod from_dict(data)

get()

reset()

to_dict()

Returns a dictionary representation of the Filter

pylav.players.filters.vibrato module

class pylav.players.filters.vibrato.Vibrato(frequency=None, depth=None)

Bases: FilterMixin

classmethod default()

property depth

property frequency

classmethod from_dict(data)

get()

reset()

to_dict()

Returns a dictionary representation of the Filter

pylav.players.filters.volume module

class pylav.players.filters.volume.Volume(value)

Bases: FilterMixin

decrease(by=0.05)

classmethod default()

classmethod from_dict(data)

get()

get_int_value()

increase(by=0.05)

reset()

to_dict()

Returns a dictionary representation of the Filter

property value

Module contents

class pylav.players.filters.ChannelMix(left_to_left=None, left_to_right=None, right_to_left=None, right_to_right=None)

Bases: FilterMixin

classmethod default()

classmethod from_dict(data)

get()

property left_to_left

property left_to_right

reset()

property right_to_left

property right_to_right

to_dict()

Returns a dictionary representation of the Filter

class pylav.players.filters.Distortion(sin_offset=None, sin_scale=None, cos_offset=None, cos_scale=None, tan_offset=None, tan_scale=None, offset=None, scale=None)

Bases: FilterMixin

property cos_offset

property cos_scale

classmethod default()

classmethod from_dict(data)

get()

property offset

reset()

property scale

property sin_offset

property sin_scale

property tan_offset

property tan_scale

to_dict()

Returns a dictionary representation of the Filter

class pylav.players.filters.Echo(delay=None, decay=None)

Bases: FilterMixin

property decay

classmethod default()

property delay

classmethod from_dict(data)

get()

reset()

to_dict()

Returns a dictionary representation of the Filter

class pylav.players.filters.Equalizer(*, levels, name='CustomEqualizer')

Bases: FilterMixin

Class representing a usable equalizer.

Parameters:

• levels (List[Tuple[int, float]]) – A list of tuple pairs containing a band int and gain float.

• name (str) – An Optional string to name this Equalizer. Defaults to ‘CustomEqualizer’

__eq__(other)

Overrides the default implementation

classmethod build(*, levels, name='CustomEqualizer')

Build a custom Equalizer class with the provided levels.

Parameters:

• levels (list[dict[str, int | float]]) – A list of dictionaries containing the band and gain for each band.

• name (str) – An Optional string to name this Equalizer. Defaults to ‘CustomEqualizer’

classmethod default()

classmethod flat()

Flat Equalizer. Resets your EQ to Flat.

classmethod from_dict(data)

Creates an Equalizer from a dictionary

get()

get_gain(band)

property index

property name

The Equalizers friendly name

reset()

set_gain(band, gain)

to_dict()

Returns a dictionary representation of the Equalizer

visualise()

class pylav.players.filters.Karaoke(level=None, mono_level=None, filter_band=None, filter_width=None)

Bases: FilterMixin

classmethod default()

property filter_band

property filter_width

classmethod from_dict(data)

get()

property level

property mono_level

reset()

to_dict()

Returns a dictionary representation of the Filter

class pylav.players.filters.LowPass(smoothing=None)

Bases: FilterMixin

classmethod default()

classmethod from_dict(data)

get()

reset()

property smoothing

to_dict()

Returns a dictionary representation of the Filter

class pylav.players.filters.Reverb(delays=None, gains=None)

Bases: FilterMixin

classmethod default()

property delays

classmethod from_dict(data)

property gains

get()

reset()

to_dict()

Returns a dictionary representation of the Filter

class pylav.players.filters.Rotation(hertz=None)

Bases: FilterMixin

classmethod default()

classmethod from_dict(data)

get()

property hertz

reset()

to_dict()

Returns a dictionary representation of the Filter

class pylav.players.filters.Timescale(speed=None, pitch=None, rate=None)

Bases: FilterMixin

adjust_position(position)

classmethod default()

classmethod from_dict(data)

get()

property pitch

property rate

reset()

reverse_position(position)

property speed

to_dict()

Returns a dictionary representation of the Filter

class pylav.players.filters.Tremolo(frequency=None, depth=None)

Bases: FilterMixin

classmethod default()

property depth

property frequency

classmethod from_dict(data)

get()

reset()

to_dict()

Returns a dictionary representation of the Filter

class pylav.players.filters.Vibrato(frequency=None, depth=None)

Bases: FilterMixin

classmethod default()

property depth

property frequency

classmethod from_dict(data)

get()

reset()

to_dict()

Returns a dictionary representation of the Filter

class pylav.players.filters.Volume(value)

Bases: FilterMixin

decrease(by=0.05)

classmethod default()

classmethod from_dict(data)

get()

get_int_value()

increase(by=0.05)

reset()

to_dict()

Returns a dictionary representation of the Filter

property value