Sampler#
- class pyflp.channel.Sampler[source]#
Represents the native Sampler, either as a clip or a channel.
- property envelopes: dict[Literal['Panning', 'Volume', 'Mod X', 'Mod Y', 'Pitch'], pyflp.channel.Envelope] | None#
An
Envelope
each for Volume, Panning, Mod X, Mod Y and Pitch.Envelope / instruement settings
- property lfos: dict[Literal['Panning', 'Volume', 'Mod X', 'Mod Y', 'Pitch'], pyflp.channel.SamplerLFO] | None#
An
LFO
each for Volume, Panning, Mod X, Mod Y and Pitch.Envelope / instruement settings (page)
- property pitch_shift: int | None#
-4800 to +4800 (cents).
- Raises:
PropertyCannotBeSet β When a
ChannelID.Levels
event is not found.
- property sample_path: pathlib.Path | None#
Absolute path of a sample file on the disk.
Sample settings (page) β£ File
Contains the string
%FLStudioFactoryData%
for stock samples.
- stretching: TimeStretching#
Sample settings (page) β£ Time stretching
- class pyflp.channel.Content[source]#
Used by
Sampler
.- declick_mode: pyflp.channel.DeclickMode | None#
-
Defaults to
DeclickMode.OutOnly
.
- class pyflp.channel.Envelope[source]#
-
A PAHDSR envelope for various
Sampler
paramters.See also
- amount: int | None#
Linear. Bipolar.
Type
Value
Representation
Min
-128
-100%
Max
128
100%
Default
0
0%
- attack_tension: int | None#
-
Linear. Bipolar.
Type
Value
Representation
Min
-128
-100%
Max
128
100%
Default
0
0%
- decay_tension: int | None#
-
Linear. Bipolar.
Type
Value
Mix (wet)
Min
-128
-100%
Max
128
100%
Default
0
0%
- predelay: int | None#
Linear. Defaults to minimum value.
Type
Value
Representation
Min
100
0%
Max
65536
100%
- class pyflp.channel.FX[source]#
Pre-computed effects used by
Sampler
.See also
- crossfade: int | None#
Linear. Defaults to minimum value
Type
Value
Representation
Min
0
0%
Max
256
100%
- length: float | None#
Min = 0.0, Max = 1.0. Defaults to minimum value.
Named SMP START in FLβs interface.
- ringmod: Optional[Tuple[int, int]]#
Ring modulation returned as a tuple of
(mix, frequency)
.Limits for both:
Min
Max
Default
0
256
128
- class pyflp.channel.Playback[source]#
Used by
Sampler
.
- class pyflp.channel.Reverb[source]#
-
Precalculated reverb used by
Sampler
.- property type: pyflp.channel.ReverbType | None#
- class pyflp.channel.SamplerLFO[source]#
-
A basic LFO for certain
Sampler
parameters.See also
- amount: int | None#
Linear. Bipolar.
Type
Value
Representation
Min
-128
-100%
Max
128
100%
Default
0
0%
- predelay: int | None#
Linear. Defaults to minimum value.
Type
Value
Representation
Min
100
0%
Max
65536
100%
- shape: pyflp.channel.LFOShape | None#
Sine.
- Type:
Sine, triangle or pulse. Default
- class pyflp.channel.TimeStretching[source]#
-
Used by
Sampler
.- mode: pyflp.channel.StretchMode | None#
Properties obtained from a
construct.Struct
.
Enums#
- class pyflp.channel.DeclickMode[source]#
- Crossfade = 5#
- Generic = 3#
- OutOnly = 0#
- Smooth = 4#
- Transient = 2#
- TransientNoBleeding = 1#
- class pyflp.channel.ReverbType[source]#
Used by
Reverb.type
.- A = 0#
- B = 65536#