Update unbindVideoElement documentation

aws · May 11, 2022 · 0512687 · 0512687
1 parent c5639ba
commit 0512687
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,7 +15,7 @@ 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
@@ -679,7 +679,7 @@ <h3>unbind<wbr>Video<wbr>Element</h3>
 							<div class="tsd-comment tsd-typography">
 								<div class="lead">
 									<p>Unbinds the video element from the tile if it exists for the provided tileId.
-										The video tile&#39;s bounded video element and that element&#39;s width and height are set to null.
+										The video tile&#39;s bounded video element, that element&#39;s srcObject, width and height are set to null.
 										This does not remove the provided tileId mapping from the tile map in the <a href="../classes/defaultvideotilecontroller.html">DefaultVideoTileController</a>.
 									To remove the mapping and destroy the tile for this tileId, you can use <a href="videotilecontroller.html#removevideotile">removeVideoTile</a>.</p>
 								</div>

diff --git 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]].
    */