Channel#

class pyflp.channel.Channel[source]#

Represents a channel in the channel rack.

color: RGBA | None#

Defaults to #5C656A (granite gray).

Values below 20 for any color component (R, G or B) are ignored by FL.

property display_name: str | None#

The name of the channel that will be displayed in FL Studio.

enabled: bool | None#

//bit.ly/3sbN8KU)

Type:

![](https

property group: DisplayGroup#

Display group / filter under which this channel is grouped.

icon: int | None#

Internal ID of the icon shown beside the display_name.

iid: int | None#

Properties bound directly to one of fixed size or string events.

internal_name: str | None#

Internal name of the channel.

The value of this depends on the type of plugin:

  • Native (stock) plugin: Empty afaik.

  • VST instruments: “Fruity Wrapper”.

See also

name

keyboard: Keyboard#

Located at the bottom of Miscellaneous functions (page).

locked: bool | None#

Whether in a locked state or not; mute / solo acts differently when True.

name: str | None#

The name associated with a channel.

It’s value depends on the type of plugin:

  • Native (stock): User-given name, None if not given one.

  • VST instrument: The name obtained from the VST or the user-given name.

See also

internal_name and display_name.

property pan: int | None#

Linear. Bipolar.

Min

Max

Default

0

12800

6400
property volume: int | None#

Nonlinear.

Min

Max

Default

0

12800

10000
property zipped: bool#

Whether the channel is zipped / minimized.

Enums#

class pyflp.channel.ChannelType[source]#

An internal marker used to indicate the type of a channel.

Automation = 5#
Instrument = 4#
Layer = 3#
Native = 2#

Used by audio clips and other native FL Studio synths.

Sampler = 0#

Used exclusively for the inbuilt Sampler.

class pyflp.channel.ChannelID[source]#
IsEnabled = 0#
_VolByte = 2#
_PanByte = 3#
Zipped = 15#
PingPongLoop = 20#
Type = 21#
RoutedTo = 22#
IsLocked = 32#
https://img.shields.io/badge/FL%20Studio-12.3+-5f686d?labelColor=ff7629&style=for-the-badge
New = 64#
FreqTilt = 69#
FXFlags = 70#
Cutoff = 71#
_VolWord = 72#
_PanWord = 73#
Preamp = 74#
https://img.shields.io/badge/FL%20Studio-1.2.12+-5f686d?labelColor=ff7629&style=for-the-badge
FadeOut = 75#
https://img.shields.io/badge/FL%20Studio-1.7.6+-5f686d?labelColor=ff7629&style=for-the-badge
FadeIn = 76#
Resonance = 83#
StereoDelay = 85#
https://img.shields.io/badge/FL%20Studio-1.3.56+-5f686d?labelColor=ff7629&style=for-the-badge
Pogo = 86#
TimeShift = 89#
Children = 94#
https://img.shields.io/badge/FL%20Studio-3.4.0+-5f686d?labelColor=ff7629&style=for-the-badge
Swing = 97#
RingMod = 131#
CutGroup = 132#
RootNote = 135#
DelayModXY = 138#
Reverb = 139#
https://img.shields.io/badge/FL%20Studio-1.4.0+-5f686d?labelColor=ff7629&style=for-the-badge
_StretchTime = 140#
https://img.shields.io/badge/FL%20Studio-5.0+-5f686d?labelColor=ff7629&style=for-the-badge
FineTune = 142#
SamplerFlags = 143#
LayerFlags = 144#
GroupNum = 145#
AUSampleRate = 153#
_Name = 192#
SamplePath = 196#
Delay = 209#
Parameters = 215#
EnvelopeLFO = 218#
Levels = 219#
Polyphony = 221#
Tracking = 228#
LevelAdjusts = 229#
Automation = 234#