From 71f903268162fc47e668c2e1a5e96170efc2d90c Mon Sep 17 00:00:00 2001
From: leo <260626284+cameledev@users.noreply.github.com>
Date: Wed, 2 Sep 2026 14:00:32 +0200
Subject: [PATCH] update upgrade.md to reflect options

---
 UPGRADE.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/UPGRADE.md b/UPGRADE.md
index 7ba28e51..7fe96f1e 100644
--- a/UPGRADE.md
+++ b/UPGRADE.md
@@ -93,6 +93,28 @@ Both maps are validated at startup and a malformed one raises a `ValueError`:
 - `RECORDING_ENCODING_DEFAULT_RESOLUTION` and `RECORDING_ENCODING_DEFAULT_PROFILE`,
   when non-empty, must be keys of their respective map.
 
+#### Breaking: custom worker services must accept `encoding_options`
+
+Only concerns deployments pointing `RECORDING_WORKER_CLASSES` at their own worker
+class. The shipped `VideoCompositeEgressService` and `AudioCompositeEgressService`
+are already updated.
+
+The `WorkerService` protocol's `start()` takes a third argument, and the mediator
+now always passes it as a keyword when the recording carries no per-recording encoding:
+
+```python
+# before
+def start(self, room_id: str, recording_id: str) -> str: ...
+
+# now
+def start(
+    self,
+    room_id: str,
+    recording_id: str,
+    encoding_options: Optional[Dict[str, Any]] = None,
+) -> str: ...
+```
+
 #### Optional: per-recording encoding
 
 `RECORDING_CUSTOM_ENCODING_ENABLED` (default `False`) toggles whether the