web/video.js
1
0
Fork 0
mirror of https://github.com/videojs/video.js.git synced 2025-03-17 21:18:27 +02:00
Code Releases Activity

docs(player): fix addRemoteTextTrack description of manualCleanup option (#6521)

Browse Source
This commit is contained in:
Gary Katsevman 2020-03-12 11:50:43 -04:00 committed by GitHub
parent 52c181ddb0
commit d1702d5e45
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/js/player.js
View File

@ -4041,15 +4041,16 @@ class Player extends Component {
}
/**
* Create a remote {@link TextTrack} and an {@link HTMLTrackElement}. It will
* automatically removed from the video element whenever the source changes, unless
* manualCleanup is set to false.
* Create a remote {@link TextTrack} and an {@link HTMLTrackElement}.
* When manualCleanup is set to false, the track will be automatically removed
* on source changes.
*
* @param {Object} options
* Options to pass to {@link HTMLTrackElement} during creation. See
* {@link HTMLTrackElement} for object properties that you should use.
*
* @param {boolean} [manualCleanup=true] if set to false, the TextTrack will be
* removed on a source change
*
* @return {HtmlTrackElement}
* the HTMLTrackElement that was created and added