Do not display a warning message when calling setVideoCodecSendPrefer…

…ences before start (#2740)
aws · Aug 24, 2023 · 5497fd1 · 5497fd1
1 parent 53d35c0
commit 5497fd1
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 11 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -18,6 +18,8 @@ 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.
+
 ## [3.16.0] - 2023-06-26
 
 ### Added

diff --git a/docs/classes/defaultaudiovideocontroller.html b/docs/classes/defaultaudiovideocontroller.html
@@ -455,7 +455,7 @@ <h3>audio<wbr>Input<wbr>Did<wbr>Change</h3>
 							<aside class="tsd-sources">
 								<p>Implementation of <a href="../interfaces/mediastreambrokerobserver.html">MediaStreamBrokerObserver</a>.<a href="../interfaces/mediastreambrokerobserver.html#audioinputdidchange">audioInputDidChange</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/audiovideocontroller/DefaultAudioVideoController.ts#L1631">src/audiovideocontroller/DefaultAudioVideoController.ts:1631</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/audiovideocontroller/DefaultAudioVideoController.ts#L1633">src/audiovideocontroller/DefaultAudioVideoController.ts:1633</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -484,7 +484,7 @@ <h3>demote<wbr>From<wbr>Primary<wbr>Meeting</h3>
 							<aside class="tsd-sources">
 								<p>Implementation of <a href="../interfaces/audiovideocontroller.html">AudioVideoController</a>.<a href="../interfaces/audiovideocontroller.html#demotefromprimarymeeting">demoteFromPrimaryMeeting</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/audiovideocontroller/DefaultAudioVideoController.ts#L1604">src/audiovideocontroller/DefaultAudioVideoController.ts:1604</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/audiovideocontroller/DefaultAudioVideoController.ts#L1606">src/audiovideocontroller/DefaultAudioVideoController.ts:1606</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -534,7 +534,7 @@ <h3>encoding<wbr>Simulcast<wbr>Layers<wbr>Did<wbr>Change</h3>
 							<aside class="tsd-sources">
 								<p>Implementation of <a href="../interfaces/simulcastuplinkobserver.html">SimulcastUplinkObserver</a>.<a href="../interfaces/simulcastuplinkobserver.html#encodingsimulcastlayersdidchange">encodingSimulcastLayersDidChange</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/audiovideocontroller/DefaultAudioVideoController.ts#L1570">src/audiovideocontroller/DefaultAudioVideoController.ts:1570</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/audiovideocontroller/DefaultAudioVideoController.ts#L1572">src/audiovideocontroller/DefaultAudioVideoController.ts:1572</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -643,7 +643,7 @@ <h3>get<wbr>Remote<wbr>Video<wbr>Sources</h3>
 							<aside class="tsd-sources">
 								<p>Implementation of <a href="../interfaces/audiovideocontroller.html">AudioVideoController</a>.<a href="../interfaces/audiovideocontroller.html#getremotevideosources">getRemoteVideoSources</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/audiovideocontroller/DefaultAudioVideoController.ts#L1560">src/audiovideocontroller/DefaultAudioVideoController.ts:1560</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/audiovideocontroller/DefaultAudioVideoController.ts#L1562">src/audiovideocontroller/DefaultAudioVideoController.ts:1562</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -750,7 +750,7 @@ <h3>promote<wbr>ToPrimary<wbr>Meeting</h3>
 							<aside class="tsd-sources">
 								<p>Implementation of <a href="../interfaces/audiovideocontroller.html">AudioVideoController</a>.<a href="../interfaces/audiovideocontroller.html#promotetoprimarymeeting">promoteToPrimaryMeeting</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/audiovideocontroller/DefaultAudioVideoController.ts#L1579">src/audiovideocontroller/DefaultAudioVideoController.ts:1579</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/audiovideocontroller/DefaultAudioVideoController.ts#L1581">src/audiovideocontroller/DefaultAudioVideoController.ts:1581</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -1250,7 +1250,7 @@ <h3>video<wbr>Input<wbr>Did<wbr>Change</h3>
 							<aside class="tsd-sources">
 								<p>Implementation of <a href="../interfaces/mediastreambrokerobserver.html">MediaStreamBrokerObserver</a>.<a href="../interfaces/mediastreambrokerobserver.html#videoinputdidchange">videoInputDidChange</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/audiovideocontroller/DefaultAudioVideoController.ts#L1613">src/audiovideocontroller/DefaultAudioVideoController.ts:1613</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/audiovideocontroller/DefaultAudioVideoController.ts#L1615">src/audiovideocontroller/DefaultAudioVideoController.ts:1615</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">

diff --git a/docs/classes/noopaudiovideocontroller.html b/docs/classes/noopaudiovideocontroller.html
@@ -378,7 +378,7 @@ <h3>audio<wbr>Input<wbr>Did<wbr>Change</h3>
 							<aside class="tsd-sources">
 								<p>Inherited from <a href="defaultaudiovideocontroller.html">DefaultAudioVideoController</a>.<a href="defaultaudiovideocontroller.html#audioinputdidchange">audioInputDidChange</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/audiovideocontroller/DefaultAudioVideoController.ts#L1631">src/audiovideocontroller/DefaultAudioVideoController.ts:1631</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/audiovideocontroller/DefaultAudioVideoController.ts#L1633">src/audiovideocontroller/DefaultAudioVideoController.ts:1633</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -457,7 +457,7 @@ <h3>encoding<wbr>Simulcast<wbr>Layers<wbr>Did<wbr>Change</h3>
 							<aside class="tsd-sources">
 								<p>Inherited from <a href="defaultaudiovideocontroller.html">DefaultAudioVideoController</a>.<a href="defaultaudiovideocontroller.html#encodingsimulcastlayersdidchange">encodingSimulcastLayersDidChange</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/audiovideocontroller/DefaultAudioVideoController.ts#L1570">src/audiovideocontroller/DefaultAudioVideoController.ts:1570</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/audiovideocontroller/DefaultAudioVideoController.ts#L1572">src/audiovideocontroller/DefaultAudioVideoController.ts:1572</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -566,7 +566,7 @@ <h3>get<wbr>Remote<wbr>Video<wbr>Sources</h3>
 							<aside class="tsd-sources">
 								<p>Inherited from <a href="defaultaudiovideocontroller.html">DefaultAudioVideoController</a>.<a href="defaultaudiovideocontroller.html#getremotevideosources">getRemoteVideoSources</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/audiovideocontroller/DefaultAudioVideoController.ts#L1560">src/audiovideocontroller/DefaultAudioVideoController.ts:1560</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/audiovideocontroller/DefaultAudioVideoController.ts#L1562">src/audiovideocontroller/DefaultAudioVideoController.ts:1562</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -1166,7 +1166,7 @@ <h3>video<wbr>Input<wbr>Did<wbr>Change</h3>
 							<aside class="tsd-sources">
 								<p>Inherited from <a href="defaultaudiovideocontroller.html">DefaultAudioVideoController</a>.<a href="defaultaudiovideocontroller.html#videoinputdidchange">videoInputDidChange</a></p>
 								<ul>
-									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/audiovideocontroller/DefaultAudioVideoController.ts#L1613">src/audiovideocontroller/DefaultAudioVideoController.ts:1613</a></li>
+									<li>Defined in <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/src/audiovideocontroller/DefaultAudioVideoController.ts#L1615">src/audiovideocontroller/DefaultAudioVideoController.ts:1615</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">

diff --git a/src/audiovideocontroller/DefaultAudioVideoController.ts b/src/audiovideocontroller/DefaultAudioVideoController.ts
@@ -1554,7 +1554,9 @@ export default class DefaultAudioVideoController
   setVideoCodecSendPreferences(preferences: VideoCodecCapability[]): void {
     this.videoSendCodecPreferences = preferences; // In case we haven't called `initSignalingClient` yet
     this.meetingSessionContext.videoSendCodecPreferences = preferences;
-    this.update({ needsRenegotiation: true });
+    if (this.sessionStateController.state() !== SessionStateControllerState.NotConnected) {
+      this.update({ needsRenegotiation: true });
+    }
   }
 
   getRemoteVideoSources(): VideoSource[] {

diff --git a/test/audiovideocontroller/DefaultAudioVideoController.test.ts b/test/audiovideocontroller/DefaultAudioVideoController.test.ts
@@ -4253,6 +4253,21 @@ describe('DefaultAudioVideoController', () => {
 
       expect(spy.callCount).to.equal(1);
     });
+
+    it('does not trigger an update if invoked before the session starts.', async () => {
+      audioVideoController = new DefaultAudioVideoController(
+        configuration,
+        new NoOpDebugLogger(),
+        webSocketAdapter,
+        new NoOpDeviceController(),
+        reconnectController
+      );
+
+      // @ts-ignore
+      const spy = sinon.spy(audioVideoController, 'update');
+      audioVideoController.setVideoCodecSendPreferences([VideoCodecCapability.vp8()]);
+      expect(spy.callCount).to.equal(0);
+    });
   });
 
   describe('getRTCPeerConnectionStats', () => {