Fix for comments

aws · May 6, 2024 · 6e287b1 · 6e287b1
1 parent dd2c3ac
commit 6e287b1
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 15 deletions.
diff --git a/docs/classes/videoadaptiveprobepolicy.html b/docs/classes/videoadaptiveprobepolicy.html
@@ -71,13 +71,6 @@ <h1>Class VideoAdaptiveProbePolicy</h1>
 						<p><a href="videoadaptiveprobepolicy.html">VideoAdaptiveProbePolicy</a> wraps <a href="videoprioritybasedpolicy.html">VideoPriorityBasedPolicy</a> with customized behavior to automatically
 						assign a high preference to content share.</p>
 					</div>
-					<dl class="tsd-comment-tags">
-						<dt>deprecated</dt>
-						<dd><p>This class is not compatible with latest priority policy features (i.e. server side network adaptation),
-								<a href="videoprioritybasedpolicy.html">VideoPriorityBasedPolicy</a> should be used instead. If high priority for content is desired it can be done trivially
-							by the application.</p>
-						</dd>
-					</dl>
 				</div>
 			</section>
 			<section class="tsd-panel tsd-hierarchy">
@@ -157,7 +150,7 @@ <h3>constructor</h3>
 							<aside class="tsd-sources">
 								<p>Overrides <a href="videoprioritybasedpolicy.html">VideoPriorityBasedPolicy</a>.<a href="videoprioritybasedpolicy.html#constructor">constructor</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoAdaptiveProbePolicy.ts#L26">src/videodownlinkbandwidthpolicy/VideoAdaptiveProbePolicy.ts:26</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoAdaptiveProbePolicy.ts#L22">src/videodownlinkbandwidthpolicy/VideoAdaptiveProbePolicy.ts:22</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -369,7 +362,7 @@ <h3>choose<wbr>Remote<wbr>Video<wbr>Sources</h3>
 							<aside class="tsd-sources">
 								<p>Overrides <a href="videoprioritybasedpolicy.html">VideoPriorityBasedPolicy</a>.<a href="videoprioritybasedpolicy.html#chooseremotevideosources">chooseRemoteVideoSources</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoAdaptiveProbePolicy.ts#L73">src/videodownlinkbandwidthpolicy/VideoAdaptiveProbePolicy.ts:73</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoAdaptiveProbePolicy.ts#L69">src/videodownlinkbandwidthpolicy/VideoAdaptiveProbePolicy.ts:69</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -570,7 +563,7 @@ <h3>reset</h3>
 							<aside class="tsd-sources">
 								<p>Overrides <a href="videoprioritybasedpolicy.html">VideoPriorityBasedPolicy</a>.<a href="videoprioritybasedpolicy.html#reset">reset</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoAdaptiveProbePolicy.ts#L34">src/videodownlinkbandwidthpolicy/VideoAdaptiveProbePolicy.ts:34</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoAdaptiveProbePolicy.ts#L30">src/videodownlinkbandwidthpolicy/VideoAdaptiveProbePolicy.ts:30</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -714,7 +707,7 @@ <h3>update<wbr>Index</h3>
 							<aside class="tsd-sources">
 								<p>Overrides <a href="videoprioritybasedpolicy.html">VideoPriorityBasedPolicy</a>.<a href="videoprioritybasedpolicy.html#updateindex">updateIndex</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoAdaptiveProbePolicy.ts#L40">src/videodownlinkbandwidthpolicy/VideoAdaptiveProbePolicy.ts:40</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videodownlinkbandwidthpolicy/VideoAdaptiveProbePolicy.ts#L36">src/videodownlinkbandwidthpolicy/VideoAdaptiveProbePolicy.ts:36</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">

diff --git a/src/videodownlinkbandwidthpolicy/VideoAdaptiveProbePolicy.ts b/src/videodownlinkbandwidthpolicy/VideoAdaptiveProbePolicy.ts
@@ -13,10 +13,6 @@ import VideoPriorityBasedPolicyConfig from './VideoPriorityBasedPolicyConfig';
 
 /** [[VideoAdaptiveProbePolicy]] wraps [[VideoPriorityBasedPolicy]] with customized behavior to automatically
  * assign a high preference to content share.
- *
- * @deprecated This class is not compatible with latest priority policy features (i.e. server side network adaptation),
- * [[VideoPriorityBasedPolicy]] should be used instead. If high priority for content is desired it can be done trivially
- * by the application.
  */
 export default class VideoAdaptiveProbePolicy extends VideoPriorityBasedPolicy {
   private static createConfig(): VideoPriorityBasedPolicyConfig {
@@ -26,6 +22,8 @@ export default class VideoAdaptiveProbePolicy extends VideoPriorityBasedPolicy {
   }
 
   constructor(protected logger: Logger) {
+    // We use a static function to create config because Typescript requires
+    // super(...) calls to be the first line in constructors
     super(logger, VideoAdaptiveProbePolicy.createConfig());
     super.shouldPauseTiles = false;
     this.videoPreferences = undefined;