zoomsense/windowssensor repository overview

⁠ZoomSense - Windows Sensor

The Windows Presentation Foundation application in this repository is developed using the official Zoom C# SDK. The application is designed to be run within a Windows Server Core Docker container on a VM infrastructure and act as Zoom clients that can be instructed to join meetings. Coordination of the sensors is via a containerised Node script - Docker Scheduler⁠. Multiple instances can be run on a VM within the dockerized environment.

Major features of Windows Sensor including:

• Observe real-time active speaker change events (including silence detection)
• Enable audio and video recordings within breakout rooms (by making sensors co-hosts or allow recording specifically)
• Push recordings to Firebase storage upon leaving the breakout rooms/meetings
• Receive and store chat histories within the Zoom meetings
• Enable bye bye sensor feature to kick out sensors within breakout rooms

⁠Run the Windows Sensor Locally

Pull the ZoomSense Windows Sensor from Docker:

docker pull zoomsense/windowssensor:latest

Windows Sensors can be run locally using the following docker command:

docker run zoomsense/windowssensor:latest -e <environment variables> start /wait C:\\ZoomSensor\\ZoomSensor.exe <meetingNo> <sensorId> <websiteDomain> <timestamp>

The following environment variables need to be set within each Windows Sensor:

FirebaseUrl=https://FIREBASE_DATABASE_URL.firebaseio.com
ZoomsenseUrl=https://FIREBASE_PROJECT_ID.web.app/#
ZoomAppKey=Zoom SDK App Key
ZoomAppSecret=Zoom SDK App Secret
FirebaseKey=Firebase App Key
FirebaseAuthEmail=Firebase Admin Account Auth Email
FirebaseAuthPwd=Firebase Admin Account Auth Password
FirebaseBucketUrl=FIREBASE_PROJECT_ID.appspot.com
ExternalIp=External IPv4 Address for the Windows VM/Local Machine
MeetingUid=Unique Firebase User ID

ZoomSense Docker Scheduler can be used to coordinate Windows Sensors if required. More details can be found under the ZoomSense Docker Scheduler Repository⁠.

⁠Building the Windows Sensor

If you need to build customized logic on top of the existing ZoomSense Windows Sensor, you can use the following steps to get started.

⁠Dependencies

Download and unzip the Zoom C# Wrapper SDK⁠ into the same directory.

⁠1. Restore NuGet Packages

Package Restore should happen automatically when opening the project. Navigate to Tools > Options > NuGet Package Manager for manual restore. For more information, please visit Restore Packages⁠.

⁠2. Build Solution

Build the solution to compile the project files and components for building the Docker image.

⁠3. Build Docker Image

Build the Docker Image⁠ from the Dockerfile in the directory with:

docker build [OPTIONS] PATH | URL | -

⁠4. Push Docker Image

Push the Docker Image⁠ to the registry with:

docker push [OPTIONS] NAME[:TAG]