Loading...
OSC/ISO
This module gives you deep control of Zoom through controllers like the StreamDeck. Using ZoomOSC and ZoomISO, it provides a seamless way to manage participants, with their names displayed on the keys. It’s a zero-code, drag-and-drop solution with advanced options for custom workflows.
$(...) variables, and any option can also be switched to an expression.You will need to configure these settings in ZoomOSC/ZoomISO UI
127.0.0.1 if on the same computer).There are a number of configuration options for the module that allow you to configure how to communicate with ZoomISO/ZoomOSC, how many internal groups to track, Participant Multi-State feedback (deprecated), Social Stream Ninja integration, OSC forwarding, and advanced performance tweaks.
ZoomISO/ZoomOSC Transmission IP (e.g. Target Host): Match ZoomISO/ZoomOSC Transmission IP.
ZoomISO/ZoomOSC Receiving Port: Match ZoomISO/ZoomOSC Recieving Port.
ZoomISO/ZoomOSC Transmission Port: Match ZoomISO/ZoomOSC Transmission Port
Default Selection: Select one participant at a time or Select multiple participants simultaneously.
Number of selectable groups:
One of the most powerful features of this module is the ability to place participants into groups. Just like participants, groups are referenceable and selectable. You can index into groups with variables to display their members. Buttons with these properties are automatically available in the Presets area under the Groups section: Manage Selections of Groups holds the group management buttons, and there is one Select (group name) participants group per group. New buttons are generated based on the number of groups specified during setup.
Default Groups
There are two default groups. These groups are automatically managed by the module, so you cannot add or remove members manually or change the group properties:
Group Management
Group Use Cases
Once users are assigned to groups, you can easily select a group (e.g., "Panelists") and apply actions like Add Spotlight to the entire group.
Sync iso configuration time in sections (only for ZoomISO): How often to update the ZoomISO audioLevels, outputRouting, audioRouting, and engineState. The default is 1 second.
Participant Multi-State Feedback (Deprecated)
Deprecated. Companion's graphics layers (layered buttons, Companion 5.0+) replace the multi-state feedbacks. The presets for participants, gallery, host, spotlights and groups have been updated to use layers (see Layered participant presets below). Update your buttons to use them: existing buttons aren't converted automatically, so add each one again from the presets. This setting only affects the four "(Deprecated) ... showing multi-state" feedbacks, which still work on existing buttons until then but will be removed in a future version.
The multi-state feedbacks show a participant's camera, mic and hand raise status as icons along the bottom of the button. Each status has an icon with both "on" and "off" states.
Disable (Not recommended unless you don’t need feedback indicators.)
Bottom (On and Off for Mic/Camera, Only On for Hand Raise)
Bottom (Only Active States)
Bottom (On and Off Active States)
Layered participant presets (Companion 5.0+)
The participant, gallery and group position presets are layered buttons. Each status is its own layer, driven by the regular boolean feedbacks (Mic Live / Mic Off, Camera On / Camera Off, Hand Raised, Active Speaker, Selected, Spotlight On / Off):
The "Select from Participants" and "Select from Gallery" sections, and the "Select <group> participants" section for each group, list positions 1 to 49 (the Spotlights group lists 1 to 9). Every button stores its position in a local variable called position. To use a button for a participant beyond 49, drag any of the presets onto a button and change its position local variable.
The Select by name preset (in "Manage Selections") is the same layered button for a participant chosen by name. Set the participant's name in the button's name local variable; the select action, all of its feedbacks and the button text use it. The button shows "Select by name" until a name is set.
The Active Speaker preset (also in "Manage Selections of Participants") is the same layered button for whoever is currently speaking. It uses the module's $(zoomosc:activeSpeaker) variable as the name, so pressing it toggles the active speaker in the selection, and its name, icons and highlights follow the active speaker. Its blue SPEAKER bar is always on.
Preset icons
Most action presets (selecting, pinning, spotlighting, muting, hands, roles, waiting room, sharing, recording, chat, join/leave, groups and ZoomISO outputs) come with an icon, so no images need to be added to Companion. Group presets use each group's own colour set (Host, Spotlights and groups 2 to 9) and show the group name in the space the icon leaves for it. The ZoomISO "Select output" and "Select audio channel" presets keep their plain style so their red "selected" feedback stays visible.
Using your own icons
You can replace any of the status icons for every layered participant, gallery and group button at once by adding an image to Companion's Image Library with one of these exact names:
| Icon | Image library name |
|---|---|
| Mic On | zoom_mic_on |
| Mic Off | zoom_mic_off |
| Camera On | zoom_camera_on |
| Camera Off | zoom_camera_off |
| Hand Raised | zoom_hand_raised |
| Hand Lowered | zoom_hand_lowered |
Each icon is drawn over the whole button, so use a transparent PNG (72×72 works well) with the icon placed where it should appear, as in the built-in icons in the module's assets/layers folder. Delete the image from the library to go back to the built-in icon. Buttons added from presets before this version use the built-in icons only; re-add them from the presets to pick up your images.
The built-in icons are also available as module variables (icon_mic_on, icon_mic_off, icon_camera_on, icon_camera_off, icon_hand_raised and icon_hand_lowered). To build a button by hand, add an image element for each icon, then add the matching boolean feedback with a style override that sets the element's image to an expression such as getVariable('image', 'zoom_mic_on') || $(zoomosc:icon_mic_on).
The layered presets always show mic on/off, camera on/off and hand raised. When the hand is lowered, the hand icon disappears. To show the hand-lowered icon on a button, add the participant's Hand Lowered feedback to it with a style override that sets the hand image to getVariable('image', 'zoom_hand_lowered') || $(zoomosc:icon_hand_lowered). The setting above only affects the "(Deprecated) ... showing multi-state" feedbacks.
The "Select from Participants" presets read the participant position variables, so Enable Variable For Participants must be turned on in the module configuration for their names and feedbacks to work.
The "(Deprecated) ... showing multi-state" feedbacks still work on existing buttons, but they will be removed in a future version. Update your participant, gallery, host, spotlight and group buttons to the layered presets: existing buttons aren't converted automatically, so add each one again from the presets.
Send Zoom Chat to Social Stream Ninja
One of the configuration options, is to send chat messages to Social Stream Ninja. In order for this to work, you need to provide your social stream ninja session id in the module configuration.
Once the integration is turned on, you will need to update the urls you are using for your Social Stream Ninja browser source within OBS or other streaming software.
Install Social Stream Ninja Configuration
You can install Social Stream Ninja at https://socialstream.ninja/landing#manually-install-extension. We suggest manually installing the extension as that is the most update to date version.
Social Stream Ninja Configuration
You need to configuration Social Stream Ninja so that it will allow you to make API calls to it and to get your Session Id
Social Stream Ninja Dock
Social Stream Ninja includes a web page to see all of the message using the url below (replace XXXXXXXX with your social stream id)
https://socialstream.ninja/dock.html?session=XXXXXXXXX&server&server2&sync&label=main&limit=300If using OBS, you can make this url a custom browser dock.
Lower 3rd
Social Stream Ninja has a built-in lower 3rd that you can reference by using
https://socialstream.ninja/index.html?session=XXXXXXXXX&aligntop&server&server2
If you are using OBS, you can create a browser source on a scene and use url above (replace XXXXXXXX with your social stream id) and set the following properties
OSC Forwarding
ZoomOSC/ZoomISO can only send its messages to one place, which is this module. To let another application see the same messages, enable OSC Forwarding and enter that application's IP and port. The module sends a copy of every OSC message it receives to that address, exactly as it arrived. Nothing is filtered or changed, and the module keeps working as usual.
Forwarding all OSC from ZoomOSC/ISO to <IP>:<port>. Every failed send is logged as an error. A UDP send to an application that isn't running doesn't fail, so if the other application gets nothing, check that it's running and listening on that port.Actions
Both save the change, so it's remembered after a restart, and neither reconnects to ZoomOSC/ZoomISO.
Feedback
Variables
$(zoomosc:oscForwardHost) and $(zoomosc:oscForwardPort): the IP and port messages are forwarded to (shown even while forwarding is off).Presets
The Forward OSC Messages section has a toggle button that shows the IP and port, On and Off buttons, and a Set Forward OSC Target button to edit.
Advanced - Optional Performance Tweaks
IMPORTANT NOTE: The advanced optional performance tweaks is for power users that would like to tweak the module performance.
Depending on your usage of ZoomOSC and ZoomISO, there may be things going on behind the scenes that you may not be using and can disable to try to get even better performance from this module.
Enable Variable for Each User (variables that are the ZoomId for each participant)
The module tracks a variable for each user based on their ZoomId but the ZoomId changes every time they enter the meeting, so within the module we do not use these variables for anything but for legacy purposes, we have not removed them.
It is suggested to turn this setting off.
Enable Variable for Participants (e.g. Participant001 to Participant999)
This impacts the participant presets, participant buttons, and participant variables. For many shows, these buttons are not used as it is the list of all participants in the order that they joined and for large meetings, it is typically quicker to find a person using the Zoom participant list and manually taking action on them.
Most people use the Gallery buttons over the participant buttons as it is way easier to find people in the Gallery since you can sort the gallery by first name.
If you want to keep previous behavior of keeping these variables updated, set to true keep the behavior of previous versions.
Sync Action/Presets/Feedbacks
As participants, groups, and zISO are updated behind the scenes, it is:
Keeping all these in sync is important and needed when setting up your button layout but when you are running the show you are typically not updating the design of your buttons, so you do not need to pull in new presets, adding / removing groups, or picking a different options from the option dropdowns.
Set to true keep the behavior of previous versions.
If you do need to sync the values manually, there is a new action called "Update Actions/Feedbacks/Presets with current Zoom Data".
Select user(s), then apply action(s).
See more workflows at <a href="https://github.com/bitfocus/companion-module-zoom-osc-iso/blob/main/README.md" target="_blank">Module Readme</a>
This is a community-driven project utilizing the open APIs of ZoomOSC/ISO. While Zoom (and formerly Liminal) have designed its behavior, they hold no liability for this module or its upkeep. Ultimately, it is managed by and the responsibility of the open-source Companion community, Bitfocus, and its users.
Special thanks to contributors Jeffrey Davidsz, Andy Carluccio, Jonathan Kokotajlo, and the Companion community for their efforts in creating and improving this module.