Moku API

# Moku Custom Instrument

Provides access to Moku Custom Instrument generated with Moku Compile (opens new window)

If you are using the Custom Instrument instrument directly through the REST API, the instrument name as used in the URL is custominstrument.

Multi-Instrument Mode

Moku Custom Instruments can only be used in Multi-Instrument Mode. Refer to the Multi-Instrument Mode Getting Started Guide for more details.

# Deploying the instrument

Functions

Core

  • getters: Custom Instrument - getter functions
  • load_settings: Load a previously saved `.mokuconf` settings file into the instrument. To create a `.mokuconf` file, either use `save_settings` or the desktop app.
  • save_settings: Save instrument settings to a file. The file name should have a `.mokuconf` extension to be compatible with other tools.
  • set_control: Set a control register value
  • set_controls: Set multiple control register values.
  • set_interpolation: Toggle the output interpolation for a given channel.
  • summary: Returns a short summary of current instrument state

Getters →