Update iframe-functions.md

New function see, jitsi/jitsi-meet#15324
jitsi · Dec 16, 2024 · 1ac29f2 · 1ac29f2
1 parent 82bebbf
commit 1ac29f2
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/docs/dev-guide/iframe-functions.md b/docs/dev-guide/iframe-functions.md
@@ -301,6 +301,18 @@ Sets the video input device to the one with the passed label or ID.
 api.setVideoInputDevice(deviceLabel, deviceId);
 ```
 
+### setVirtualBackground
+
+Set your virtual background with a base64 image.
+
+```javascript
+/**
+ * @param {boolean} enabled - Enable or disable the virtual background.
+ * @param {string} backgroundImage - Base64 image string, eg. "data:image/png;base64, iVBOR...".
+ */
+api.setVirtualBackground(enabled, backgroundImage);
+```
+
 ### startRecording
 
 Starts a file recording or streaming session. See the `startRecording` command for more details.