ZoomOSC with BitFocus Companion

The software and hardware that supports the OSC protocol is fairly long. Some of the more popular applications that I have also used are listed here:

The simplest to try is Bitfocus Companion. It’s an open-source software which works seamlessly with Elgato Streamdeck (https://www.elgato.com/en/gaming/stream-deck), a physical key based configurable switcher.

First you have to download the Bitfocus Companion from https://bitfocus.io/companion/ website, it’s available for both MacOS and Windows. Download and setup Bitfocus companion software.

When you open the companion from your application folder it will ask for the network permissions, click on “Allow” button.

Once you click on allow button it will run the following window.

Click on “Launch GUI” button to Launch the companion interface. It will open a new tab in your browser windows on IP: 127.0.0.1 and Port will be 8888 by default. You can customize these setting from the above-mentioned window.

The companion interface loads in your browser window, like the above screenshot. Search for “generic osc” in Add by search box. It will display “Generic OSC” in the list like screenshot below. Click on the add button (presented in front of the “Generic OSC”) to configure the OSC connection configuration.

After you click the add button it will show the Osc Configuration tab to specify the connection settings for the Target IP and Target Port.

As we know the Transmission IP and Receiving Port for ZoomOSC are 127.0.0.1 and 9090 respectively. If you don’t, click on the settings tab on ZoomOSC window and check the details.

Specify these details in OSC Configuration tab as shown below, and click on Apply Changes button.

Now you will see the connection/instances list created in earlier step.

With this we have setup the connection between ZoomOSC and Companion. Now create buttons to interact and test the functionality. For this, Click on the second tab “Buttons”. It will show an interface for page 1 with blank buttons. On this interface you can define or customise the PAGE name. Create new custom buttons etc.

Create new button

Click on any of the black buttons shown in the interface, but keep sequence of the workflow in mind so that it is comfortable and simpler to use. Companion refer this button as 1.2 , you can see that in the adjacent Edit button window.

Now set the button type a Regular Button.

It will give you an interface where you can make various customisations to the button. In the text specify “Gallery View” on Key Down/On action dropdown select “osc: Send message without arguments”. Like shown in the screen shot.

In OSC path text box specify the OSC path like to set a Gallery View use
/zoom/me/setGalleryView

Now open ZoomOSC client and login to a meeting to test our button that we have created. Once you join the meeting with ZoomOSC client. Click on the Test action (Yellow Colour) button shown in screenshot above. This will send OSC command to ZoomOSC and set your view to Gallery View.

You can verify the above-mentioned process by clicking on log tab in ZoomOSC client window. It will show the Received message (OSC Command) and the action that ZoomOSC client perform. A reference screenshot below:

Now our ZoomOSC connection with Companion is ready, and we can start to create our Streamdeck pages as per requirement.

As per ZoomOSC there are 3 major categories of commands or messages that ZoomOSC sends to the client.

  1. User Commands – Require targets, which can be users, participants or groups.
  2. Global Commands – Do not target and control meeting or application settings.
  3. Output – OSC messages that comes out of ZoomOSC containing useful information. 

In the coming posts we will be touching each category and how was our experience with it.

Write to us

All fields marked with an asterisk (*) are required.