From 10646cfc2280ac5626efde6eaef2e599fa73e2d1 Mon Sep 17 00:00:00 2001 From: John Wallace Date: Sat, 5 Sep 2026 21:16:48 -0400 Subject: [PATCH] docs(site): align OBS plugin pages with current releases --- CLAUDE.md | 7 +++++ docs/CORE_PLUGIN_FUNCTIONALITY.md | 22 ++++++++----- docs/index.html | 46 +++++++++++++--------------- public/Support/index.html | 12 +++++--- public/core-plugin/index.html | 9 +++--- public/docs/index.html | 46 +++++++++++++--------------- public/documentation/index.html | 46 +++++++++++++--------------- public/download/index.html | 41 +++++++++++++++++++------ public/index.html | 6 ++-- public/zcomms/index.html | 2 +- scripts/build-site.mjs | 51 +++++++++++++++++++++++-------- wiki/Home.md | 25 ++++++--------- wiki/Support.md | 43 +++++++++++++++++++------- 13 files changed, 215 insertions(+), 141 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index 2f12932e..05d698b4 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -1488,3 +1488,10 @@ defect history that motivates their invariants, in the pattern you see in `src/audio-timeline.h`. Follow it: when a change is motivated by a live failure, say what happened, with numbers. Tests pin invariants, not implementations. + +## macOS website downloads (2026-09-06) + +The site builder keeps `MAC_VERSION` separate from the stable Windows version. +The macOS download is the locally signed/notarized `.pkg` on v0.1.45-beta.1; +its GitHub filename includes `v`. Do not restore the withdrawn macOS ZIP link. +Home, download, and plugin docs point to `/download/#macos`. diff --git a/docs/CORE_PLUGIN_FUNCTIONALITY.md b/docs/CORE_PLUGIN_FUNCTIONALITY.md index 2325d5be..9a1d66e0 100644 --- a/docs/CORE_PLUGIN_FUNCTIONALITY.md +++ b/docs/CORE_PLUGIN_FUNCTIONALITY.md @@ -4,8 +4,11 @@ This guide covers the main CoreVideo OBS plugin workflows. It intentionally focuses on the OBS plugin, `ZoomObsEngine`, Zoom source assignment, control APIs, audio routing, talkback, and ISO recording. -Current release: **v0.1.44**. Where a section describes something newer than -that, it says so. +Recommended Windows release: **v0.1.44**. macOS Apple Silicon beta: +**v0.1.45-beta.1**, available as a signed and notarized installer on the +[download page](https://corevideo.io/download/#macos). The beta also has Windows +assets; features newer than v0.1.44 are identified below. Talkback is unavailable +on macOS. The Mac package was built against OBS 32.2.1; use that version or newer. One naming quirk to get out of the way: the OBS **sources** this plugin registers are called `CoreVideo ...`, but its **docks and Tools menu entries** @@ -43,9 +46,10 @@ by OBS theme and platform, but the controls and labels should match the current plugin. This guide intentionally describes the OBS plugin path; optional Sidecar control-surface features are tracked separately in the roadmap. -The plugin registers five docks, each with a matching **Tools** menu entry that -focuses it: **Zoom Control**, **Zoom Output Manager**, **Zoom Diagnostics**, -**Zoom ISO Recorder**, and **Zoom Talkback**. **Tools > Zoom Plugin Settings** +The plugin docks each have a matching **Tools** menu entry that +focuses them: **Zoom Control**, **Zoom Output Manager**, **Zoom Diagnostics**, +**Zoom ISO Recorder**, and (in builds newer than v0.1.44) **Zoom Talkback**. +The Talkback dock is unavailable on macOS. **Tools > Zoom Plugin Settings** opens the settings dialog, which is where Zoom sign-in lives. ![CoreVideo OBS workspace with Zoom Control dock](images/corevideo-obs-workspace.svg) @@ -414,8 +418,9 @@ resumption does not click; and speech the far end never sent stays missing. ## Talkback (Intercom) -**Newer than v0.1.44.** The Talkback dock is on `main` and ships in the next -release; it is not in the v0.1.44 installer. +**Windows only, newer than v0.1.44.** The Talkback dock is included in the +Windows v0.1.45-beta.1 build. It is not in the recommended v0.1.44 installer, +and macOS does not implement talkback. Talkback is private director-to-talent audio carried over Zoom's own talkback channels - the operator can talk to one person, or to everyone, without the @@ -581,6 +586,9 @@ There are no Companion actions for talkback yet. ![CoreVideo ISO recording flow](images/iso-recording-flow.svg) ISO recording is controlled by the OBS plugin, not the engine. When enabled, +On macOS, configure and test a working FFmpeg executable in **Zoom ISO Recorder** +first; the package does not bundle FFmpeg. + CoreVideo records one video file and one PCM WAV audio file per active source segment. A new segment starts when the resolved participant or source resolution changes. diff --git a/docs/index.html b/docs/index.html index 54e55a38..967a6b3c 100644 --- a/docs/index.html +++ b/docs/index.html @@ -234,9 +234,9 @@

CoreVideo

๐Ÿงช Beta status
- CoreVideo is in public beta. The supported platform is - Windows x64 (installer or ZIP); macOS and Linux build from - source and ship no package + CoreVideo is in public beta. Packaged builds are available for + Windows x64 (installer or ZIP) and + macOS Apple Silicon (signed beta installer). Linux requires a source build (details) โ€” see the Roadmap for known limitations and what's planned next. To report a problem, use @@ -263,7 +263,7 @@

CoreVideo

Download for Windows -  macOS: build from source +  macOS beta installer  How to install
@@ -360,7 +360,7 @@

Features

ISO

Auto ISO Recording

Record assigned participant video/audio tracks to separate files while optionally recording the main OBS program output.

๐Ÿ’ป

Multi-Platform

-

Windows is the release channel. macOS and Linux build from source and ship no package (details), subject to local SDK and dependency setup.

+

Windows has a release installer; macOS has a signed Apple Silicon beta installer. Linux requires a source build.

@@ -446,25 +446,21 @@

Adding CoreVideo to your Zoom account

-

macOS: build from source

-

- There is no macOS package to download. Windows is the release channel; - macOS configures and builds from source, subject to local SDK and dependency setup. -

-
-
Why this page changed
- A one-off Apple Silicon preview was published against - v0.1.32-beta.1 and has not been maintained since โ€” every release after it - is Windows-only. This page previously told you to download the latest - macOS-arm64.zip from Releases; there isn't one, and the old preview is - many releases behind. If you are running it, treat it as unsupported. -
-

- To build on macOS, follow the source build in the - repository README. The engine is - portable and the mac port is developed on a branch, but nothing is packaged, signed, or - notarized, and there is no published date for when that changes. -

+

macOS: Apple Silicon beta

+

CoreVideo v0.1.45-beta.1 is available as a signed and notarized installer. + Requires an Apple Silicon Mac (M1 or later). Use OBS Studio 32.2.1 or newer for this beta; the replacement package was built against OBS 32.2.1.

+

Download the macOS installer and SHA-256 checksum.

+
    +
  1. Close OBS and open the downloaded .pkg.
    2. +
  2. Install for your user account; no administrator password is needed.
    3. +
  3. Reopen OBS, sign in to Zoom, and join a meeting. Allow the requested permissions. + The meeting host must grant recording permission before raw video and audio can start.
    4. +
+

The original macOS downloads were replaced on September 6, 2026 after signature errors. + Download the replacement installer if you previously downloaded this beta. The old ZIP was removed.

+

ISO recording requires a working FFmpeg executable configured in Zoom ISO Recorder; the macOS installer does not bundle it.

+

Talkback remains Windows-only. For your own screen, use OBS's native macOS Screen Capture source. + Intel Macs are not supported by this package.

@@ -501,7 +497,7 @@

3. Done

Requirements

- + diff --git a/public/Support/index.html b/public/Support/index.html index dd603516..475e3a72 100644 --- a/public/Support/index.html +++ b/public/Support/index.html @@ -34,7 +34,7 @@

Support

-

Current release: v0.1.44. Windows 10/11 x64 is the only supported, packaged platform - see Platform Support before filing a bug against a source build on anything else.

+

Recommended Windows release: v0.1.44. macOS Apple Silicon beta: v0.1.45-beta.1, signed and notarized. See Downloads for the correct package. Include your operating system, OBS version, and CoreVideo version with a bug report.

Documentation

Most configuration and architecture questions are answered on the documentation site:

/documentation/

@@ -44,18 +44,22 @@

What things are called

CoreVideo's OBS sources are named CoreVideo ..., but its docks and Tools menu entries are still named Zoom .... Both belong to this plugin. Searching the Tools menu for "CoreVideo" finds nothing.

RequirementNotes
Windows 10 / 11 (64-bit)Windows is the release channel (installer or ZIP). There is no macOS or Linux package โ€” both build from source; see macOS: build from source.
Windows 10 / 11 (64-bit)Windows is the release channel (installer or ZIP). A signed macOS Apple Silicon beta installer is also available. Linux requires a source build.
OBS Studio 30+Install OBS first; CoreVideo loads as a plugin.
A Zoom accountAny account you can sign in with. No developer account, SDK key, or client secret required.
Network bandwidthPlan roughly 4-6 Mbps per 1080p participant feed. Your Zoom account and app entitlements affect maximum quality and stream count (standard accounts are commonly limited to ~30 Mbps incoming video; Enhanced Media / HBM can raise that to ~100 Mbps).
Docks (View -> Docks, and Tools)Sources (Sources -> Add)
Zoom ControlCoreVideo Participant
Zoom Output ManagerCoreVideo Active Speaker
Zoom DiagnosticsCoreVideo Screen Share
Zoom ISO RecorderCoreVideo Tiles
Zoom TalkbackCoreVideo Participant Audio
(Tools only) Zoom Plugin SettingsCoreVideo Active Speaker Audio
CoreVideo Audience Audio (legacy)
Zoom Interpretation Audio
+

macOS installation and recording

+

Use the signed macOS installer, close OBS before installing, then reopen it. The replacement beta was built against OBS 32.2.1; use that version or newer. If an earlier copy reports a signature error, download the replacement package rather than disabling Gatekeeper. The plugin installs under ~/Library/Application Support/obs-studio/plugins/.

+

For ISO recording, select and test a working FFmpeg executable in Zoom ISO Recorder; FFmpeg is not included in the macOS package. If the engine requests recording permission, wait for the host to grant it and start raw media again. For your own screen, use OBS's macOS Screen Capture source.

Collecting logs

The support bundle - do this first

Open the Zoom Diagnostics dock (or Tools -> Zoom Diagnostics) and click Create Support Bundle. This is the single most useful thing you can attach to a bug report, and it is what the GitHub issue template asks for.

The bundle is written to:

%APPDATA%\obs-studio\plugin_config\obs-zoom-plugin\support-bundles\CoreVideo-support-<yyyyMMdd-HHmmss>\
+

On macOS, support bundles are under ~/Library/Application Support/obs-studio/plugin_config/obs-zoom-plugin/support-bundles/.

On Windows a .zip of that folder is created beside it, using PowerShell. The dialog tells you both paths when it finishes. If PowerShell is unavailable, or you are not on Windows, only the folder is written and you zip it yourself.

It contains summary.json, summary.txt, engine-status.json, settings-redacted.json, runtime-manifest.json, iso-recorder.json, and obs-latest.log - a redacted excerpt of the last 500 lines of the newest OBS log. Inside are the plugin version, meeting and engine state, the per-output table (assignment, requested/negotiated/observed resolution, fps, health), the participant roster, the last engine debug events, ISO recorder status, a manifest of the runtime files that are supposed to be installed, and a machine-readable failure_classifications list - values such as missing_runtime, auth_not_ready, no_video_frames, stale_feed, low_quality_feed, iso_encoder_error.

What is redacted: OAuth access and refresh tokens, ZAK/JWT values, client secrets, passcodes, the control-server token, and Authorization: headers, in the JSON and in the log excerpt. Secrets are reduced to a length and their last four characters, or to a presence flag.

What is not redacted: meeting and participant display names, participant IDs, and ISO recording file paths. Look through the bundle before attaching it to a public issue if any of that is sensitive.

The OBS log

CoreVideo has no log file of its own. Everything - plugin and engine alike - goes into the OBS log, prefixed [obs-zoom-plugin]. Engine lines arrive as [obs-zoom-plugin] Zoom engine debug: ....

-

In OBS: Help -> Log Files -> Upload Current Log File, then paste the link. The files themselves are under %APPDATA%\obs-studio\logs.

+

In OBS: Help -> Log Files -> Upload Current Log File, then paste the link. On Windows, logs are under %APPDATA%\obs-studio\logs. On macOS, use ~/Library/Application Support/obs-studio/logs.

The version is logged once at load, so check that first - a stale DLL is a common cause of "the fix didn't work":

[obs-zoom-plugin] Loading plugin v0.1.44

Verbose engine logging

@@ -115,7 +119,7 @@

Audio is ahead of the picture

Trim off air. Lowering a delay pushes the timestamp backward once and briefly glitches that source.

Talkback: the key says live but nobody hears me

-

The Zoom Talkback dock is new, and the failure modes are all silent in Zoom's own API.

+

This section applies to Windows builds with the Zoom Talkback dock, including v0.1.45-beta.1. Talkback is unavailable on macOS and absent from Windows v0.1.44. The failure modes can be silent in Zoom's own API.

Auto-reconnect triggers but never succeeds

@@ -134,7 +138,7 @@

TCP or OSC control API not responding

  1. Confirm the ports in Tools -> Zoom Plugin Settings match your client. Defaults are TCP 19870 and UDP OSC 19871.
  2. Both servers bind to 127.0.0.1 only. A control surface on another machine cannot reach them; put a local bridge on the OBS machine.
  3. Look for TCP control server unavailable or OSC server unavailable in the OBS log - another process may already own the port. Neither failure stops the plugin loading.
  4. If you set a token in settings, every TCP command line must carry a "token" field. With no token set, authentication is disabled and the plugin logs a warning saying so - the OSC server has no authentication at all either way. Both are loopback-only, but any local process can drive them.

Known limitations

- +

Zoom Bandwidth and Enhanced Media / HBM

CoreVideo does not require Enhanced Media / HBM simply to access Meeting SDK raw data. Quality and concurrency are still bounded by Zoom account and app entitlements:

diff --git a/public/core-plugin/index.html b/public/core-plugin/index.html index ed102176..0bacc4f2 100644 --- a/public/core-plugin/index.html +++ b/public/core-plugin/index.html @@ -35,7 +35,7 @@

Core Plugin Functionality

This guide covers the main CoreVideo OBS plugin workflows. It intentionally focuses on the OBS plugin, ZoomObsEngine, Zoom source assignment, control APIs, audio routing, talkback, and ISO recording.

-

Current release: v0.1.44. Where a section describes something newer than that, it says so.

+

Recommended Windows release: v0.1.44. macOS Apple Silicon beta: v0.1.45-beta.1, available as a signed and notarized installer on the download page. The beta also has Windows assets; features newer than v0.1.44 are identified below. Talkback is unavailable on macOS. The Mac package was built against OBS 32.2.1; use that version or newer.

One naming quirk to get out of the way: the OBS sources this plugin registers are called CoreVideo ..., but its docks and Tools menu entries are still called Zoom .... Both are this plugin.

Media Architecture

CoreVideo plugin media pipeline
@@ -44,7 +44,7 @@

Media Architecture

Current limitation (high feed counts): All video frames travel as CPU I420 through shared memory. At 8+ concurrent 1080p sources this creates substantial memory bandwidth pressure due to multiple per-subscription copies. See ROADMAP.md (Large-meeting capacity guidance) for exploration of GPU texture sharing (Spout on Windows, Syphon on macOS) as a lower-CPU alternative transport in the future.

What It Looks Like in OBS

The CoreVideo plugin is operated from inside OBS. These diagrams mirror the current core plugin controls: the Zoom Control dock, regular OBS scenes/sources, the Active Speaker Director controls, the dockable profile-oriented Zoom Output Manager, and the CoreVideo Participant source properties. Exact styling can vary by OBS theme and platform, but the controls and labels should match the current plugin. This guide intentionally describes the OBS plugin path; optional Sidecar control-surface features are tracked separately in the roadmap.

-

The plugin registers five docks, each with a matching Tools menu entry that focuses it: Zoom Control, Zoom Output Manager, Zoom Diagnostics, Zoom ISO Recorder, and Zoom Talkback. Tools > Zoom Plugin Settings opens the settings dialog, which is where Zoom sign-in lives.

+

The plugin docks each have a matching Tools menu entry that focuses them: Zoom Control, Zoom Output Manager, Zoom Diagnostics, Zoom ISO Recorder, and (in builds newer than v0.1.44) Zoom Talkback. The Talkback dock is unavailable on macOS. Tools > Zoom Plugin Settings opens the settings dialog, which is where Zoom sign-in lives.

CoreVideo OBS workspace with Zoom Control dock

The Zoom Control dock joins and leaves meetings, starts and stops raw media, shows meeting state, lists participants, exposes Active Speaker Director controls, and opens the Output Manager for source assignment without leaving OBS.

CoreVideo Output Manager
@@ -127,7 +127,7 @@

Delay and the measured A/V offset

Silence is a Zoom property, not a dropout

Zoom only calls audio back for a participant who is currently making sound, so a silent stretch produces no buffers at all rather than buffers of silence. Two consequences CoreVideo handles and one it cannot: the master clock resyncs rather than letting a quiet participant walk steadily into the past; the first buffer after a run of true digital silence is ramped in over a few milliseconds so the resumption does not click; and speech the far end never sent stays missing.

Talkback (Intercom)

-

Newer than v0.1.44. The Talkback dock is on main and ships in the next release; it is not in the v0.1.44 installer.

+

Windows only, newer than v0.1.44. The Talkback dock is included in the Windows v0.1.45-beta.1 build. It is not in the recommended v0.1.44 installer, and macOS does not implement talkback.

Talkback is private director-to-talent audio carried over Zoom's own talkback channels - the operator can talk to one person, or to everyone, without the meeting or the program mix hearing it. Open it from Tools > Zoom Talkback, or as the Zoom Talkback dock.

The dock is modelled on a Clear-Com/RTS intercom panel rather than on a list of settings: one grid, All talent across the top, then one compact cell per person. A cell is the talk key and the status display at the same time.

Assigning channels first

@@ -160,7 +160,8 @@

Companion / Stream Deck

There are no Companion actions for talkback yet.

Auto ISO Recording

CoreVideo ISO recording flow
-

ISO recording is controlled by the OBS plugin, not the engine. When enabled, CoreVideo records one video file and one PCM WAV audio file per active source segment. A new segment starts when the resolved participant or source resolution changes.

+

ISO recording is controlled by the OBS plugin, not the engine. When enabled, On macOS, configure and test a working FFmpeg executable in Zoom ISO Recorder first; the package does not bundle FFmpeg.

+

CoreVideo records one video file and one PCM WAV audio file per active source segment. A new segment starts when the resolved participant or source resolution changes.

Requirements:

OBS ISO Recorder Panel

diff --git a/public/docs/index.html b/public/docs/index.html index f0c2b9f4..4175ad83 100644 --- a/public/docs/index.html +++ b/public/docs/index.html @@ -251,9 +251,9 @@

CoreVideo

๐Ÿงช Beta status
- CoreVideo is in public beta. The supported platform is - Windows x64 (installer or ZIP); macOS and Linux build from - source and ship no package + CoreVideo is in public beta. Packaged builds are available for + Windows x64 (installer or ZIP) and + macOS Apple Silicon (signed beta installer). Linux requires a source build (details) โ€” see the Roadmap for known limitations and what's planned next. To report a problem, use @@ -280,7 +280,7 @@

CoreVideo

Download for Windows -  macOS: build from source +  macOS beta installer  How to install
@@ -377,7 +377,7 @@

Features

ISO

Auto ISO Recording

Record assigned participant video/audio tracks to separate files while optionally recording the main OBS program output.

๐Ÿ’ป

Multi-Platform

-

Windows is the release channel. macOS and Linux build from source and ship no package (details), subject to local SDK and dependency setup.

+

Windows has a release installer; macOS has a signed Apple Silicon beta installer. Linux requires a source build.

@@ -463,25 +463,21 @@

Adding CoreVideo to your Zoom account

-

macOS: build from source

-

- There is no macOS package to download. Windows is the release channel; - macOS configures and builds from source, subject to local SDK and dependency setup. -

-
-
Why this page changed
- A one-off Apple Silicon preview was published against - v0.1.32-beta.1 and has not been maintained since โ€” every release after it - is Windows-only. This page previously told you to download the latest - macOS-arm64.zip from Releases; there isn't one, and the old preview is - many releases behind. If you are running it, treat it as unsupported. -
-

- To build on macOS, follow the source build in the - repository README. The engine is - portable and the mac port is developed on a branch, but nothing is packaged, signed, or - notarized, and there is no published date for when that changes. -

+

macOS: Apple Silicon beta

+

CoreVideo v0.1.45-beta.1 is available as a signed and notarized installer. + Requires an Apple Silicon Mac (M1 or later). Use OBS Studio 32.2.1 or newer for this beta; the replacement package was built against OBS 32.2.1.

+

Download the macOS installer and SHA-256 checksum.

+
    +
  1. Close OBS and open the downloaded .pkg.
    2. +
  2. Install for your user account; no administrator password is needed.
    3. +
  3. Reopen OBS, sign in to Zoom, and join a meeting. Allow the requested permissions. + The meeting host must grant recording permission before raw video and audio can start.
    4. +
+

The original macOS downloads were replaced on September 6, 2026 after signature errors. + Download the replacement installer if you previously downloaded this beta. The old ZIP was removed.

+

ISO recording requires a working FFmpeg executable configured in Zoom ISO Recorder; the macOS installer does not bundle it.

+

Talkback remains Windows-only. For your own screen, use OBS's native macOS Screen Capture source. + Intel Macs are not supported by this package.

@@ -518,7 +514,7 @@

3. Done

Requirements

- + diff --git a/public/documentation/index.html b/public/documentation/index.html index f0c2b9f4..4175ad83 100644 --- a/public/documentation/index.html +++ b/public/documentation/index.html @@ -251,9 +251,9 @@

CoreVideo

๐Ÿงช Beta status
- CoreVideo is in public beta. The supported platform is - Windows x64 (installer or ZIP); macOS and Linux build from - source and ship no package + CoreVideo is in public beta. Packaged builds are available for + Windows x64 (installer or ZIP) and + macOS Apple Silicon (signed beta installer). Linux requires a source build (details) โ€” see the Roadmap for known limitations and what's planned next. To report a problem, use @@ -280,7 +280,7 @@

CoreVideo

Download for Windows -  macOS: build from source +  macOS beta installer  How to install
@@ -377,7 +377,7 @@

Features

ISO

Auto ISO Recording

Record assigned participant video/audio tracks to separate files while optionally recording the main OBS program output.

๐Ÿ’ป

Multi-Platform

-

Windows is the release channel. macOS and Linux build from source and ship no package (details), subject to local SDK and dependency setup.

+

Windows has a release installer; macOS has a signed Apple Silicon beta installer. Linux requires a source build.

@@ -463,25 +463,21 @@

Adding CoreVideo to your Zoom account

-

macOS: build from source

-

- There is no macOS package to download. Windows is the release channel; - macOS configures and builds from source, subject to local SDK and dependency setup. -

-
-
Why this page changed
- A one-off Apple Silicon preview was published against - v0.1.32-beta.1 and has not been maintained since โ€” every release after it - is Windows-only. This page previously told you to download the latest - macOS-arm64.zip from Releases; there isn't one, and the old preview is - many releases behind. If you are running it, treat it as unsupported. -
-

- To build on macOS, follow the source build in the - repository README. The engine is - portable and the mac port is developed on a branch, but nothing is packaged, signed, or - notarized, and there is no published date for when that changes. -

+

macOS: Apple Silicon beta

+

CoreVideo v0.1.45-beta.1 is available as a signed and notarized installer. + Requires an Apple Silicon Mac (M1 or later). Use OBS Studio 32.2.1 or newer for this beta; the replacement package was built against OBS 32.2.1.

+

Download the macOS installer and SHA-256 checksum.

+
    +
  1. Close OBS and open the downloaded .pkg.
    2. +
  2. Install for your user account; no administrator password is needed.
    3. +
  3. Reopen OBS, sign in to Zoom, and join a meeting. Allow the requested permissions. + The meeting host must grant recording permission before raw video and audio can start.
    4. +
+

The original macOS downloads were replaced on September 6, 2026 after signature errors. + Download the replacement installer if you previously downloaded this beta. The old ZIP was removed.

+

ISO recording requires a working FFmpeg executable configured in Zoom ISO Recorder; the macOS installer does not bundle it.

+

Talkback remains Windows-only. For your own screen, use OBS's native macOS Screen Capture source. + Intel Macs are not supported by this package.

@@ -518,7 +514,7 @@

3. Done

Requirements

RequirementNotes
Windows 10 / 11 (64-bit)Windows is the release channel (installer or ZIP). There is no macOS or Linux package โ€” both build from source; see macOS: build from source.
Windows 10 / 11 (64-bit)Windows is the release channel (installer or ZIP). A signed macOS Apple Silicon beta installer is also available. Linux requires a source build.
OBS Studio 30+Install OBS first; CoreVideo loads as a plugin.
A Zoom accountAny account you can sign in with. No developer account, SDK key, or client secret required.
Network bandwidthPlan roughly 4-6 Mbps per 1080p participant feed. Your Zoom account and app entitlements affect maximum quality and stream count (standard accounts are commonly limited to ~30 Mbps incoming video; Enhanced Media / HBM can raise that to ~100 Mbps).
- + diff --git a/public/download/index.html b/public/download/index.html index 48e6efe5..640c2e58 100644 --- a/public/download/index.html +++ b/public/download/index.html @@ -4,7 +4,7 @@ Download CoreVideo - Free Zoom Plugin for OBS Studio - + @@ -13,7 +13,7 @@ - + @@ -22,7 +22,7 @@ - + @@ -81,7 +81,7 @@

Install CoreVideo for OBS Studio.

Latest release v0.1.44 — Windows installer for OBS Studio 30 and newer. Free and open source under the MIT license.

Download for Windows — v0.1.44 - All releases & release notes + Windows release notes
@@ -92,21 +92,42 @@

Install CoreVideo for OBS Studio.

ZIP checksumSHA-256 for the portable archive.Companion moduleThe Bitfocus Companion module (corevideo-obs) ships with each release. Requires Companion v5 or newer. -

Requirements

+

Windows v0.1.44 remains the recommended release. The v0.1.45-beta.1 pre-release also has Windows assets with the newer Zoom Talkback dock; treat those as beta builds.

+
+

macOS — Apple Silicon beta v0.1.45-beta.1

+

Developer ID signed, notarized by Apple, and stapled. The replacement installer has passed installation on two Macs and an OBS runtime test on the build Mac.

+
+Download macOS installer (.pkg) +SHA-256 checksum +macOS release notes +
+

If you downloaded this beta before September 6, 2026, download it again. The original macOS package and ZIP were withdrawn after signature errors.

+

Requires an Apple Silicon Mac (M1 or later). The replacement package was built against OBS Studio 32.2.1; use that version or newer for this beta. Intel Macs are not supported by this package.

+
    +
  1. Close OBS, then open the downloaded .pkg.
    2. +
  2. Install for your user account. No administrator password is needed.
    3. +
  3. Reopen OBS, sign in to Zoom through CoreVideo, and join a meeting. Allow the requested permissions; the host must grant recording permission for media capture.
    4. +
+

For ISO recording, set a working FFmpeg executable in Zoom ISO Recorder and test it before recording. The macOS package does not bundle FFmpeg.

+

Talkback is Windows-only. For your own screen, use OBS's macOS Screen Capture source; CoreVideo receives other participants' shares.

+

To verify the download, save the installer and checksum in the same folder and run:

+
shasum -a 256 -c CoreVideo-Setup-v0.1.45-beta.1.pkg.sha256
+
+

Windows requirements

-

Install

+

Install on Windows

  1. Close OBS Studio.
  2. Run the installer and point it at your OBS installation directory if it is not detected automatically.
    3. -
  3. Start OBS and open Docks -> CoreVideo to sign in and join a meeting.
    4. -
  4. Add a CoreVideo source to any scene, then assign it to a participant, the active speaker, a spotlight slot, or the screen share.
    5. +
  5. Start OBS and open Tools -> Zoom Plugin Settings to sign in, then Docks -> Zoom Control to join a meeting.
    6. +
  6. Add a CoreVideo Participant source to any scene, then assign it to a participant, the active speaker, a spotlight slot, or the screen share.
-

The installer is not code-signed yet, so Windows SmartScreen warns the first time you run it — "More info", then "Run anyway". Verify the SHA-256 below if you would rather check the file than trust the dialog.

+

The Windows installer is not code-signed yet, so Windows SmartScreen warns the first time you run it — "More info", then "Run anyway". Verify the SHA-256 below if you would rather check the file than trust the dialog.

CoreVideo is in public beta. The Core Plugin Guide walks through participant routing, isolated audio, and ISO recording in detail, and Support covers log collection and reporting a bug.

Verify your download

Each release ships a SHA-256 file alongside the binary. On Windows, compare the hashes with PowerShell:

diff --git a/public/index.html b/public/index.html index 53c3f945..bde9e31b 100644 --- a/public/index.html +++ b/public/index.html @@ -81,6 +81,7 @@

Bring Zoom participants into OBS as native sources.

CoreVideo joins the meeting through the Zoom Meeting SDK and hands OBS each participant's own video and audio as a real source — no NDI, no virtual camera, no screen capture, and no second machine. Follow the active speaker, pin spotlight slots, take the screen share, and record every guest to an isolated file.

Download v0.1.44 for Windows + Download for macOS — Apple Silicon beta How it works View source
@@ -88,9 +89,10 @@

Bring Zoom participants into OBS as native sources.

One source per participantEach Zoom participant becomes a separate OBS source at up to 1080p, with their audio on its own track — not a crop out of a gallery screenshot.
+
CoreVideo TilesArrange participant feeds in a styled gallery within one OBS source, with rounded corners, borders, and flexible layouts.
Active speaker & spotlightPoint a source at whoever is talking, at Zoom spotlight slot 1…N, or at a fixed guest with an automatic failover if they drop.
Screen share & interpretationSubscribe to the live screen share, and pull existing Zoom interpretation audio channels in as dedicated sources.
-
ISO recordingRecord every assigned participant to their own muxed MP4 with matching PCM audio, alongside the main program recording.
+
ISO recordingRecord every assigned participant to an MP4 video file and a matching PCM WAV audio file, alongside the main program recording.
Active Speaker DirectorAn automatic take with a hold time, a sensitivity threshold, an exclusion list, and a “require video” rule — so the cut follows the conversation without chattering.
Output profilesThe Output Manager saves and reloads a whole assignment set, so last week’s routing comes back on the next show instead of being rebuilt by hand.
Stream Deck & CompanionA Bitfocus Companion module (v5 or newer) picks the output and the participant by name from the live roster, so a button keeps working after somebody rejoins.
@@ -103,7 +105,7 @@

Bring Zoom participants into OBS as native sources.

Talkback, without leaving the meeting

Every show that runs on Zoom eventually needs a way to speak to one person without speaking to the room. The Zoom Meeting SDK carries a private talkback path alongside the meeting floor — 16 channels, up to 10 people each, and members duck under your voice rather than being muted — and both products here are built on it.

-

ZComms is the standalone answer: a full intercom desk with named talk keys, ALL CALL, latch, extern feeds from a multichannel interface, and breakout-aware routing. It ships today. Inside the OBS plugin, an intercom dock that puts the same keys next to your video routing is in development on main and is not part of any release yet — when it lands it will be in a tagged build and in these notes, not before.

+

ZComms is the standalone answer: a full intercom desk with named talk keys, ALL CALL, latch, extern feeds from a multichannel interface, and breakout-aware routing. It ships today. The OBS plugin also has a Zoom Talkback dock in the Windows v0.1.45-beta.1 build. It is absent from the recommended Windows v0.1.44 release and unavailable on macOS. Use the download page to choose the appropriate release.

Free · OBS pluginCoreVideo for OBSThe plugin on this page: Zoom participant video, audio, screen share, interpretation, and ISO recording as native sources in the OBS you already run. MIT licensed. diff --git a/public/zcomms/index.html b/public/zcomms/index.html index 0a6070d9..e371bb38 100644 --- a/public/zcomms/index.html +++ b/public/zcomms/index.html @@ -159,7 +159,7 @@

Early software, honestly

Where it fits

ZComms and CoreVideo are separate products that came out of the same problem — running a real show inside somebody else's Zoom meeting — and they share the Zoom Meeting SDK and the same sign-in broker. ZComms is the standalone desk: it is what you run when the intercom is the job, on its own machine or beside a switcher that has nothing to do with Zoom.

-

The CoreVideo plugin is growing an intercom dock of its own so an operator already cutting a show in OBS can key talent without leaving it — that work is on main and has not shipped in a release yet. ZComms is the answer when talkback wants its own operator, its own position, or a feed from a bigger comms system, and it is the only one of the two you can download today.

+

The CoreVideo plugin includes a Zoom Talkback dock in its Windows v0.1.45-beta.1 build, for operators keying talent from OBS. The recommended Windows v0.1.44 release has no talkback, and macOS talkback is unavailable. ZComms provides a separate operator position and feeds from a larger comms system.

RequirementNotes
Windows 10 / 11 (64-bit)Windows is the release channel (installer or ZIP). There is no macOS or Linux package โ€” both build from source; see macOS: build from source.
Windows 10 / 11 (64-bit)Windows is the release channel (installer or ZIP). A signed macOS Apple Silicon beta installer is also available. Linux requires a source build.
OBS Studio 30+Install OBS first; CoreVideo loads as a plugin.
A Zoom accountAny account you can sign in with. No developer account, SDK key, or client secret required.
Network bandwidthPlan roughly 4-6 Mbps per 1080p participant feed. Your Zoom account and app entitlements affect maximum quality and stream count (standard accounts are commonly limited to ~30 Mbps incoming video; Enhanced Media / HBM can raise that to ~100 Mbps).
diff --git a/scripts/build-site.mjs b/scripts/build-site.mjs index 773b4451..9dfc268d 100644 --- a/scripts/build-site.mjs +++ b/scripts/build-site.mjs @@ -53,6 +53,10 @@ function latestReleaseVersion() { } const RELEASE_VERSION = latestReleaseVersion(); +// macOS betas are signed locally and published separately from Windows releases. +const MAC_VERSION = "0.1.45-beta.1"; +const MAC_RELEASE = `https://github.com/iamfatness/CoreVideo/releases/tag/v${MAC_VERSION}`; +const MAC_INSTALLER = `https://github.com/iamfatness/CoreVideo/releases/download/v${MAC_VERSION}/CoreVideo-Setup-v${MAC_VERSION}.pkg`; const RELEASES_LATEST = "https://github.com/iamfatness/CoreVideo/releases/latest"; // ZComms ships from its own repository, so this site cannot read its version @@ -219,6 +223,7 @@ function homeContent() {

CoreVideo joins the meeting through the Zoom Meeting SDK and hands OBS each participant's own video and audio as a real source — no NDI, no virtual camera, no screen capture, and no second machine. Follow the active speaker, pin spotlight slots, take the screen share, and record every guest to an isolated file.

Download${RELEASE_VERSION ? ` v${RELEASE_VERSION}` : ""} for Windows + Download for macOS — Apple Silicon beta How it works View source
@@ -226,9 +231,10 @@ function homeContent() {
One source per participantEach Zoom participant becomes a separate OBS source at up to 1080p, with their audio on its own track — not a crop out of a gallery screenshot.
+
CoreVideo TilesArrange participant feeds in a styled gallery within one OBS source, with rounded corners, borders, and flexible layouts.
Active speaker & spotlightPoint a source at whoever is talking, at Zoom spotlight slot 1…N, or at a fixed guest with an automatic failover if they drop.
Screen share & interpretationSubscribe to the live screen share, and pull existing Zoom interpretation audio channels in as dedicated sources.
-
ISO recordingRecord every assigned participant to their own muxed MP4 with matching PCM audio, alongside the main program recording.
+
ISO recordingRecord every assigned participant to an MP4 video file and a matching PCM WAV audio file, alongside the main program recording.
Active Speaker DirectorAn automatic take with a hold time, a sensitivity threshold, an exclusion list, and a “require video” rule — so the cut follows the conversation without chattering.
Output profilesThe Output Manager saves and reloads a whole assignment set, so last week’s routing comes back on the next show instead of being rebuilt by hand.
Stream Deck & CompanionA Bitfocus Companion module (v5 or newer) picks the output and the participant by name from the live roster, so a button keeps working after somebody rejoins.
@@ -241,7 +247,7 @@ function homeContent() {

Talkback, without leaving the meeting

Every show that runs on Zoom eventually needs a way to speak to one person without speaking to the room. The Zoom Meeting SDK carries a private talkback path alongside the meeting floor — 16 channels, up to 10 people each, and members duck under your voice rather than being muted — and both products here are built on it.

-

ZComms is the standalone answer: a full intercom desk with named talk keys, ALL CALL, latch, extern feeds from a multichannel interface, and breakout-aware routing. It ships today. Inside the OBS plugin, an intercom dock that puts the same keys next to your video routing is in development on main and is not part of any release yet — when it lands it will be in a tagged build and in these notes, not before.

+

ZComms is the standalone answer: a full intercom desk with named talk keys, ALL CALL, latch, extern feeds from a multichannel interface, and breakout-aware routing. It ships today. The OBS plugin also has a Zoom Talkback dock in the Windows v0.1.45-beta.1 build. It is absent from the recommended Windows v0.1.44 release and unavailable on macOS. Use the download page to choose the appropriate release.

Free · OBS pluginCoreVideo for OBSThe plugin on this page: Zoom participant video, audio, screen share, interpretation, and ISO recording as native sources in the OBS you already run. MIT licensed. @@ -522,7 +528,7 @@ function zcommsPageContent() {

Where it fits

ZComms and CoreVideo are separate products that came out of the same problem — running a real show inside somebody else's Zoom meeting — and they share the Zoom Meeting SDK and the same sign-in broker. ZComms is the standalone desk: it is what you run when the intercom is the job, on its own machine or beside a switcher that has nothing to do with Zoom.

-

The CoreVideo plugin is growing an intercom dock of its own so an operator already cutting a show in OBS can key talent without leaving it — that work is on main and has not shipped in a release yet. ZComms is the answer when talkback wants its own operator, its own position, or a feed from a bigger comms system, and it is the only one of the two you can download today.

+

The CoreVideo plugin includes a Zoom Talkback dock in its Windows v0.1.45-beta.1 build, for operators keying talent from OBS. The recommended Windows v0.1.44 release has no talkback, and macOS talkback is unavailable. ZComms provides a separate operator position and feeds from a larger comms system.

ProductForm factorTalkback
@@ -773,26 +779,47 @@ function downloadPageContent() { ${versionNote}
${primaryLabel} - All releases & release notes + Windows release notes
${fileRows} -

Requirements

+

Windows v0.1.44 remains the recommended release. The v0.1.45-beta.1 pre-release also has Windows assets with the newer Zoom Talkback dock; treat those as beta builds.

+
+

macOS — Apple Silicon beta v${MAC_VERSION}

+

Developer ID signed, notarized by Apple, and stapled. The replacement installer has passed installation on two Macs and an OBS runtime test on the build Mac.

+
+Download macOS installer (.pkg) +SHA-256 checksum +macOS release notes +
+

If you downloaded this beta before September 6, 2026, download it again. The original macOS package and ZIP were withdrawn after signature errors.

+

Requires an Apple Silicon Mac (M1 or later). The replacement package was built against OBS Studio 32.2.1; use that version or newer for this beta. Intel Macs are not supported by this package.

+
    +
  1. Close OBS, then open the downloaded .pkg.
    2. +
  2. Install for your user account. No administrator password is needed.
    3. +
  3. Reopen OBS, sign in to Zoom through CoreVideo, and join a meeting. Allow the requested permissions; the host must grant recording permission for media capture.
    4. +
+

For ISO recording, set a working FFmpeg executable in Zoom ISO Recorder and test it before recording. The macOS package does not bundle FFmpeg.

+

Talkback is Windows-only. For your own screen, use OBS's macOS Screen Capture source; CoreVideo receives other participants' shares.

+

To verify the download, save the installer and checksum in the same folder and run:

+
shasum -a 256 -c CoreVideo-Setup-v${MAC_VERSION}.pkg.sha256
+
+

Windows requirements

-

Install

+

Install on Windows

  1. Close OBS Studio.
  2. Run the installer and point it at your OBS installation directory if it is not detected automatically.
    3. -
  3. Start OBS and open Docks -> CoreVideo to sign in and join a meeting.
    4. -
  4. Add a CoreVideo source to any scene, then assign it to a participant, the active speaker, a spotlight slot, or the screen share.
    5. +
  5. Start OBS and open Tools -> Zoom Plugin Settings to sign in, then Docks -> Zoom Control to join a meeting.
    6. +
  6. Add a CoreVideo Participant source to any scene, then assign it to a participant, the active speaker, a spotlight slot, or the screen share.
-

The installer is not code-signed yet, so Windows SmartScreen warns the first time you run it — "More info", then "Run anyway". Verify the SHA-256 below if you would rather check the file than trust the dialog.

+

The Windows installer is not code-signed yet, so Windows SmartScreen warns the first time you run it — "More info", then "Run anyway". Verify the SHA-256 below if you would rather check the file than trust the dialog.

CoreVideo is in public beta. The Core Plugin Guide walks through participant routing, isolated audio, and ISO recording in detail, and Support covers log collection and reporting a bug.

Verify your download

Each release ships a SHA-256 file alongside the binary. On Windows, compare the hashes with PowerShell:

@@ -970,8 +997,8 @@ writeText( title: "Download", seoTitle: "Download CoreVideo - Free Zoom Plugin for OBS Studio", description: RELEASE_VERSION - ? `Download CoreVideo v${RELEASE_VERSION}, the free open-source OBS Studio plugin for Zoom. Windows installer, checksums, requirements, and install steps.` - : "Download CoreVideo, the free open-source OBS Studio plugin for Zoom. Windows installer, checksums, requirements, and install steps.", + ? `Download CoreVideo v${RELEASE_VERSION}, the free open-source OBS Studio plugin for Zoom. Windows and macOS installers, checksums, and setup.` + : "Download CoreVideo, the free open-source OBS Studio plugin for Zoom. Windows and macOS installers, checksums, and setup.", }, downloadPageContent(), { diff --git a/wiki/Home.md b/wiki/Home.md index 04fe66ea..161d83b5 100644 --- a/wiki/Home.md +++ b/wiki/Home.md @@ -2,8 +2,8 @@ CoreVideo is an OBS Studio plugin that pulls Zoom meeting video, audio, screen share, and Zoom interpretation audio into OBS as native sources - no NDI, no -virtual camera, no screen capture of a Zoom window. Latest release: **v0.1.44** -(2026-08-22). +virtual camera, no screen capture of a Zoom window. Recommended Windows release: **v0.1.44**; macOS Apple Silicon beta: **v0.1.45-beta.1** +(replacement installer published September 6, 2026). This wiki holds the policy and support pages. Everything operational - install, configuration, architecture, the control APIs - lives on the documentation site, @@ -43,20 +43,15 @@ the two. ## Platform status -**Windows 10/11 x64 is the only supported, packaged platform.** It is the only -configuration with a release pipeline, and the only one the maintainers build, -test, and run in production. +**Windows 10/11 x64 and macOS Apple Silicon have packaged builds.** Windows +uses the stable release channel; macOS v0.1.45-beta.1 is a public beta with a +Developer ID signed, notarized installer. [Download and install](https://corevideo.io/download/#macos). +The original macOS package was replaced on September 6, 2026 after signature +errors; download the replacement if you already have an earlier copy. Intel +Macs are not supported by this package, and Linux requires a source build. -The CMake project configures on macOS, Linux, and Windows arm64, and CI compiles -the cross-platform sources on macOS and Linux to catch portability regressions - -but none of those produce an installable build. The one macOS bundle ever -published was `v0.1.32-beta.1`, which is many releases behind and should not be -used for a show. See -[Platform Support](https://github.com/iamfatness/CoreVideo/blob/main/README.md#platform-support) -for what a source build on those platforms does and does not get you. - -CoreVideo is in public beta and the installer is not code-signed yet, so Windows -SmartScreen flags it on first run. +CoreVideo is in public beta. The Windows installer is not code-signed yet, +so Windows SmartScreen flags it on first run. --- diff --git a/wiki/Support.md b/wiki/Support.md index 01ed8d27..1ba4f5dc 100644 --- a/wiki/Support.md +++ b/wiki/Support.md @@ -1,8 +1,9 @@ # Support -Current release: **v0.1.44**. Windows 10/11 x64 is the only supported, packaged -platform - see [Platform Support](https://github.com/iamfatness/CoreVideo/blob/main/README.md#platform-support) -before filing a bug against a source build on anything else. +Recommended Windows release: **v0.1.44**. macOS Apple Silicon beta: +**v0.1.45-beta.1**, signed and notarized. See [Downloads](https://corevideo.io/download/) +for the correct package. Include your operating system, OBS version, and +CoreVideo version with a bug report. ## Documentation @@ -47,6 +48,19 @@ the Tools menu for "CoreVideo" finds nothing. --- +## macOS installation and recording + +Use the [signed macOS installer](https://corevideo.io/download/#macos), close OBS +before installing, then reopen it. The replacement beta was built against +OBS 32.2.1; use that version or newer. If an earlier copy reports a signature +error, download the replacement package rather than disabling Gatekeeper. +The plugin installs under `~/Library/Application Support/obs-studio/plugins/`. + +For ISO recording, select and test a working FFmpeg executable in +**Zoom ISO Recorder**; FFmpeg is not included in the macOS package. If the engine +requests recording permission, wait for the host to grant it and start raw +media again. For your own screen, use OBS's macOS Screen Capture source. + ## Collecting logs ### The support bundle - do this first @@ -61,6 +75,9 @@ The bundle is written to: %APPDATA%\obs-studio\plugin_config\obs-zoom-plugin\support-bundles\CoreVideo-support-\ ``` +On macOS, support bundles are under +`~/Library/Application Support/obs-studio/plugin_config/obs-zoom-plugin/support-bundles/`. + On Windows a `.zip` of that folder is created beside it, using PowerShell. The dialog tells you both paths when it finishes. If PowerShell is unavailable, or you are not on Windows, only the folder is written and you zip it yourself. @@ -92,7 +109,8 @@ goes into the OBS log, prefixed `[obs-zoom-plugin]`. Engine lines arrive as `[obs-zoom-plugin] Zoom engine debug: ...`. In OBS: **Help -> Log Files -> Upload Current Log File**, then paste the link. -The files themselves are under `%APPDATA%\obs-studio\logs`. +On Windows, logs are under `%APPDATA%\obs-studio\logs`. On macOS, use +`~/Library/Application Support/obs-studio/logs`. The version is logged once at load, so check that first - a stale DLL is a common cause of "the fix didn't work": @@ -318,8 +336,9 @@ glitches that source. ### Talkback: the key says live but nobody hears me -The Zoom Talkback dock is new, and the failure modes are all silent in Zoom's -own API. +This section applies to Windows builds with the Zoom Talkback dock, including +v0.1.45-beta.1. Talkback is unavailable on macOS and absent from Windows v0.1.44. +The failure modes can be silent in Zoom's own API. - **The banner reads "ON AIR - BOT MUTED".** Zoom refused to unmute CoreVideo's microphone, and sends are accepted while delivering nothing. Ask the host to @@ -415,17 +434,19 @@ bandwidth tier, not as a hard prerequisite for raw data. - **v0.1.43 was built and verified but never published.** Anyone tracking releases goes from v0.1.42 straight to v0.1.44, which contains both. -- **The installer is not code-signed**, so Windows SmartScreen flags it on first +- **The Windows installer is not code-signed**, so Windows SmartScreen flags it on first run. - **The embedded audio track** on a video source has no loss accounting and is stamped at arrival. Use the dedicated CoreVideo Audio sources for critical audio. -- **The intercom / talkback dock is newer than v0.1.44** and is not in a tagged - release yet. It is on `main` and ships next. Talkback has no OSC addresses, +- **The intercom / talkback dock is in the Windows v0.1.45-beta.1 build.** + It is absent from Windows v0.1.44 and unavailable on macOS. Talkback has no OSC addresses, no Companion actions, and no OBS hotkey yet - the dock and the TCP control API are the only keying surfaces. -- **macOS and Linux are source-build only.** There are no official packages, no - QA, and no supported upgrade path. +- **macOS Apple Silicon has a signed and notarized beta installer.** Use the + [replacement package](https://corevideo.io/download/#macos) published September 6, + 2026 if an earlier download reports a signature error. Talkback remains + Windows-only. Intel Macs have no package; Linux requires a source build. - **`COREVIDEO_TALKBACK_LAYOUT_TEST`** is a developer instrument that fills the Talkback dock with a fake cast and refuses every engine call. Never set it on a show machine.
ProductForm factorTalkback