# Native Module

The native Companion module for MIxEffect exposes many functions of MixEffect through drop-down menus, sliders, and input fields, obviating the need to remember the OSC path and argument order.

> **NOTE**: Not all OSC commands are supported in the module, so it's also recommended that you create a new Generic OSC module in your Companion instance.

## Download

The 3.1.x stable candidate for Companion includes the native MixEffect module.&#x20;

<figure><img src="https://3777554060-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MaiI5oKYEXGU01L5yjC%2Fuploads%2FL1tY7bwR9oYhsY0kIHwb%2Fimage.png?alt=media&#x26;token=05be3813-de2d-4772-ba08-f82c133a3c16" alt=""><figcaption></figcaption></figure>

## Installation

To install the Companion module, follow these steps:

1. Double-click the EXE or DMG file and follow the on-screen instructions to install Companion.
2. Open Companion.
3. In the **Connections** tab of Companion Admin, search for`MixEffect` and click **Add**.\
   \
   ![](https://3777554060-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MaiI5oKYEXGU01L5yjC%2Fuploads%2FurqoKHG8DapRzlh0dXIf%2FScreen%20Shot%202022-02-08%20at%2008.48.09.png?alt=media\&token=1404c462-f629-4bfc-bc01-fc61ab811b56)
4. For the **Label** field, enter a name by which you'll identify the module (i.e. `mixeffect`).
5. For the **Target IP** field, enter the IP address of MixEffect running on your iPhone, iPod touch, iPad, or Apple Silicon Mac. On MixEffect 1.4 and higher, you'll see the IP address of your device in the Switcher Connection detail screen. \
   \
   ![](https://3777554060-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MaiI5oKYEXGU01L5yjC%2Fuploads%2FkMfhVCRHw5ogeOhCxIQ7%2Fswitcher-connection-enable-osc.png?alt=media\&token=ef776ff8-d98a-43e3-9761-be51ac5996fa)<br>
6. For the **Target Port** field, enter the port number of MixEffect, as defined in the Switcher Connection detail screen.\
   \
   ![](https://3777554060-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MaiI5oKYEXGU01L5yjC%2Fuploads%2FIORe24zUiir0zqI9kfiF%2Fimage.png?alt=media\&token=27f4a822-edab-4465-a96b-24b7c8906fdb)<br>
7. Make sure that **Enable Automations** and **Enable OSC** are turned on in MixEffect Settings > Automations and that **Enable OSC Server** is turned on in your Switcher Connection detail screen.\
   \
   ![](https://3777554060-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MaiI5oKYEXGU01L5yjC%2Fuploads%2FW28dxPLHRsiKFmQYmVQL%2Fenable-automations-osc.png?alt=media\&token=8706653b-7945-413c-9351-0891cd2236fb)<br>
8. Select the type of ATEM switcher you have in the **Model** drop-down menu.
9. If you want to take advantage of feedback, check **Enable Feedback Polling**. If so, you'll have to configure the HTTP Feedback Server in MixEffect.
10. Click **Save** in Companion.

{% hint style="warning" %}
Do not enter the IP address of your ATEM switcher here. The MixEffect Module for Companion works by communicating to your ATEM switcher via MixEffect.
{% endhint %}

### Creating a Test Button

1. Go to the Buttons tab.
2. Create a new button.
3. Enter a name for the button.
4. Click the green Regular Button button.
5. Click `+ Add key down/on action` in the Press actions section.
6. Enter the label you enter in Installation Step 4. A list of available actions will appear.
7. Choose an action.
8. Enter all relevant fields.
9. Click the `Test Actions` button to test your button.

If everything is configured properly, the action will take place on MixEffect and your ATEM switcher. If nothing happens, verify that your IP Address and Port Number are set properly and that OSC is enabled in MixEffect.

## Release Video

Watch the [announce video and interview with the developer](https://www.youtube.com/watch?v=ElhBOvzVylQ).

{% embed url="<https://www.youtube.com/embed/ElhBOvzVylQ>" %}
MixEffect Native Companin Module
{% endembed %}

Visit this page for links to the current beta build of Companion that includes the MixEffect module.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.mixeffect.app/automate/osc/companion/native-module.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
