amazon-chime-sdk-js - npm Package Versions

[3.1.0] - 2022-04-07

Added

• Add audioUpstreamRoundTripTimeMs, audioUpstreamJitterMs, and audioDownstreamJitterMs to observableMetricSpec.
• Add videoUpstreamRoundTripTimeMs, videoUpstreamJitterMs, and videoDownstreamJitterMs, and videoDownstreamDelayMs to observableVideoMetricSpec.

Removed

• No longer stop video stream when calling stopLocalVideoTile. This was added as a workaround to prevent crash in old Safari versions but no longer needed.

Changed

• Subscribe and unsubscribe to MediaStreamBrokerObserver in AudioVideoController at the end of every connection and disconnection to avoid trying to replace local audio and video during connection.
• Update getMediaType method to check the property kind instead of mediaType of a RawMetricReport.

Fixed

• Fixed state not being reset if an AudioVideoController is reused after stop.

• Fix a bug that remote-inbound-rtp RTCStatsReport and remote-outbound-rtp RTCStatsReport of "video" kind are accidentally filtered.

• Fix the incorrect calculation of aggregation WebRTC metric spec (audioSpeakerDelayMs, decoderLoss).

[3.0.0] - 2022-03-30

Amazon Chime SDK for JavaScript v3 is here !! 🎉🎉🎉

Amazon Chime SDK for JavaScript v3 includes major improvements for device management, WebRTC metrics, and the messaging session.

• Device management: Decouple audio and video device management from the meeting sessions. For example, a user can select their preferred devices on a video preview page and continue using the same devices to join the session. After joining the session, a user can instantly switch devices without interrupting the ongoing meeting session.
• WebRTC metrics: Publish the standardized WebRTC metrics for all supported browsers.
• Messaging session: Add support for AWS SDK for JavaScript v3 for messaging session.
• Dropping support: Deprecate Safari 12 support and Plan B in Session Description Protocol (SDP) negotiations.

Below is a list of all changes in the Chime SDK for JavaScript v3. Please refer to the Migraton guide from v2 to v3 for more information.

Added

• Add rtcStatsReport property to ClientMetricReport to store raw RTCStatsReport and expose it via metricsDidReceive event.

Removed

• Remove support for Plan B as well as Safari (and iOS) 12+. The minimum Safari and iOS supported version is now 13.
• Remove legacy (non-promise-based) getStats API call in DefaultStatsCollector. This API was previously used to obtain WebRTC metrics only for Chromium-based browsers. Now SDK obtains WebRTC metrics for all browsers via standardized (promise-based) getStats API.
• Remove all deprecated meeting status code.
• Remove videoSendHealthDidChange, videoSendBandwidthDidChange, videoNotReceivingEnoughData, and videoReceiveBandwidthDidChange. Use metricsDidReceive to obtain metrics instead.
• Remove estimatedDownlinkBandwidthLessThanRequired.
• Remove synthesize video APIs such as SMTP.
• Removed SDP interface.
• Remove StatsCollector interface.
• Remove ClientMetricReport interface.

Changed

• Rename DefaultStatsCollector to StatsCollector.
• Rename DefaultClientMetricReport to ClientMetricReport.
• Change chooseAudioInputDevice to explicit APIs startAudioInput and stopAudioInput. Application will need to call stopVideoInput at the end of the call to explicitly stop active audio stream.
• Change chooseVideoInputDevice to explicit APIs startVideoInput and stopVideoInput. Application will need to call stopVideoInput now to explicitly stop active video stream.
• Minor name change to chooseAudioOutputDevice to chooseAudioOutput.
• startVideoPreviewForVideoInput and stopVideoPreviewForVideoInput will no longer turn on and off video stream. This allows applications to join meeting without reselecting video again.
• Remove max bandwidth kbps parameter in chooseVideoInputQuality as it is not related to device. Applications can set video max bandwidth kbps from audioVideo.setVideoMaxBandwidthKbps.
• Extend the DeviceController interface to include Destroyable
• Rename MeetingSessionPOSTLogger to POSTLogger.
• Update POSTLogger to implement the Logger interface.
• Remove MeetingSessionConfiguration dependency from MeetingSessionPOSTLogger. Builders need to add metadata to POSTLogger if they want to include information such as appName, meetingId and so on with the HTTP POST request made by POSTLogger when sending logs to builder provided URL. Please check 3.0 migration guide for more information.
• Decoupled EventController from AudioVideo and MeetingSession.

Fixed

• Fix a bug where joining without selecting any audio device failed when Web Audio is enabled.
• Fix a minor log info for video input ended event where we say resetting to null device when we just stop the video input.

[3.0.0-beta.1] - 2022-02-23

Added

• Add compression support when sending and receiving sdp messages.
• Add automatic language identification support from Amazon Transcribe for live transcription APIs.
• Add rtcStatsReport property to DefaultClientMetricReport to store raw RTCStatsReport and expose it via metricsDidReceive event.

Removed

• Removed SDP interface.
• Remove legacy (non-promise-based) getStats API call in DefaultStatsCollector. This API was previously used to obtain WebRTC metrics only for Chromium-based browsers. Now SDK obtains WebRTC metrics for all browsers via standardized (promise-based) getStats API.
• Remove browserBehavior from the constructor of DefaultStatsCollector.

Changed

• Change resolveSpec and resolveOptions in BackgroundBlurVideoFrameProcessor and BackgroundReplacementVideoFrameProcessor to clone parameter objects.

Fixed

• Clone the video preference input in chooseRemoteVideoSources API in VideoPriorityBasedPolicy to avoid mutation that can cause video preferences to not be sorted and lead to wrong video subscription determination by the policy.
• Fix a screen share issue by resetting the sdp compression state during join requests.
• Fix a video orientation issue when Background Blur/Background Replacement is enabled.

[3.0.0-beta.0] - 2022-02-08

Added

Removed

• Remove support for Plan B as well as Safari (and iOS) 12+. The minimum Safari and iOS supported version is now 13. Also clean up all plan-B code path.
• Remove all deprecated meeting status code.

Changed

• Decoupled EventController from AudioVideo and MeetingSession.
• Add support for pre-release in Versioning.
• Removed upward BWE throttling logic in VideoPriorityBasedPolicyConfig, which was increasing recovery time more then intended, whereas its main focus was towards slowing downturns in BWE when the network is actually stable. We may come back to configuring the recovery delay another time.
• Add support for aws-sdk js v3 for messaging session.

Fixed

• Fix a worker resource leak with BackgroundBlurProcessor and BackgroundReplacementProcessor.

[2.27.0] - 2022-01-27

Added

Removed

Changed

• Changed VideoPriorityBasedPolicyConfig to be dependent on bandwidth fluctuation so that VideoPriorityBasedPolicy will not drop/resume video instantly when network bandwidth changes. (#1921).
• Adjust the recovery behavior of VideoPriorityBasedPolicy to not get stuck at low estimates, not overeact to spurious packet loss when probing, and not let the time between probes raise to 60 seconds (reduced to maximum of 30 seconds).

Fixed

• Fix the reconnecting issue (#1985) by skipping the "close" event if it does not arrive in two seconds.
• Add a workaround to avoid 480p resolution scale down when there are 5-8 videos for the default video uplink policy for Chromium browsers version 98 on Windows and use 360p instead.

[2.26.0] - 2022-01-14

Added

Removed

Changed

• Made SimulcastUplinkObserver.encodingSimulcastLayersDidChange (not AudioVideoObserver.encodingSimulcastLayersDidChange) synchronous.

Fixed

• Fixed delays in advertising simulcast stream switches due to asynchronous and out of order checks.
• Fixed Firefox video tiles containing stale frames from previous transceivers by not attempting to reuse inactive transceivers. This switches to using RTCRtpTransceiver.stop when possible and may fix other incorrect tile bugs.
• Fix the bug that the max bandwidth set by the chooseVideoInputQuality API is ignored when the Chime SDK retries the connection.
• Added additional pausing of MonitorTask and ReceiveVideoStreamIndexTask to avoid modifying mutable state mid-subscribe.
• Fix the bug that the max bandwidth is ignored if the chooseVideoInputQuality API is called before starting a meeting.
• Use optional chaining to prevent an error from undefined transceiverEncoding in FF.