Skip to content

Screen

Screen

FL Studio built-in module.

Helper functions for controlling the screen of the AKAI FL Studio Fire MIDI controller.

These likely aren't useful for most scripts, but if you're writing a script for the Fire they might be handy.

HELP WANTED

These functions are undocumented. If you know how they work, I'd massively appreciate a pull request with improvements to the type safety and documentation.

addTextLine(text, line)

Add text to a line on the screen?

Args:

  • text (str): text to add

  • line (int): line on the screen

Included since API Version 1

deInit()

De-initialize the screen of the AKAI Fire

This should be called before the script closes.

Included since API Version 1

fillRect(start_x, start_y, end_x, end_y, value)

Draw a filled rectangle to the given position on the screen.

It is drawn from the start values up to (but not including) the end values.

Args:

  • start_x (int): starting horizontal position

  • start_y (int): starting vertical position

  • end_x (int): ending horizontal position

  • end_y (int): ending vertical position

  • value (int): unknown, maybe color?

Included since API Version 1

init(display_width, display_height, text_row_height, font_size, value_a, value_b)

Initialize the screen of the AKAI Fire

This should be called before using any of the other functions in the screen module. After calling it, the screen.setup function should be called to allow the screen to be used.

Args:

  • display_width (int): width of the display in pixels

  • display_height (int): height of the display in pixels

  • text_row_height (int): height of a text row (in what units?)

  • font_size (int): font size to use (in what units?)

  • value_a (int): unknown

  • value_b (int): unknown

Included since API Version 1

setup(sysex_header, screen_active_timeout, screen_auto_timeout, text_scroll_pause, text_scroll_speed, text_display_time)

Set up the AKAI Fire screen.

This should be called after screen.init in order to perform more setup

Args:

  • sysex_header (int): header for sysex message for device

  • screen_active_timeout (int): unknown

  • screen_auto_timeout (int): unknown

  • text_scroll_pause (int): unknown

  • text_scroll_speed (int): unknown

  • text_display_time (int): unknown

Included since API Version 1

update()

Notify the Fire that it should update its screen contents

This should be called after performing updates to the device's screen.

Included since API Version 1