Skip to content

Windows

The windows functions of the ui module are used to control and interact with windows within FL Studio's interface.

getVisible 

getVisible(index: int) -> bool

Returns whether an FL Studio window is currently open.

Note that this doesn't necessarily mean it is the active window.

Args

  • index (int): window index:

    • widMixer (0): Mixer.

    • widChannelRack (1): Channel Rack.

    • widPlaylist (2): Playlist.

    • widPianoRoll (3): Piano Roll.

    • widBrowser (4): Browser.

Returns

  • bool: whether it is visible.

Included since API version 1.

showWindow 

showWindow(index: int) -> None

Shows an FL Studio window specified by index.

Args

  • index (int): window index:

    • widMixer (0): Mixer

    • widChannelRack (1): Channel Rack.

    • widPlaylist (2): Playlist.

    • widPianoRoll (3): Piano Roll.

    • widBrowser (4): Browser.

Included since API version 1.

hideWindow 

hideWindow(index: int) -> None

Hides an FL Studio window specified by index.

Args

  • index (int): window index:

    • widMixer (0): Mixer.

    • widChannelRack (1): Channel Rack.

    • widPlaylist (2): Playlist.

    • widPianoRoll (3): Piano Roll.

    • widBrowser (4): Browser.

Included since API version 5.

getFocused 

getFocused(index: int) -> bool

Returns whether an FL Studio window is focused (meaning it is the currently selected Window in FL Studio).

Note

  • this doesn't necessarily mean that it is the currently selected window in the host operating system.

Args

  • index (int): window index:

    • widMixer (0): Mixer.

    • widChannelRack (1): Channel Rack.

    • widPlaylist (2): Playlist.

    • widPianoRoll (3): Piano Roll.

    • widBrowser (4): Browser.

    • widPlugin (5): Plugin Window (note that this constant is only usable in this particular function).

    • widPluginEffect (6): Effect Plugin Window.

    • widPluginGenerator (7): Generator Plugin Window.

Returns

  • bool: whether the window is currently focused.

Included since API version 1.

setFocused 

setFocused(index: int) -> None

Sets which FL Studio window should be focused (meaning it is the currently selected Window in FL Studio).

Note

  • This doesn't necessarily mean that it will be the currently selected window in the host operating system.

Args

  • index (int): window index:

    • widMixer (0): Mixer.

    • widChannelRack (1): Channel Rack.

    • widPlaylist (2): Playlist.

    • widPianoRoll (3): Piano Roll.

    • widBrowser (4): Browser.

Included since API version 2.

getFocusedFormCaption 

getFocusedFormCaption() -> str

Returns the caption (title) of the focused FL Studio window. This isn't necessarily the same as the plugin's name.

Returns

  • str: window title.

Included since API version 1.

getFocusedFormID 

getFocusedFormID() -> int

Returns ID of the focused window.

Used to get the channel rack index or mixer plugin ID for plugins.

Returns

  • int: form ID:

    • Index in channel rack (zero indexed).

    • Plugin ID in mixer (track number * 4194304 + slot index * 65536, all zero indexed).

    • Window ID for mixer, channel rack, playlist, etc.

    • -1 for invalid plugin (eg. script output or settings window).

Included since API version 13.

getFocusedPluginName 

getFocusedPluginName() -> str

Returns the plugin name for the active window if it is a plugin, otherwise an empty string.

Returns

  • str: plugin name.

Included since API version 5.

scrollWindow 

scrollWindow(index: int, value: int, directionFlag: int = 0) -> None

Scrolls on the window specified by index. Value is index for whatever is contained on that window (eg channels for the Channel Rack or tracks for the Mixer).

Args

  • index (int): window index:

    • widMixer (0): Mixer.

    • widChannelRack (1): Channel Rack.

    • widPlaylist (2): Playlist.

    • widPianoRoll (3): Piano Roll.

    • widBrowser (4): Browser.

  • value (int): index to scroll to:

    • on mixer: track number.

    • on channel rack: channel number.

    • on playlist: playlist track number.

    • on playlist: bar number (when directionFlag is set to 1).

Included since API version 13.

nextWindow 

nextWindow() -> int

Switch to the next window.

Returns

  • int: ???

Included since API version 1.

selectWindow 

selectWindow(shift: bool) -> int

Switch to the next window, like pressing the Tab key. If shift is True, switch to the previous window by pressing Shift and Tab.

Args

  • shift (bool): whether the shift key is pressed.

Returns

  • int: ???

Included since API version 1.

closeAllMenu 

closeAllMenu() -> None

Close all visible windows, except for the most recently-used FL Studio window.

WARNING

  • This function is not officially documented

Included since API Version ???