From 2124a36cbf865ef66c4fc9d8e1f0feeeabdbd9f0 Mon Sep 17 00:00:00 2001
From: Antoine BERNIER <antoine.bernier@gmail.com>
Date: Thu, 5 Dec 2024 11:30:36 +0100
Subject: [PATCH] migration path

---
 docs/controls/face-controls.mdx | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

diff --git a/docs/controls/face-controls.mdx b/docs/controls/face-controls.mdx
index 1e03d8e94..d52de22c5 100644
--- a/docs/controls/face-controls.mdx
+++ b/docs/controls/face-controls.mdx
@@ -68,4 +68,25 @@ export type FaceControlsApi = THREE.EventDispatcher & {
   /** <Facemesh> ref api */
   facemeshApiRef: RefObject<FacemeshApi>
 }
-```
\ No newline at end of file
+```
+
+## Breaking changes
+
+### 9.120.0
+
+`FaceControls` was simplified.
+
+Following props were deleted:
+
+- `autostart`: now use `videoTexture.start`
+- `webcam`: instead of `webcam: false`, you can now [`manualDetect`](http://localhost:6006/?path=/story/controls-facecontrols--face-controls-st-2)
+- `webcamVideoTextureSrc`: now use `videoTexture.src` (or instantiate your own video-texture[^1] outside)
+- `onVideoFrame`: now use `videoTexture.onVideoFrame`  (or instantiate your own video-texture[^1] outside)
+
+Following api methods/fields were deleted:
+
+- `detect`: you can now [`manualDetect`](http://localhost:6006/?path=/story/controls-facecontrols--face-controls-st-2) outside and pass `faceLandmarkerResult`
+- `webcamApiRef`: if you need `videoTextureRef`, instantiate your own video-texture[^1] outside
+- `play`/`pause`: same, if you need the `video` object, instantiate your own video-texture[^1] outside
+
+[^1]: `<VideoTexture>` or `<WebcamVideoTexture>`
\ No newline at end of file