Skip to content

Commit

Permalink
Block background throttling of video processing (#2747)
Browse files Browse the repository at this point in the history
---------

Co-authored-by: Henry Smith <hensmi@amazon.com>
  • Loading branch information
hunnorth and hensmi-amazon authored Nov 2, 2023
1 parent faa2462 commit 9c54b6f
Show file tree
Hide file tree
Showing 16 changed files with 3,008 additions and 2,232 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Fixed

- Do not display a warning message when invoking `meetingSession.audioVideo.setVideoCodecSendPreferences` prior to the start of the session.
- Prevent video processing with filters from being throttled when an attendees meeting tab moves into the background.

## [3.16.0] - 2023-06-26

Expand Down
4,426 changes: 2,226 additions & 2,200 deletions docs/assets/js/search.js

Large diffs are not rendered by default.

33 changes: 18 additions & 15 deletions docs/classes/defaultvideoframeprocessorpipeline.html
Original file line number Diff line number Diff line change
Expand Up @@ -133,13 +133,13 @@ <h2>Constructors</h2>
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Default<wbr>Video<wbr>Frame<wbr>Processor<wbr>Pipeline<span class="tsd-signature-symbol">(</span>logger<span class="tsd-signature-symbol">: </span><a href="../interfaces/logger.html" class="tsd-signature-type" data-tsd-kind="Interface">Logger</a>, stages<span class="tsd-signature-symbol">: </span><a href="../interfaces/videoframeprocessor.html" class="tsd-signature-type" data-tsd-kind="Interface">VideoFrameProcessor</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="defaultvideoframeprocessorpipeline.html" class="tsd-signature-type" data-tsd-kind="Class">DefaultVideoFrameProcessorPipeline</a></li>
<li class="tsd-signature tsd-kind-icon">new <wbr>Default<wbr>Video<wbr>Frame<wbr>Processor<wbr>Pipeline<span class="tsd-signature-symbol">(</span>logger<span class="tsd-signature-symbol">: </span><a href="../interfaces/logger.html" class="tsd-signature-type" data-tsd-kind="Interface">Logger</a>, stages<span class="tsd-signature-symbol">: </span><a href="../interfaces/videoframeprocessor.html" class="tsd-signature-type" data-tsd-kind="Interface">VideoFrameProcessor</a><span class="tsd-signature-symbol">[]</span>, timer<span class="tsd-signature-symbol">?: </span><a href="../interfaces/videoframeprocessortimer.html" class="tsd-signature-type" data-tsd-kind="Interface">VideoFrameProcessorTimer</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="defaultvideoframeprocessorpipeline.html" class="tsd-signature-type" data-tsd-kind="Class">DefaultVideoFrameProcessorPipeline</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts#L47">src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts:47</a></li>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts#L49">src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts:49</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -150,6 +150,9 @@ <h5>logger: <a href="../interfaces/logger.html" class="tsd-signature-type" data-
<li>
<h5>stages: <a href="../interfaces/videoframeprocessor.html" class="tsd-signature-type" data-tsd-kind="Interface">VideoFrameProcessor</a><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li>
<h5>timer: <a href="../interfaces/videoframeprocessortimer.html" class="tsd-signature-type" data-tsd-kind="Interface">VideoFrameProcessorTimer</a><span class="tsd-signature-symbol"> = ...</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="defaultvideoframeprocessorpipeline.html" class="tsd-signature-type" data-tsd-kind="Class">DefaultVideoFrameProcessorPipeline</a></h4>
</li>
Expand All @@ -165,7 +168,7 @@ <h3>output<wbr>Media<wbr>Stream</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/videoframeprocessorpipeline.html">VideoFrameProcessorPipeline</a>.<a href="../interfaces/videoframeprocessorpipeline.html#outputmediastream">outputMediaStream</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts#L27">src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts:27</a></li>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts#L29">src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts:29</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -190,7 +193,7 @@ <h3>framerate</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/videoframeprocessorpipeline.html">VideoFrameProcessorPipeline</a>.<a href="../interfaces/videoframeprocessorpipeline.html#framerate">framerate</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts#L60">src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts:60</a></li>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts#L69">src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts:69</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -204,7 +207,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</s
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/videoframeprocessorpipeline.html">VideoFrameProcessorPipeline</a>.<a href="../interfaces/videoframeprocessorpipeline.html#framerate">framerate</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts#L66">src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts:66</a></li>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts#L75">src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts:75</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -234,7 +237,7 @@ <h3>processors</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/videoframeprocessorpipeline.html">VideoFrameProcessorPipeline</a>.<a href="../interfaces/videoframeprocessorpipeline.html#processors">processors</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts#L189">src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts:189</a></li>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts#L193">src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts:193</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -248,7 +251,7 @@ <h4 class="tsd-returns-title">Returns <a href="../interfaces/videoframeprocessor
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/videoframeprocessorpipeline.html">VideoFrameProcessorPipeline</a>.<a href="../interfaces/videoframeprocessorpipeline.html#processors">processors</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts#L185">src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts:185</a></li>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts#L189">src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts:189</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -280,7 +283,7 @@ <h3>add<wbr>Observer</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/videoframeprocessorpipeline.html">VideoFrameProcessorPipeline</a>.<a href="../interfaces/videoframeprocessorpipeline.html#addobserver">addObserver</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts#L103">src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts:103</a></li>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts#L107">src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts:107</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -309,7 +312,7 @@ <h3>destroy</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/videoframeprocessorpipeline.html">VideoFrameProcessorPipeline</a>.<a href="../interfaces/videoframeprocessorpipeline.html#destroy">destroy</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts#L51">src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts:51</a></li>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts#L59">src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts:59</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -332,7 +335,7 @@ <h3>get<wbr>Active<wbr>Output<wbr>Media<wbr>Stream</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/videoframeprocessorpipeline.html">VideoFrameProcessorPipeline</a>.<a href="../interfaces/videoframeprocessorpipeline.html#getactiveoutputmediastream">getActiveOutputMediaStream</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts#L115">src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts:115</a></li>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts#L119">src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts:119</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -355,7 +358,7 @@ <h3>get<wbr>Input<wbr>Media<wbr>Stream</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/videoframeprocessorpipeline.html">VideoFrameProcessorPipeline</a>.<a href="../interfaces/videoframeprocessorpipeline.html#getinputmediastream">getInputMediaStream</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts#L111">src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts:111</a></li>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts#L115">src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts:115</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -377,7 +380,7 @@ <h3>process</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts#L193">src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts:193</a></li>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts#L197">src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts:197</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -401,7 +404,7 @@ <h3>remove<wbr>Observer</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/videoframeprocessorpipeline.html">VideoFrameProcessorPipeline</a>.<a href="../interfaces/videoframeprocessorpipeline.html#removeobserver">removeObserver</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts#L107">src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts:107</a></li>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts#L111">src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts:111</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -430,7 +433,7 @@ <h3>set<wbr>Input<wbr>Media<wbr>Stream</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/videoframeprocessorpipeline.html">VideoFrameProcessorPipeline</a>.<a href="../interfaces/videoframeprocessorpipeline.html#setinputmediastream">setInputMediaStream</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts#L129">src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts:129</a></li>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts#L133">src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts:133</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -460,7 +463,7 @@ <h3>stop</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/videoframeprocessorpipeline.html">VideoFrameProcessorPipeline</a>.<a href="../interfaces/videoframeprocessorpipeline.html#stop">stop</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts#L70">src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts:70</a></li>
<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts#L79">src/videoframeprocessor/DefaultVideoFrameProcessorPipeline.ts:79</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
Loading

0 comments on commit 9c54b6f

Please sign in to comment.