From 1fe4a5c28dcd0ec4c63faa915cf2d38cdc22c8ce Mon Sep 17 00:00:00 2001 From: Venkatesh Devale Date: Wed, 11 May 2022 09:30:32 -0700 Subject: [PATCH] Update unbindVideoElement documentation --- CHANGELOG.md | 3 ++- docs/interfaces/videotilecontroller.html | 2 +- src/videotilecontroller/VideoTileController.ts | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d93724a9e3..ff1cd64798 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -15,7 +15,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Removed ### Changed -- Clear srcObject in unbindVideoElement API. + +- Clean up the HTML video element bound using `bindVideoElement` as part of `unbindVideoElement` API to fix Safari memory leak. Check [PR#2217](https://github.com/aws/amazon-chime-sdk-js/pull/2217) for detailed information. ### Fixed - Fix issue where video resolution and framerate changes when toggle video transform. diff --git a/docs/interfaces/videotilecontroller.html b/docs/interfaces/videotilecontroller.html index 8f8033d216..d29543b9d1 100644 --- a/docs/interfaces/videotilecontroller.html +++ b/docs/interfaces/videotilecontroller.html @@ -679,7 +679,7 @@

unbindVideoElement

Unbinds the video element from the tile if it exists for the provided tileId. - The video tile's bounded video element and that element's width and height are set to null. + The video tile's bounded video element, that element's srcObject, width and height are set to null. This does not remove the provided tileId mapping from the tile map in the DefaultVideoTileController. To remove the mapping and destroy the tile for this tileId, you can use removeVideoTile.

diff --git a/src/videotilecontroller/VideoTileController.ts b/src/videotilecontroller/VideoTileController.ts index 203c0e71e8..16f9bc4205 100644 --- a/src/videotilecontroller/VideoTileController.ts +++ b/src/videotilecontroller/VideoTileController.ts @@ -22,7 +22,7 @@ export default interface VideoTileController { /** * Unbinds the video element from the tile if it exists for the provided tileId. - * The video tile's bounded video element and that element's width and height are set to null. + * The video tile's bounded video element, that element's srcObject, width and height are set to null. * This does not remove the provided tileId mapping from the tile map in the [[DefaultVideoTileController]]. * To remove the mapping and destroy the tile for this tileId, you can use [[removeVideoTile]]. */