Co
inputDeviceCount: number = 0
@@ -306,7 +321,7 @@ Private isAndroid
isAndroid: boolean = false
@@ -316,7 +331,7 @@ Private isPixel3
isPixel3: boolean = false
@@ -326,7 +341,7 @@ Private lastNoVideoIn
lastNoVideoInputDeviceCount: number
@@ -336,7 +351,7 @@ Private logger
@@ -346,7 +361,7 @@ Private useWebAudiouseWebAudio: boolean = false
@@ -356,7 +371,7 @@ Private videoFrameRat
videoFrameRate: number = DefaultDeviceController.defaultVideoFrameRate
@@ -366,7 +381,7 @@ Private videoHeight
videoHeight: number = DefaultDeviceController.defaultVideoHeight
@@ -376,7 +391,7 @@ Private videoMaxBandw
videoMaxBandwidthKbps: number = DefaultDeviceController.defaultVideoMaxBandwidthKbps
@@ -386,7 +401,7 @@ Private videoWidth
videoWidth: number = DefaultDeviceController.defaultVideoWidth
@@ -396,7 +411,7 @@ Static defaultChannelCount: number = 1
@@ -406,7 +421,7 @@ Static defaultSampleRate: number = 48000
@@ -416,7 +431,7 @@ Static defaultSampleSize: number = 16
@@ -426,7 +441,7 @@ Static defaultVideoFrameRate: number = 15
@@ -436,7 +451,7 @@ Static defaultVideoHeight: number = 720
@@ -446,7 +461,7 @@ Static defaultVideoMaxBandwidthKbps: number = 1400
@@ -456,7 +471,7 @@ Static defaultVideoWidth: number = 1280
@@ -466,7 +481,7 @@ Static permissionDeniedOriginDetectionThresholdMs: number = 500
@@ -476,7 +491,7 @@ Static permissionGrantedOriginDetectionThresholdMs: number = 1000
@@ -494,7 +509,7 @@ acquireAudioInputStream
Returns Promise<MediaStream>
@@ -512,7 +527,7 @@ acquireDisplayInputStream
Parameters
@@ -535,7 +550,7 @@ Private acquireInputS
Parameters
@@ -559,7 +574,7 @@ acquireVideoInputStream
Returns Promise<MediaStream>
@@ -577,7 +592,7 @@ addDeviceChangeObserver
Parameters
@@ -600,7 +615,7 @@ Private areDeviceList
Parameters
@@ -626,7 +641,7 @@ Private attachAudioIn
Parameters
@@ -649,7 +664,7 @@ Private bindAudioOutp
Returns Promise<void>
@@ -667,7 +682,7 @@ bindToAudioVideoController
Parameters
@@ -690,7 +705,7 @@ Private calculateMedia
Parameters
@@ -717,7 +732,7 @@ chooseAudioInputDevice
Parameters
@@ -741,7 +756,7 @@ chooseAudioOutputDevice
Parameters
@@ -764,7 +779,7 @@ Private chooseInputDe
Parameters
@@ -794,7 +809,7 @@ chooseVideoInputDevice
Parameters
@@ -818,7 +833,7 @@ chooseVideoInputQuality
Parameters
@@ -851,7 +866,7 @@ createAnalyserNodeForAudioInput
Returns AnalyserNode | null
@@ -868,7 +883,7 @@ Private deviceAsMedia
Parameters
@@ -891,7 +906,7 @@ Private deviceInfoFro
Parameters
@@ -917,7 +932,7 @@ Private deviceLabelTr
Returns Promise<MediaStream>
@@ -935,7 +950,7 @@ enableWebAudio
Parameters
@@ -958,7 +973,7 @@ Private ensureAudioIn
Returns void
@@ -975,7 +990,7 @@ Private forEachObserv
Parameters
@@ -1006,6 +1021,78 @@ Returns void
+
+
+ getActiveDeviceId
+
+ - getActiveDeviceId(kind: string): string | null
+
+
+ -
+
+
Parameters
+
+ Returns string | null
+
+
+
+
+
+ Private getDeviceIdStr
+
+ - getDeviceIdStr(device: Device): string | null
+
+
+ -
+
+
Parameters
+
+ Returns string | null
+
+
+
+
+
+ Private getGroupIdFromDeviceId
+
+ - getGroupIdFromDeviceId(kind: string, device: string): string
+
+
+ -
+
+
Parameters
+
+ -
+
kind: string
+
+ -
+
device: string
+
+
+ Returns string
+
+
+
Private handleDeviceChange
@@ -1016,13 +1103,42 @@
+
+
+ Private hasSameGroupId
+
+ - hasSameGroupId(groupId: string, kind: string, device: Device): boolean
+
+
+ -
+
+
Parameters
+
+ -
+
groupId: string
+
+ -
+
kind: string
+
+ -
+
+
+
+ Returns boolean
+
+
+
listAudioInputDevices
@@ -1034,7 +1150,7 @@ listAudioInputDevices
Returns Promise<MediaDeviceInfo[]>
@@ -1052,7 +1168,7 @@ listAudioOutputDevices
Returns Promise<MediaDeviceInfo[]>
@@ -1069,7 +1185,7 @@
@@ -1585,6 +1701,9 @@ video
boundAudioVideoController
+
+ browserBehavior
+
deviceChangeObservers
@@ -1714,9 +1833,21 @@ video
forEachObserver
+
+ getActiveDeviceId
+
+
+ getDeviceIdStr
+
+
+ getGroupIdFromDeviceId
+
handleDeviceChange
+
+ hasSameGroupId
+
listAudioInputDevices
diff --git a/docs/classes/deviceselection.html b/docs/classes/deviceselection.html
index cc2ee9d15e..19bf4bf1fa 100644
--- a/docs/classes/deviceselection.html
+++ b/docs/classes/deviceselection.html
@@ -82,6 +82,7 @@ Index
Properties
@@ -106,6 +107,16 @@ constraints
+
+
+ groupId
+ groupId: string = ""
+
+
stream
@@ -129,7 +140,7 @@ matchesConstraints
Parameters
@@ -162,6 +173,9 @@
+
+ groupId
+
stream
diff --git a/package-lock.json b/package-lock.json
index dc2075f9b4..b5fe1eb280 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,6 +1,6 @@
{
"name": "amazon-chime-sdk-js",
- "version": "1.10.9",
+ "version": "1.10.10",
"lockfileVersion": 1,
"requires": true,
"dependencies": {
diff --git a/package.json b/package.json
index dec287f3a2..894597c54f 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "amazon-chime-sdk-js",
- "version": "1.10.9",
+ "version": "1.10.10",
"description": "Amazon Chime SDK for JavaScript",
"main": "build/index.js",
"types": "build/index.d.ts",
diff --git a/src/devicecontroller/DefaultDeviceController.ts b/src/devicecontroller/DefaultDeviceController.ts
index e2e3b9159d..d667436290 100644
--- a/src/devicecontroller/DefaultDeviceController.ts
+++ b/src/devicecontroller/DefaultDeviceController.ts
@@ -2,6 +2,8 @@
// SPDX-License-Identifier: Apache-2.0
import AudioVideoController from '../audiovideocontroller/AudioVideoController';
+import BrowserBehavior from '../browserbehavior/BrowserBehavior';
+import DefaultBrowserBehavior from '../browserbehavior/DefaultBrowserBehavior';
import DeviceChangeObserver from '../devicechangeobserver/DeviceChangeObserver';
import Logger from '../logger/Logger';
import Maybe from '../maybe/Maybe';
@@ -24,6 +26,7 @@ export default class DefaultDeviceController implements DeviceControllerBasedMed
private static defaultSampleRate = 48000;
private static defaultSampleSize = 16;
private static defaultChannelCount = 1;
+ private browserBehavior: BrowserBehavior = new DefaultBrowserBehavior();
private deviceInfoCache: MediaDeviceInfo[] | null = null;
private activeDevices: { [kind: string]: DeviceSelection | null } = { audio: null, video: null };
private audioOutputDeviceId: string | null = null;
@@ -42,7 +45,6 @@ export default class DefaultDeviceController implements DeviceControllerBasedMed
private videoMaxBandwidthKbps: number = DefaultDeviceController.defaultVideoMaxBandwidthKbps;
private useWebAudio: boolean = false;
-
private isAndroid: boolean = false;
private isPixel3: boolean = false;
@@ -482,6 +484,65 @@ export default class DefaultDeviceController implements DeviceControllerBasedMed
return device && device.id ? device : null;
}
+ private hasSameGroupId(groupId: string, kind: string, device: Device): boolean {
+ device = this.getDeviceIdStr(device);
+ if (groupId === this.getGroupIdFromDeviceId(kind, device) || groupId === '') {
+ return true;
+ }
+ return false;
+ }
+
+ private getGroupIdFromDeviceId(kind: string, device: string): string {
+ if (this.deviceInfoCache !== null) {
+ const cachedDeviceInfo = this.listCachedDevicesOfKind(`${kind}input`).find(
+ (cachedDevice: MediaDeviceInfo) => cachedDevice.deviceId === device
+ );
+ if (cachedDeviceInfo && cachedDeviceInfo.groupId) {
+ return cachedDeviceInfo.groupId;
+ }
+ }
+ return '';
+ }
+
+ private getDeviceIdStr(device: Device): string | null {
+ if (typeof device === 'string') {
+ return device;
+ }
+ if (device === null) {
+ return null;
+ }
+ const deviceMediaTrackConstraints = device as MediaTrackConstraints;
+ if ((device as MediaStream).id) {
+ return (device as MediaStream).id;
+ } else if (deviceMediaTrackConstraints.deviceId) {
+ /* istanbul ignore else */
+ if ((deviceMediaTrackConstraints.deviceId as ConstrainDOMStringParameters).exact) {
+ /* istanbul ignore else */
+ if (
+ (deviceMediaTrackConstraints.deviceId as ConstrainDOMStringParameters).exact as string
+ ) {
+ return (deviceMediaTrackConstraints.deviceId as ConstrainDOMStringParameters)
+ .exact as string;
+ }
+ }
+ }
+ return '';
+ }
+
+ getActiveDeviceId(kind: string): string | null {
+ if (this.activeDevices[kind] && this.activeDevices[kind].constraints) {
+ const activeDeviceMediaTrackConstraints =
+ this.activeDevices[kind].constraints.audio || this.activeDevices[kind].constraints.video;
+ const activeDeviceConstrainDOMStringParameters = (activeDeviceMediaTrackConstraints as MediaTrackConstraints)
+ .deviceId;
+ const activeDeviceId = (activeDeviceConstrainDOMStringParameters as ConstrainDOMStringParameters)
+ .exact;
+ /* istanbul ignore else */
+ if (activeDeviceId as string) return activeDeviceId as string;
+ }
+ return null;
+ }
+
private async chooseInputDevice(
kind: string,
device: Device,
@@ -503,15 +564,17 @@ export default class DefaultDeviceController implements DeviceControllerBasedMed
kind,
device
);
+
if (
this.activeDevices[kind] &&
this.activeDevices[kind].matchesConstraints(proposedConstraints) &&
- this.activeDevices[kind].stream.active
+ this.activeDevices[kind].stream.active &&
+ this.activeDevices[kind].groupId !== null &&
+ this.hasSameGroupId(this.activeDevices[kind].groupId, kind, device)
) {
this.logger.info(`reusing existing ${kind} device`);
return DevicePermission.PermissionGrantedPreviously;
}
-
const startTimeMs = Date.now();
const newDevice: DeviceSelection = new DeviceSelection();
try {
@@ -527,9 +590,15 @@ export default class DefaultDeviceController implements DeviceControllerBasedMed
newDevice.stream = stream;
newDevice.constraints = proposedConstraints;
} else {
+ if (
+ this.browserBehavior.hasChromiumWebRTC() &&
+ this.getDeviceIdStr(device) === this.getActiveDeviceId(kind) &&
+ this.getDeviceIdStr(device) === 'default'
+ ) {
+ this.releaseMediaStream(this.activeDevices[kind].stream);
+ }
newDevice.stream = await navigator.mediaDevices.getUserMedia(proposedConstraints);
newDevice.constraints = proposedConstraints;
-
if (kind === 'video' && this.lastNoVideoInputDeviceCount > callCount) {
this.logger.warn(
`ignored to get video device for constraints ${JSON.stringify(
@@ -557,6 +626,7 @@ export default class DefaultDeviceController implements DeviceControllerBasedMed
}
});
}
+ newDevice.groupId = this.getGroupIdFromDeviceId(kind, this.getDeviceIdStr(device));
} catch (error) {
this.logger.error(
`failed to get ${kind} device for constraints ${JSON.stringify(proposedConstraints)}: ${
diff --git a/src/devicecontroller/DeviceSelection.ts b/src/devicecontroller/DeviceSelection.ts
index 72af09aa4b..bce9622ee5 100644
--- a/src/devicecontroller/DeviceSelection.ts
+++ b/src/devicecontroller/DeviceSelection.ts
@@ -1,9 +1,10 @@
-// Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// Copyright 2019-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
export default class DeviceSelection {
constraints: MediaStreamConstraints;
stream: MediaStream;
+ groupId: string = '';
matchesConstraints(constraints: MediaStreamConstraints): boolean {
return JSON.stringify(this.constraints) === JSON.stringify(constraints);
diff --git a/src/versioning/Versioning.ts b/src/versioning/Versioning.ts
index 5af502381a..a7a5f8d9f1 100644
--- a/src/versioning/Versioning.ts
+++ b/src/versioning/Versioning.ts
@@ -18,7 +18,7 @@ export default class Versioning {
* Return string representation of SDK version
*/
static get sdkVersion(): string {
- return '1.10.9';
+ return '1.10.10';
}
/**
diff --git a/test/devicecontroller/DefaultDeviceController.test.ts b/test/devicecontroller/DefaultDeviceController.test.ts
index efa80f2e3d..6ec24fa0c3 100644
--- a/test/devicecontroller/DefaultDeviceController.test.ts
+++ b/test/devicecontroller/DefaultDeviceController.test.ts
@@ -38,13 +38,15 @@ describe('DefaultDeviceController', () => {
function getMediaDeviceInfo(
deviceId: string,
kind: MediaDeviceKind,
- label: string
+ label: string,
+ groupId?: string
): MediaDeviceInfo {
// @ts-ignore
return {
deviceId,
kind,
label,
+ groupId,
};
}
@@ -185,7 +187,7 @@ describe('DefaultDeviceController', () => {
expect(called).to.be.true;
});
- it('cathces an error from restarting the local audio', async () => {
+ it('catches an error from restarting the local audio', async () => {
let called = false;
class TestAudioVideoController extends NoOpAudioVideoController {
@@ -218,6 +220,38 @@ describe('DefaultDeviceController', () => {
expect(permission).to.equal(DevicePermission.PermissionGrantedByBrowser);
});
+ it('releases audio media stream when requesting default device and default is already active in chromium based browser', async () => {
+ deviceController.enableWebAudio(true);
+ domMockBehavior.browserName = 'chrome';
+ domMockBuilder = new DOMMockBuilder(domMockBehavior);
+ deviceController = new DefaultDeviceController(logger);
+ domMockBehavior.enumerateDeviceList = [
+ getMediaDeviceInfo('default', 'audioinput', 'label', 'group-id-1'),
+ ];
+ await deviceController.listAudioInputDevices();
+ let permission = await deviceController.chooseAudioInputDevice('default');
+ expect(permission).to.equal(DevicePermission.PermissionGrantedByBrowser);
+ domMockBehavior.enumerateDeviceList.pop();
+ // add external default device
+ domMockBehavior.enumerateDeviceList = [
+ getMediaDeviceInfo('default', 'audioinput', 'default - label2', 'group-id-2'),
+ ];
+ domMockBuilder = new DOMMockBuilder(domMockBehavior);
+ await deviceController.listAudioInputDevices();
+ permission = await deviceController.chooseAudioInputDevice('default');
+ expect(permission).to.equal(DevicePermission.PermissionGrantedByBrowser);
+ });
+
+ it('sets to null device when an external device disconnects', async () => {
+ deviceController.enableWebAudio(true);
+ let permission = await deviceController.chooseAudioInputDevice(stringDeviceId);
+ expect(permission).to.equal(DevicePermission.PermissionGrantedByBrowser);
+
+ // The previous audio source node will be disconneted.
+ permission = await deviceController.chooseAudioInputDevice(null);
+ expect(permission).to.equal(DevicePermission.PermissionGrantedByBrowser);
+ });
+
it('releases all previously-acquired audio streams', done => {
const stringDeviceIds: Device[] = [
'device-id-1',
@@ -445,7 +479,7 @@ describe('DefaultDeviceController', () => {
expect(spy.called).to.be.false;
});
- it("disconnects the audio input source node instead of the given stream 's tracks", async () => {
+ it("disconnects the audio input source node instead of the given stream's tracks", async () => {
deviceController.enableWebAudio(true);
await deviceController.chooseAudioInputDevice(stringDeviceId);
const stream = await deviceController.acquireAudioInputStream();
@@ -801,4 +835,12 @@ describe('DefaultDeviceController', () => {
await new Promise(resolve => new TimeoutScheduler(100).start(resolve));
});
});
+
+ describe('getActiveDeviceId', () => {
+ it('calls getActiveDeviceId to get the avtive device for the video', async () => {
+ let permission = await deviceController.chooseVideoInputDevice('default');
+ expect(permission).to.equal(DevicePermission.PermissionGrantedByBrowser);
+ expect(deviceController.getActiveDeviceId('video')).to.equal('default');
+ });
+ });
});