🪛 fx

fx

The fx module provides a set of audio effects that can be applied to tracks in the soir engine. Each track can have a set of effects with corresponding parameters, which are typically defined using the tracks.setup() function.

Cookbook

Setup tracks with effects

tracks.setup({
    'bass': tracks.mk_sampler(fxs={
        'rev': fx.mk_chorus(),
    }),
})

Fx(name='unnamed', type='unknown', mix=None, extra=None) dataclass

Representation of a Soir FX.

Attributes:

Name	Type	Description
name	str	The name of the effect.
type	str	The effect type.
mix	float | None	The mix parameter of the effect. Defaults to None.
extra	str | None	Extra parameters for the effect, JSON encoded. Defaults to None.

mk(type, mix=None, extra=None)

Creates a new Fx.

Parameters:

Name	Type	Description	Default
type	str	The effect type.	required
mix	float	The mix parameter of the effect. Defaults to None.	None
extra	dict	The extra parameters of the effect. Default to None.	None

mk_chorus(mix=None)

Creates a new Chorus FX.

Parameters:

Name	Type	Description	Default
mix		The mix parameter of the chorus effect. Defaults to None.	None

mk_reverb(mix=None)

Creates a new Reverb FX.

Parameters:

Name	Type	Description	Default
mix		The mix parameter of the chorus effect. Defaults to None.	None