Macros to automate dividing and combining conference rooms with Webex Codec Pro and Webex Codec EQ devices so that the same equipment can be used in both modes to join conference calls. This Macro can be used for setups consisting of two or three rooms that can be combined into one large room.
NOTE: This is a simpler variant of the N-Way Divisible Conference Rooms Webex Devices Macros without a separate config file and specific macro files for Primary and Secondary codecs to reduce size and complexity. It does not support complex room layouts where Secondary codecs can be "promoted" to Primary. If you need that functionality or support for more than 3 rooms or more than one QuadCam in a room please use that N-Way variant of the macro.
| RoomOs Minimum Version | Webex Cloud | Webex Edge (Hybrid Cloud) | On-Premise | Microsoft Teams Room On Cisco Devices |
|---|---|---|---|---|
| 10.17.1.0 | Yes | Yes | Yes | No - API Limitation |
Check the Change Log in this repository for the most recent changes and fixes to this macro.
NOTE: Support for the Codec EQ has not yet been reflected in the system drawings as an option or mentioned in the Instalation Instructions, but the macro has been changed to accomodate the smaller number of connectros on that device. If you wish to use Codec EQ devices, they must have the AV Integrator Software Option Key installed.
- Gerardo Chaves ([email protected])
- Webex Collaboration Endpoints
- Javascript
- xAPI
- Minimum RoomOS version 10.17.1
- If running RoomOS 11 , minimum version is 11.2.1.0
- Codec Pro or Codec EQ with QuadCam or SpeakerTrack 60 camera array on each room (SP60 support is experimental)
Follow the Version 3 Two-way System Drawing diagrams for hardware setup.
For configuration setup and further hardware setup instructions, refer to the Installation Instructions for Divisible Conference Rooms Version 1.0.1 document in this repository.
Install GMM_Lib.js and divisible_room_primary.js or divisible_room_secondary.js on each codec depending on their role. (primary or secondary)
NOTE: If you need to replace a codec that was already configured with this macro and wish to preserve the Camera presets, consider using this macro to make a backup of the presets for later restoring: https://github.com/wxsd-sales/camera-presets-backup-restore-macros
Here is a summary of each macro in this repository:
This is a library shared by various Webex Device macros that simplifies communication between codecs and modules on the same codec.
More details at: https://github.com/CiscoDevNet/roomdevices-macros-samples/tree/master/Global%20Macro%20Messaging
Please install this macro on the primary and all secondary codecs, but do not turn it on.
This is the main module to be installed in the primary codec.
In addition to handling configuration changes when combining or splitting rooms and switching video inputs based on active speakers, it handles communications needed between Primary and Secondary codecs to keep the codec awake and set the correct video layouts
Once you have installed divisible_room_primary.js, edit as needed the values in sections 1 through 6 of that file before turning on the macro.
Detailed instructions on each settings in those sections are provided in the divisible_config_primary macro itself in the form of code comments.
IMPORTANT: Turn on the divisible_room_primary macro on the Primary codec before turning it on in secondaries to give the macro a chance to set up the correct Join/Split state according to what is reflected in permanent storage. DO NOT turn on the GMM_Lib macro, it is just a library that is used by the divisible_room_primary macro.
This is the main module to be installed in the secondary codecs.
Once you have installed it, edit as needed the values in sections 1 through 6 of that file before turning on the macro.
Detailed instructions on each settings in those sections are provided in the divisible_config_primary macro itself in the form of code comments.
NOTE: Never change the Video Monitors, Ultrasound MaxVolume, WakeupOnMotionDetection or StandbyControl settings on the Secondary codec while in combined mode. These settings are stored when going from split to combined mode to restore once back in split mode so if you change them while combined the wrong settings could be stored away in persistent memory. The safest option is to set those on either codec only in split mode and while the macro is off.
IMPORTANT: Turn on the divisible_room_primary macro on the Primary codec before turning it on in secondaries to give the macro a chance to set up the correct Join/Split state according to what is reflected in permanent storage. DO NOT turn on the GMM_Lib macro, it is just a library that is used by the divisible_room_primary macro.
Once the macros are running and have done the initial configuration, you can switch room configurations from joined/combined to split/standalone by either triggering the wall switch with the divider wall between them or manually on the Touch10 or Navigator associated to the Primary codec by invoking the custom "Room Combine Control" panel:
If you only have one Primary and one secondary, you can also use the USE_WALL_SENSOR constant in divisible_room_primary.js of the Primary codec to indicate if you will use that to switch.
To trigger the automatic switching behavior between rooms when combined, either connect to a call or manually turn on SpeakerTrack on the QuadCam.
If you turn off SpeakerTrack manually while in a call, the automatic switching will pause until you turn it back on again. During this time, you can select another camera in the codec, such as a PTZ camera focused on a Whiteboard, which will be used in the call and even when there is audio activity in the secondary room the macro will not switch to that camera until you turn speakertrack back on.
During a call, you can use the Auto Q&A custom panel button to turn on PresenterTrack with our without the Q&A mode option. When in Presenter Track mode with with Q&A mode enabled, the macro will take care of keeping the focus on the presenter and if a question comes in from the audience from either room it will compose the image of the presenter plus the audience member while they are talking and a few seconds afterwards (controlled by the PRESENTER_QA_KEEP_COMPOSITION_TIME configurable constant in the macro) it will focus back only on the presenter; this behavior is similar to the native "Classroom Mode" which is not compatible with this macro. If you select PresenterTrack without the Q&A mode option, the macro will make sure the presenter is always the one being shown in the call irrespective if anyone else in any of the rooms is speaking until you turn off PresenterTrack either via the custom panel or using the native camera controls of the codec.
NOTE: WebRTC support in RoomOS 10 (i.e. calls to Google Meet) in this macro is "experimental" due to lack of full support for camera swtiching when WebRTC calls. The switching in this is accomplished by temporarily muting video, switching and then turning back on with a 1.5 second delay so you will experience a blank screen being sent to the other end during that switching. Please note that if you turn off automation manually by turning off Speakertrack while in a WebRTC call, even if you select a different camera it will not be sent automatically to the other side since the "workaround" of muting for 1.5 seconds is disabled when the macro is not in automatic switching mode. In this situation, you must manually select the new camera to use, mute the outgoing video using the Touch 10 button, wait at least 1.5 seconds and then Un-mute the video also on the Touch10 button.
For RoomOS 11 , there is full support for camera switching in WebRTC calls without the delays described above, but it still cannot compose two video inputs side by side in overview moder or in Presenter QA mode so in those situations the macro will just send one video input.
Provided under Cisco Sample Code License, for details see LICENSE
Our code of conduct is available here
See our contributing guidelines here
Please note: This script is meant for demo purposes only. All tools/ scripts in this repo are released for use "AS IS" without any warranties of any kind, including, but not limited to their installation, use, or performance. Any use of these scripts and tools is at your own risk. There is no guarantee that they have been through thorough testing in a comparable environment and we are not responsible for any damage or data loss incurred with their use. You are responsible for reviewing and testing any scripts you run thoroughly before use in any non-testing environment.