Shared

These implement functionality used by Channel or its subclasses.

class pyflp.channel.Arp

Used by Sampler: and Instrument.

chord: int | None

Index of the selected arpeggio chord.

direction: ArpDirection | None

Properties obtained from a construct.Struct.

gate: float | None

Delay between two successive notes played.

range: int | None

Range (in octaves).

repeat: int | None

Number of times a note is repeated.

slide: bool | None

Whether arpeggio will slide between notes.

time: float | None

Delay between two successive notes played.

class pyflp.channel.Delay

Echo delay / fat mode section.

Used by Sampler and Instrument.

echoes: int | None

Number of echoes generated for each note. Min = 1. Max = 10.

fat_mode: bool | None

feedback: int | None

Factor with which the volume of every next echo is multiplied.

Defaults to minimum value.

Type	Value	Representation
Min	0	0%
Max	25600	200%

property mod_x: int

Min = 0. Max = 256. Default = 128.

property mod_y: int

Min = 0. Max = 256. Default = 128.

pan: int | None

Type	Value	Representation
Min	-6400	100% left
Max	6400	100% right
Default	0	Centred

ping_pong: bool | None

pitch_shift: int | None

Pitch shift (in cents).

Min	Max	Default
-1200	1200	0

time: int | None

Tempo-synced delay time. PPQ dependant.

Type	Value	Representation
Min	0	0:00
Max	PPQ * 4	8:00
Default	PPQ * 3/2	3:00

class pyflp.channel.Keyboard

Used by Sampler and Instrument.

add_root: bool | None

Whether to add root note (instead of pitch) to triggered note.

Named as Add to key. Defaults to False.

fine_tune: int | None

-100 to +100 cents.

key_region: Tuple[int, int] | None

A (start_note, end_note) tuple representing the playable range.

main_pitch: bool | None

Whether triggered note is affected by changes to Project.main_pitch.

root_note: int | None

Min - 0 (C0), Max - 131 (B10).

class pyflp.channel.LevelAdjusts

Used by Layer, Instrument and Sampler.

mod_x: int | None

Properties obtained from a construct.Struct.

mod_y: int | None

Properties obtained from a construct.Struct.

pan: int | None

Properties obtained from a construct.Struct.

volume: int | None

Properties obtained from a construct.Struct.

class pyflp.channel.Polyphony

Used by Sampler and Instrument.

max: int | None

Max number of voices.

mono: bool | None

Whether monophonic mode is enabled or not.

porta: bool | None

slide: int | None

Portamento time. Nonlinear.

Type	Value	Representation
Min	0	0:00
Max	1660	8:00 (8 steps)
Default	820	0:12 (1/2 step)

class pyflp.channel.Time

Used by Sampler and Instrument.

full_porta: bool | None

Whether gate is bypassed when Polyphony.porta is on.

gate: int | None

Logarithmic. Defaults to disabled state.

Type	Value	Representation
Min	450	0:03
Max	1446	4:00
Disabled	1447	Off

shift: int | None

Fine time shift. Nonlinear. Defaults to minimum.

Type	Value	Representation
Min	0	0:00
Max	1024	1:00

swing: int | None

Percentage of the ChannelRack.swing that affects this channel.

Linear. Min = 0. Max = 128. Defaults to maximum.

class pyflp.channel.Tracking

Used by Sampler and Instrument.

middle_value: int | None

B10 (131).

Type:

Note index. Min

Type:

C0 (0), Max

mod_x: int | None

Bipolar.

Min	Max	Default
-256	256	0

mod_y: int | None

Bipolar.

Min	Max	Default
-256	256	0

pan: int | None

Linear. Bipolar.

Min	Max	Default
-256	256	0

Enums

class pyflp.channel.ArpDirection

Used by Arp.direction.

Down = 2

Off = 0

Random = 5

Up = 1

UpDownBounce = 3

UpDownSticky = 4