ZoomOSC Frequently Asked Questions

Setup

What kind of computer do I need to run ZoomOSC?


ZoomOSC works on Windows 10 and Mac computers, though a general rule of thumb is if your computer works with Zoom, it can work with ZoomOSC. We do recommend a 2nd monitor if you have one!




Do I need a media server to use ZoomOSC?


While a media server is highly recommended, it is not required. ZoomOSC can communicate with anything that sends and receives OSC commands.




Does ZoomOSC integrate with Watchout?


While we don't believe Watchout supports OSC itself at this time, power users have developed OSC relays to use with this media server. From there you can have ZoomOSC piggyback off the translated packets.




What is the recommended way of getting the participants' audio and video from ZoomOSC on one computer to another computer running QLab?


We recommend using a physical AUX wire, a virtual audio cable, or NDI for audio transmission and NDI or Syphon for video transmission. If you are interested in using a virtual audio cable, we recommend using tools from VB Audio Software including https://vb-audio.com/Cable/. Soundflower is another option that you might want to consider.




How do you connect QLab with ZoomOSC?


To connect QLab to ZoomOSC, there are two options.

  1. If you are running ZoomOSC for Mac on the same computer as QLab, send your OSC packets to localhost on port 8000. This can be done by setting your network profile to 127.0.0.1 and port 8000 under settings.
  2. If you are running the Windows version of ZoomOSC on one computer (PC) and QLab on another computer (a Mac), you need to have both the Mac and PC on the same LAN. Obtain the private IP address of your PC by typing ipconfig in Command Prompt. Enter this IP in QLab's network profile, again using port 8000. Ensure your firewall allows for ZoomOSC to access your private network. Also double check the QLab profile network adapter.
Now, to send a command, create a network cue. Set it to the OSC type and use the setup profile you previously created. Then, enter the command you want to use, such as /zoom/update 0.0 When you run the cue, ZoomOSC will hear this command and respond appropriately. Please verify in the command feedback window of ZoomOSC.




Can you see pre-scheduled Zoom events in ZoomOSC?


No, we do not preview pre-scheduled events in ZoomOSC. You need to know the meeting ID. Please use vanilla Zoom to create, schedule, and manage your meetings. When the meeting is established, you can use the meeting ID to join the meeting from ZoomOSC.




Does ZoomOSC have to be the client that created the Zoom meeting?


No. All you need to know is the meeting ID and password (if there is one). Don't include spaces in the meeting ID.




Do you need to log into ZoomOSC?


You do not have to log into ZoomOSC unless you are joining a webinar. Instead, you can use the ONLY JOIN tab. You can create/schedule the meeting from regular Zoom.




Can the port be changed from 8000 to another one?


Not at the moment, but this is a feature we are looking into.





Using ZoomOSC

Can I remove the "Powered by Zoom" watermark or the yellow border around the speaker?


While you cannot remove the watermark in the Active/Pinned Speaker view, if you run ZoomOSC in dual monitor mode, the watermark is located further into the corner of the screen. Regarding the yellow border, you cannot remove it in Zoom, but you can using a media server. One user found a work-around to remove the yellow border. Make sure the yellow border is around an account you don't want to capture. Stop the video for this account and hide non-video participants. If the border is around the ZoomOSC account, hide self video.




Does every member of a production/event need to download ZoomOSC?


No, only the host/operator needs to be using ZoomOSC. That being said, we have begun to add features that may prove useful if all members of the cast are using ZoomOSC as well.




If Zoom releases an update, will this affect ZoomOSC?


Zoom gives Liminal a 30-day heads up on any changes that would require us to modify our software. This has only occurred once, and we made the changes within a few hours. If Zoom decided to go out of business tomorrow, that would probably shut ZoomOSC down (but then we’d just use StreamWeaver!), but failing that, we are in a pretty good place with them. Zoom also releases feature updates periodically. These are usually distributed to devs much later than they appear in the vanilla Zoom client. If we find that a particular feature is desirable for the ZoomOSC project, we will add it as soon as it becomes available to us.




How much control does the Zoom operator/host have over participants?


ZoomOSC is a utility that allows you to use a media server for reliable operation and cueing of different functions. ZoomOSC also transmits information about the Zoom meeting that can help you achieve certain effects - such as controlling the arrangement of the gallery view by using galtrack with a switch engine. Pin and spotlight will let you cut the show together like a film, and gallery tracking will let you build group compositions if you build the iso-simulation engine in your media server or with a shader.




Do individual performers need to control technical parameters from their own computer/phone in the Zoom meeting?


Unmute and Video On require user consent when in meeting mode. This is controlled by Zoom. There are 2 ways to get around this. You could either experiment using Webinar mode or use gallery tracking as a means of compositing any view or arrangement you want within your media server. To get around the consent issue, also try checking out https://support.zoom.us/hc/en-us/articles/203435537-Muting-and-unmuting-participants-in-a-meeting. It might be possible to bypass user consent by working through this in the web interface. Then, you would need to use a 5.2 client to request that the setting be applied to everyone in the call. ZoomOSC might be able to take it from there. ZoomOSC has full control over the off commands, and everything else in the API can be fully automated without actor interaction. So long as you treat the video on cue as a standby for the actor's virtual entrance, just as on stage, the performer will not have to worry about much when it comes to the technical components of the production.




Is there is a way to use ZoomOSC to select a participant's virtual background?


For now, we suggest using a green physical or virtual background and doing chroma key background replacement within your media server. Zoom does not currently allow for remote control of other non-ZoomOSC users' virtual backgrounds.




Do you need multiple ZoomOSC operators?


While multiple ZoomOSC operators are not required, it can be beneficial to have many operators. For a recent production, there were 4 operators.

  1. A Video Operator running ZoomOSC married video effect cues with Zoom cues. An example cue could switch to gallery view while also adding a film grain effect.
  2. A Camera Operator running ZoomOSC would follow the camera cuts autonomously with a nonlinear control surface, operated like a broadcast switcher.
  3. A Director running ZoomOSC used ZoomOSC with a nonlinear control surface to cut the camera in response to a specific portion of the show.
  4. Although this probably will not be needed, there is the option to have a Backup Operator just in case.




Is there a way to spotlight multiple people at once without the other users showing up?


We recommend using the "hide non-video participants" Zoom setting in combination with the video on/off command in ZoomOSC to control gallery layout. We will add multi-spot and multi-pin as soon as Zoom makes it available to devs.




Can you rearrange the users' video boxes?


The new Zoom gallery arrangement feature only works with the 5.2 client. We are waiting for Zoom to release the SDK update to allow the same feature in ZoomOSC.




Does ZoomOSC include a feature that allows you to mute all participants?


No, there is no feature right now for Mute All. If Zoom puts this information back into the SDK, we will add it to the ZoomOSC 3.3 project board.




Where is the performance_config.txt saved? (ZoomOSC 3.2)


The txt file should appear next to the executable after you first call /zoom/save assuming you are not running in some protected location. If ZoomOSC is running in a protected location, like Program Files, you will have to move it to a different location on your computer (Documents folder for example). Then run /zoom/save.





Legacy ZoomOSC Releases

Where can you find the SDK Key and Secret credentials?


Applies to Version 3.0 and 3.1 You can find the credentials in "ZoomOSC License Key.txt," which is included in your download file. If the SDK Key is not working, make sure you are using the default domain. Don't change the domain to your Zoom link. Here's the general workflow: When you launch ZoomOSC, click Set Domain (without changing the text field) and leave Customize UI unchecked. Then, authenticate the app via the key and secret found in the text file (copy paste them into the fields for ease; they are quite long). After that, the authentication should lead you to a screen from which you can associate your zoom account or directly join a meeting.





READY TO DOWNLOAD?

Best of all, ZoomOSC is completely free! Don't forget to sign up for our newsletter to stay up-to-date on releases!

Sign up for our

©2020 by Liminal Entertainment Technologies, LLC