Zoom Rooms API - zoomroom.share_content_start / stop - Does Not Share HDMI

Zoom Rooms API - zoomroom.share_content_start / stop - Does Not Share HDMI
Zoom Rooms v6.5.1

Context:
Due to the ZR-CSAPI being depreciated from Zoom Room v6.7.0, I’ve been tasked with developing a new Q-Sys Plugin to control our Zoom Rooms using the REST API.

The aim is to replicate all the controls possible in our existing plugin (ZR-CSAPI) and replace it with a new REST API plugin.

zCommands ‘zCommand Call Sharing HDMI Start’ and ‘zCommand Call Sharing HDMI Stop’ are available in the ZR-CSAPI.


For testing, Room Settings are:
“Start HDMI content share manually on controller” enabled.
“Allow HDMI content share locally before and during the meetings” disabled.

Using the REST API, I’ve found:

zoomroom.share_content_start

  • When NOT in a meeting, this command does nothing. (Response code 202 is returned).
  • When in a meeting, this command will display the share content popup.

zoomroom.share_content_stop

  • When NOT in a meeting, if the room is sharing HDMI, this command does nothing. (ie. HDMI sharing cannot be stopped).
  • When in a meeting, this command will hide the share content popup.

On the physical Controller, when NOT in a meeting, the ‘Share’ button will start HDMI sharing.
Once sharing, you can then select ‘Start Meeting’ and the HDMI content will continue to be shared.
However, if you send the zoomroom.meeting_join command after pressing ‘Share’ on the controller, it will cancel the HDMI share and start a meeting with the share popup on screen.

Using the API, there doesn’t appear to be a way to Share HDMI, or Share HDMI to a Meeting, or Start a Meeting then Share HDMI.

How can the API being improved to enable more controls on parity with the ZR-CSAPI?

Hey @Glen
Thanks for reaching out to us!
Could you please point me to the documentation you are following to implement this on your end?

Hey Elisa,

I’m unable to put a link into a Forum post, or embed a media item (Screenshot).
The REST API controls are found under ‘Use Zoom Room Controls’.

The zCommands mentioned in the depreciating ZR-CSAPI can be found by searching “HDMI” in Legacy Controls → Rooms Control System API (CS-API)

Hi @Glen
I will send you a DM where you will be able to share links and screenshots
Follow up there please