Skip to content

Models

ChannelPlug dataclass

Represents a plugin on the channel rack

  • plug: plugin if applicable

  • name: channel name

  • ch_type: type of channel

  • grid_bits: grid bits for this channel (will move to patterns module)

  • target: target mixer track

  • group: group that the channel belongs to

  • selected: whether the channel is selected

  • color

  • volume

  • pan

  • muted

ChannelsModel dataclass

Model of generator channels

  • channel_list: list of channels

  • selected_group: name of currently selected group ('' if viewing unsorted, None if viewing all)

DeviceModel dataclass

Contains info on the device

  • assigned: whether the device is assigned

  • port: the device's port

  • name: the name of the device

  • dispatch_targets: list of port numbers of device numbers that we can dispatch to

GeneralModel dataclass

General info about FL Studio

  • api_version: version of the FL Studio API

  • undo: info on the undo/redo state

  • ppqn: timebase of project

  • beats: number of beats per bar

  • metronome: whether the metronome is enabled

  • pre_count: whether pre-count is enabled

  • changed: whether the current project needs saving

  • tick_num: the number of ticks that FL Studio has run. Used by some functions to perform error checking

MixerModel dataclass

Model of mixer

  • tracks: list of track info

MixerPlug dataclass

Mixer plugin info

  • plug: plugin

  • level: send level

Model dataclass

Overall model of FL Studio

  • channels

  • device

  • general

  • transport

  • ui

PatternModel

hasChanged()

Returns whether this pattern has been modified from the default

PlugInfo dataclass

Info on a plugin

  • name: name of plugin instance (can be renamed by user)

  • plug_name: name of the plugin (immutable)

  • params: list of plugin parameters

PluginParam dataclass

Parameter of a plugin

  • name: name of parameter

  • value: value of parameter

TransportModel dataclass

General info about FL Studio

UiModel dataclass

Model for UI

Properties

  • active_window: active FL window ID

  • active_generator: index on channel rack of active generator plugin

  • active_effect: index in mixer of active effect plugin

  • selection: determines what is selected (FL Window, generator plugin, or effect plugin)