pylav.players.filters package#

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)[source]#

Bases: FilterMixin

classmethod default()[source]#

classmethod from_dict(data)[source]#

get()[source]#

property left_to_left#

property left_to_right#

reset()[source]#

property right_to_left#

property right_to_right#

to_dict()[source]#: 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)[source]#

Bases: FilterMixin

property cos_offset#

property cos_scale#

classmethod default()[source]#

classmethod from_dict(data)[source]#

get()[source]#

property offset#

reset()[source]#

property scale#

property sin_offset#

property sin_scale#

property tan_offset#

property tan_scale#

to_dict()[source]#: Returns a dictionary representation of the Filter

pylav.players.filters.equalizer module#

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

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)[source]#: Overrides the default implementation

classmethod build(*, levels, name='CustomEqualizer')[source]#

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()[source]#

classmethod flat()[source]#: Flat Equalizer. Resets your EQ to Flat.

classmethod from_dict(data)[source]#: Creates an Equalizer from a dictionary

get()[source]#

get_gain(band)[source]#

property index#

property name#: The Equalizers friendly name

reset()[source]#

set_gain(band, gain)[source]#

to_dict()[source]#: Returns a dictionary representation of the Equalizer

visualise()[source]#

pylav.players.filters.karaoke module#

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

Bases: FilterMixin

classmethod default()[source]#

property filter_band#

property filter_width#

classmethod from_dict(data)[source]#

get()[source]#

property level#

property mono_level#

reset()[source]#

to_dict()[source]#: Returns a dictionary representation of the Filter

pylav.players.filters.low_pass module#

class pylav.players.filters.low_pass.LowPass(smoothing=None)[source]#

Bases: FilterMixin

classmethod default()[source]#

classmethod from_dict(data)[source]#

get()[source]#

reset()[source]#

property smoothing#

to_dict()[source]#: Returns a dictionary representation of the Filter

pylav.players.filters.misc module#

class pylav.players.filters.misc.FilterMixin[source]#

Bases: object

__eq__(other)[source]#: Overrides the default implementation

__hash__()[source]#: Overrides the default implementation

property changed#

classmethod default()[source]#

property off#

abstract to_dict()[source]#: Returns a dictionary representation of the Filter

pylav.players.filters.rotation module#

class pylav.players.filters.rotation.Rotation(hertz=None)[source]#

Bases: FilterMixin

classmethod default()[source]#

classmethod from_dict(data)[source]#

get()[source]#

property hertz#

reset()[source]#

to_dict()[source]#: Returns a dictionary representation of the Filter

pylav.players.filters.timescale module#

class pylav.players.filters.timescale.Timescale(speed=None, pitch=None, rate=None)[source]#

Bases: FilterMixin

adjust_position(position)[source]#

classmethod default()[source]#

classmethod from_dict(data)[source]#

get()[source]#

property pitch#

property rate#

reset()[source]#

reverse_position(position)[source]#

property speed#

to_dict()[source]#: Returns a dictionary representation of the Filter

pylav.players.filters.tremolo module#

class pylav.players.filters.tremolo.Tremolo(frequency=None, depth=None)[source]#

Bases: FilterMixin

classmethod default()[source]#

property depth#

property frequency#

classmethod from_dict(data)[source]#

get()[source]#

reset()[source]#

to_dict()[source]#: Returns a dictionary representation of the Filter

pylav.players.filters.vibrato module#

class pylav.players.filters.vibrato.Vibrato(frequency=None, depth=None)[source]#

Bases: FilterMixin

classmethod default()[source]#

property depth#

property frequency#

classmethod from_dict(data)[source]#

get()[source]#

reset()[source]#

to_dict()[source]#: Returns a dictionary representation of the Filter

pylav.players.filters.volume module#

class pylav.players.filters.volume.Volume(value)[source]#

Bases: FilterMixin

decrease(by=0.05)[source]#

classmethod default()[source]#

classmethod from_dict(data)[source]#

get()[source]#

get_int_value()[source]#

increase(by=0.05)[source]#

reset()[source]#

to_dict()[source]#: 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)[source]#

Bases: FilterMixin

classmethod default()[source]#

classmethod from_dict(data)[source]#

get()[source]#

property left_to_left#

property left_to_right#

reset()[source]#

property right_to_left#

property right_to_right#

to_dict()[source]#: 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)[source]#

Bases: FilterMixin

property cos_offset#

property cos_scale#

classmethod default()[source]#

classmethod from_dict(data)[source]#

get()[source]#

property offset#

reset()[source]#

property scale#

property sin_offset#

property sin_scale#

property tan_offset#

property tan_scale#

to_dict()[source]#: Returns a dictionary representation of the Filter

class pylav.players.filters.Echo(delay=None, decay=None)[source]#

Bases: FilterMixin

property decay#

classmethod default()[source]#

property delay#

classmethod from_dict(data)[source]#

get()[source]#

reset()[source]#

to_dict()[source]#: Returns a dictionary representation of the Filter

class pylav.players.filters.Equalizer(*, levels, name='CustomEqualizer')[source]#

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)[source]#: Overrides the default implementation

classmethod build(*, levels, name='CustomEqualizer')[source]#

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’