@twilio/voice-sdk
Version:
Twilio's JavaScript Voice SDK
108 lines • 8.65 kB
JavaScript
/**
* @packageDocumentation
* @module Voice
*/
import { SOUNDS_BASE_URL } from './constants';
import { InvalidArgumentError, InvalidStateError, NotSupportedError } from './errors';
const DEFAULT_TEST_SOUND_URL = `${SOUNDS_BASE_URL}/outgoing.mp3`;
/**
* A smart collection containing a Set of active output devices.
* @publicapi
*/
export default class OutputDeviceCollection {
/**
* @private
*/
constructor(_name, _availableDevices, _beforeChange, _isSupported) {
this._name = _name;
this._availableDevices = _availableDevices;
this._beforeChange = _beforeChange;
this._isSupported = _isSupported;
/**
* The currently active output devices.
*/
this._activeDevices = new Set();
}
/**
* Delete a device from the collection. If no devices remain, the 'default'
* device will be added as the sole device. If no `default` device exists,
* the first available device will be used.
* @param device - The device to delete from the collection
* @returns whether the device was present before it was deleted
*/
delete(device) {
const wasDeleted = !!(this._activeDevices.delete(device));
const defaultDevice = this._availableDevices.get('default')
|| Array.from(this._availableDevices.values())[0];
if (!this._activeDevices.size && defaultDevice) {
this._activeDevices.add(defaultDevice);
}
// Call _beforeChange so that the implementation can react when a device is
// removed or lost.
const deviceIds = Array.from(this._activeDevices.values()).map(deviceInfo => deviceInfo.deviceId);
this._beforeChange(this._name, deviceIds);
return !!wasDeleted;
}
/**
* Get the current set of devices.
*/
get() {
return this._activeDevices;
}
/**
* Replace the current set of devices with a new set of devices.
* @param deviceIdOrIds - An ID or array of IDs of devices to replace the existing devices with.
* @returns Rejects if this feature is not supported, any of the supplied IDs are not found,
* or no IDs are passed.
*/
set(deviceIdOrIds) {
if (!this._isSupported) {
return Promise.reject(new NotSupportedError('This browser does not support audio output selection'));
}
const deviceIds = Array.isArray(deviceIdOrIds) ? deviceIdOrIds : [deviceIdOrIds];
if (!deviceIds.length) {
return Promise.reject(new InvalidArgumentError('Must specify at least one device to set'));
}
const missingIds = [];
const devices = deviceIds.map((id) => {
const device = this._availableDevices.get(id);
if (!device) {
missingIds.push(id);
}
return device;
});
if (missingIds.length) {
return Promise.reject(new InvalidArgumentError(`Devices not found: ${missingIds.join(', ')}`));
}
return new Promise(resolve => {
resolve(this._beforeChange(this._name, deviceIds));
}).then(() => {
this._activeDevices.clear();
devices.forEach(this._activeDevices.add, this._activeDevices);
});
}
/**
* Test the devices by playing audio through them.
* @param [soundUrl] - An optional URL. If none is specified, we will
* play a default test tone.
* @returns Resolves with the result of the underlying HTMLAudioElements' play() calls.
*/
test(soundUrl = DEFAULT_TEST_SOUND_URL) {
if (!this._isSupported) {
return Promise.reject(new NotSupportedError('This browser does not support audio output selection'));
}
if (!this._activeDevices.size) {
return Promise.reject(new InvalidStateError('No active output devices to test'));
}
return Promise.all(Array.from(this._activeDevices).map((device) => {
let el;
// (rrowland) We need to wait for the oncanplay event because of a regression introduced
// in Chrome M72: https://bugs.chromium.org/p/chromium/issues/detail?id=930876
return new Promise((resolve) => {
el = new Audio(soundUrl);
el.oncanplay = resolve;
}).then(() => el.setSinkId(device.deviceId).then(() => el.play()));
}));
}
}
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoib3V0cHV0ZGV2aWNlY29sbGVjdGlvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL2xpYi90d2lsaW8vb3V0cHV0ZGV2aWNlY29sbGVjdGlvbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQTs7O0dBR0c7QUFDSCxPQUFPLEVBQUUsZUFBZSxFQUFFLE1BQU0sYUFBYSxDQUFDO0FBQzlDLE9BQU8sRUFBRSxvQkFBb0IsRUFBRSxpQkFBaUIsRUFBRSxpQkFBaUIsRUFBRSxNQUFNLFVBQVUsQ0FBQztBQUN0RixNQUFNLHNCQUFzQixHQUFHLEdBQUcsZUFBZSxlQUFlLENBQUM7QUFFakU7OztHQUdHO0FBQ0gsTUFBTSxDQUFDLE9BQU8sT0FBTyxzQkFBc0I7SUFNekM7O09BRUc7SUFDSCxZQUFvQixLQUFhLEVBQ2IsaUJBQStDLEVBQy9DLGFBQWlFLEVBQ2pFLFlBQXFCO1FBSHJCLFVBQUssR0FBTCxLQUFLLENBQVE7UUFDYixzQkFBaUIsR0FBakIsaUJBQWlCLENBQThCO1FBQy9DLGtCQUFhLEdBQWIsYUFBYSxDQUFvRDtRQUNqRSxpQkFBWSxHQUFaLFlBQVksQ0FBUztRQVh6Qzs7V0FFRztRQUNLLG1CQUFjLEdBQXlCLElBQUksR0FBRyxFQUFFLENBQUM7SUFRWixDQUFDO0lBRTlDOzs7Ozs7T0FNRztJQUNILE1BQU0sQ0FBQyxNQUF1QjtRQUM1QixNQUFNLFVBQVUsR0FBWSxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQUMsY0FBYyxDQUFDLE1BQU0sQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDO1FBRW5FLE1BQU0sYUFBYSxHQUFvQixJQUFJLENBQUMsaUJBQWlCLENBQUMsR0FBRyxDQUFDLFNBQVMsQ0FBQztlQUN2RSxLQUFLLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxpQkFBaUIsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDO1FBRXBELElBQUksQ0FBQyxJQUFJLENBQUMsY0FBYyxDQUFDLElBQUksSUFBSSxhQUFhLEVBQUU7WUFDOUMsSUFBSSxDQUFDLGNBQWMsQ0FBQyxHQUFHLENBQUMsYUFBYSxDQUFDLENBQUM7U0FDeEM7UUFFRCwyRUFBMkU7UUFDM0UsbUJBQW1CO1FBQ25CLE1BQU0sU0FBUyxHQUFHLEtBQUssQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLGNBQWMsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxVQUFVLENBQUMsRUFBRSxDQUFDLFVBQVUsQ0FBQyxRQUFRLENBQUMsQ0FBQztRQUVsRyxJQUFJLENBQUMsYUFBYSxDQUFDLElBQUksQ0FBQyxLQUFLLEVBQUUsU0FBUyxDQUFDLENBQUM7UUFDMUMsT0FBTyxDQUFDLENBQUMsVUFBVSxDQUFDO0lBQ3RCLENBQUM7SUFFRDs7T0FFRztJQUNILEdBQUc7UUFDRCxPQUFPLElBQUksQ0FBQyxjQUFjLENBQUM7SUFDN0IsQ0FBQztJQUVEOzs7OztPQUtHO0lBQ0gsR0FBRyxDQUFDLGFBQWdDO1FBQ2xDLElBQUksQ0FBQyxJQUFJLENBQUMsWUFBWSxFQUFFO1lBQ3RCLE9BQU8sT0FBTyxDQUFDLE1BQU0sQ0FBQyxJQUFJLGlCQUFpQixDQUFDLHNEQUFzRCxDQUFDLENBQUMsQ0FBQztTQUN0RztRQUVELE1BQU0sU0FBUyxHQUFhLEtBQUssQ0FBQyxPQUFPLENBQUMsYUFBYSxDQUFDLENBQUMsQ0FBQyxDQUFDLGFBQWEsQ0FBQyxDQUFDLENBQUMsQ0FBQyxhQUFhLENBQUMsQ0FBQztRQUUzRixJQUFJLENBQUMsU0FBUyxDQUFDLE1BQU0sRUFBRTtZQUNyQixPQUFPLE9BQU8sQ0FBQyxNQUFNLENBQUMsSUFBSSxvQkFBb0IsQ0FBQyx5Q0FBeUMsQ0FBQyxDQUFDLENBQUM7U0FDNUY7UUFFRCxNQUFNLFVBQVUsR0FBYSxFQUFFLENBQUM7UUFDaEMsTUFBTSxPQUFPLEdBQXVDLFNBQVMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxFQUFVLEVBQUUsRUFBRTtZQUMvRSxNQUFNLE1BQU0sR0FBZ0MsSUFBSSxDQUFDLGlCQUFpQixDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUMsQ0FBQztZQUMzRSxJQUFJLENBQUMsTUFBTSxFQUFFO2dCQUFFLFVBQVUsQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDLENBQUM7YUFBRTtZQUNyQyxPQUFPLE1BQU0sQ0FBQztRQUNoQixDQUFDLENBQUMsQ0FBQztRQUVILElBQUksVUFBVSxDQUFDLE1BQU0sRUFBRTtZQUNyQixPQUFPLE9BQU8sQ0FBQyxNQUFNLENBQUMsSUFBSSxvQkFBb0IsQ0FBQyxzQkFBc0IsVUFBVSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQztTQUNoRztRQUVELE9BQU8sSUFBSSxPQUFPLENBQUMsT0FBTyxDQUFDLEVBQUU7WUFDM0IsT0FBTyxDQUFDLElBQUksQ0FBQyxhQUFhLENBQUMsSUFBSSxDQUFDLEtBQUssRUFBRSxTQUFTLENBQUMsQ0FBQyxDQUFDO1FBQ3JELENBQUMsQ0FBQyxDQUFDLElBQUksQ0FBQyxHQUFHLEVBQUU7WUFDWCxJQUFJLENBQUMsY0FBYyxDQUFDLEtBQUssRUFBRSxDQUFDO1lBQzVCLE9BQU8sQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLGNBQWMsQ0FBQyxHQUFHLEVBQUUsSUFBSSxDQUFDLGNBQWMsQ0FBQyxDQUFDO1FBQ2hFLENBQUMsQ0FBQyxDQUFDO0lBQ0wsQ0FBQztJQUVEOzs7OztPQUtHO0lBQ0gsSUFBSSxDQUFDLFdBQW1CLHNCQUFzQjtRQUM1QyxJQUFJLENBQUMsSUFBSSxDQUFDLFlBQVksRUFBRTtZQUN0QixPQUFPLE9BQU8sQ0FBQyxNQUFNLENBQUMsSUFBSSxpQkFBaUIsQ0FBQyxzREFBc0QsQ0FBQyxDQUFDLENBQUM7U0FDdEc7UUFFRCxJQUFJLENBQUMsSUFBSSxDQUFDLGNBQWMsQ0FBQyxJQUFJLEVBQUU7WUFDN0IsT0FBTyxPQUFPLENBQUMsTUFBTSxDQUFDLElBQUksaUJBQWlCLENBQUMsa0NBQWtDLENBQUMsQ0FBQyxDQUFDO1NBQ2xGO1FBRUQsT0FBTyxPQUFPLENBQUMsR0FBRyxDQUFDLEtBQUssQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLGNBQWMsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDLE1BQXVCLEVBQUUsRUFBRTtZQUNqRixJQUFJLEVBQW9CLENBQUM7WUFFekIsd0ZBQXdGO1lBQ3hGLDhFQUE4RTtZQUM5RSxPQUFPLElBQUksT0FBTyxDQUFDLENBQUMsT0FBaUIsRUFBRSxFQUFFO2dCQUN2QyxFQUFFLEdBQUcsSUFBSSxLQUFLLENBQUMsUUFBUSxDQUFDLENBQUM7Z0JBQ3hCLEVBQVUsQ0FBQyxTQUFTLEdBQUcsT0FBTyxDQUFDO1lBQ2xDLENBQUMsQ0FBQyxDQUFDLElBQUksQ0FBQyxHQUFHLEVBQUUsQ0FBRSxFQUFVLENBQUMsU0FBUyxDQUFDLE1BQU0sQ0FBQyxRQUFRLENBQUMsQ0FBQyxJQUFJLENBQUMsR0FBRyxFQUFFLENBQUMsRUFBRSxDQUFDLElBQUksRUFBRSxDQUFDLENBQUMsQ0FBQztRQUM5RSxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBQ04sQ0FBQztDQUNGIn0=