Skip to main content

Install

You need Companion 4.3.0 or later, or 5.x, and a Cloudmix API key.

Download the module​

Download the latest version from Releases. It's a single .tgz file. Don't unpack it.

Import it into Companion​

  1. Open the Companion web interface and go to Modules.
  2. Choose Import, and select the .tgz file you downloaded.

Cloudmix Studio now appears in the list of modules, with the version you imported.

Add a connection​

  1. Go to Connections and search for Cloudmix Studio.
  2. Add it. The connection's settings open.
  3. Fill in the settings:
    • API Key: your Cloudmix org API key. You'll find it in the Cloudmix dashboard under Settings > API Keys.
    • Environment: leave this on Production unless Cloudmix has asked you to use another one.
    • Session Poll Interval and Projects Poll Interval: how often the module refreshes project state (10 seconds by default) and the project list (30 seconds by default). The defaults suit most setups, because the module also refreshes straight after every button press.
    • Project Name Filter: optional. Only projects whose name contains this text (in any case) are shown.
  4. Save. The connection turns green once it has reached Cloudmix.

Add buttons​

Open the connection's Presets tab and drag the ready-made buttons for your projects onto a page. You can also build your own buttons from the module's actions and feedbacks.

Next​

When a new version comes out, follow Updating. Don't remove and re-add the module.