@webex/internal-media-core 2.2.1 → 2.2.2

package/dist/cjs/index.js

@@ -2806,7 +2806,7 @@ return devices.filter(device=>deviceKinds.includes(device.kind)).every(device=>d
 // (Firefox) will allow the user to access device information.
 var callbackRes=yield callback();// Stop tracks in the stream so the browser (Safari) will know that there is not an active
 // stream running.
-stream.getTracks().forEach(track=>track.stop());return callbackRes;}return callback();}catch(e){logger$3.error(e);throw new Error('Failed to ensure device permissions.');}});}var media=/*#__PURE__*/Object.freeze({__proto__:null,get DeviceKind(){return DeviceKind;},getUserMedia:getUserMedia,getDisplayMedia:getDisplayMedia,enumerateDevices:enumerateDevices,setOnDeviceChangeHandler:setOnDeviceChangeHandler$1,checkDevicePermissions:checkDevicePermissions,ensureDevicePermissions:ensureDevicePermissions});var WebrtcCoreErrorType;(function(WebrtcCoreErrorType){WebrtcCoreErrorType["DEVICE_PERMISSION_DENIED"]="DEVICE_PERMISSION_DENIED";WebrtcCoreErrorType["CREATE_STREAM_FAILED"]="CREATE_STREAM_FAILED";})(WebrtcCoreErrorType||(WebrtcCoreErrorType={}));/**
+stream.getTracks().forEach(track=>track.stop());return callbackRes;}return callback();}catch(e){logger$3.error(e);throw new Error('Failed to ensure device permissions.');}});}var media=/*#__PURE__*/Object.freeze({__proto__:null,get DeviceKind(){return DeviceKind;},getUserMedia:getUserMedia,getDisplayMedia:getDisplayMedia,enumerateDevices:enumerateDevices,setOnDeviceChangeHandler:setOnDeviceChangeHandler$1,checkDevicePermissions:checkDevicePermissions,ensureDevicePermissions:ensureDevicePermissions});var WebrtcCoreErrorType;(function(WebrtcCoreErrorType){WebrtcCoreErrorType["DEVICE_PERMISSION_DENIED"]="DEVICE_PERMISSION_DENIED";WebrtcCoreErrorType["CREATE_STREAM_FAILED"]="CREATE_STREAM_FAILED";WebrtcCoreErrorType["ADD_EFFECT_FAILED"]="ADD_EFFECT_FAILED";})(WebrtcCoreErrorType||(WebrtcCoreErrorType={}));/**
  * Represents a WebRTC core error, which contains error type and error message.
  */class WebrtcCoreError{/**
      * Creates new error.
@@ -2923,13 +2923,13 @@ this[_a$1$1]=new TypedEvent$1();this[_b$1]=new TypedEvent$1();this.outputStream=
      * Get the track of the output stream.
      *
      * @returns The output track.
-     */get outputTrack(){return this.outputStream.getTracks()[0];}}_a$1$1=exports.StreamEventNames.MuteStateChange,_b$1=exports.StreamEventNames.Ended;var Stream=AddEvents(_Stream);var _a$6$1,_b;exports.LocalStreamEventNames = void 0;(function(LocalStreamEventNames){LocalStreamEventNames["ConstraintsChange"]="constraints-change";LocalStreamEventNames["OutputTrackChange"]="output-track-change";})(exports.LocalStreamEventNames||(exports.LocalStreamEventNames={}));/**
+     */get outputTrack(){return this.outputStream.getTracks()[0];}}_a$1$1=exports.StreamEventNames.MuteStateChange,_b$1=exports.StreamEventNames.Ended;var Stream=AddEvents(_Stream);var _a$6$1,_b,_c;exports.LocalStreamEventNames = void 0;(function(LocalStreamEventNames){LocalStreamEventNames["ConstraintsChange"]="constraints-change";LocalStreamEventNames["OutputTrackChange"]="output-track-change";LocalStreamEventNames["EffectAdded"]="effect-added";})(exports.LocalStreamEventNames||(exports.LocalStreamEventNames={}));/**
  * A stream which originates on the local device.
  */class _LocalStream extends Stream{/**
      * Create a LocalStream from the given values.
      *
      * @param stream - The initial output MediaStream for this Stream.
-     */constructor(stream){super(stream);this[_a$6$1]=new TypedEvent$1();this[_b]=new TypedEvent$1();this.effects=[];this.loadingEffects=new Map();this.inputStream=stream;}/**
+     */constructor(stream){super(stream);this[_a$6$1]=new TypedEvent$1();this[_b]=new TypedEvent$1();this[_c]=new TypedEvent$1();this.effects=[];this.loadingEffects=new Map();this.inputStream=stream;}/**
      * Get the track within the MediaStream with which this LocalStream was created.
      *
      * @returns The track within the MediaStream with which this LocalStream
@@ -2969,28 +2969,52 @@ if(this.inputTrack.id===this.outputTrack.id){this.inputStream=this.outputStream;
 this[exports.StreamEventNames.Ended].emit();}/**
      * Adds an effect to a local stream.
      *
-     * @param name - The name of the effect.
      * @param effect - The effect to add.
-     */addEffect(name,effect){return __awaiter$2(this,void 0,void 0,function*(){// Load the effect
-this.loadingEffects.set(name,effect);var outputTrack=yield effect.load(this.outputTrack);// Check that the loaded effect is the latest one and dispose if not
-if(effect!==this.loadingEffects.get(name)){yield effect.dispose();throw new Error("Effect \"".concat(name,"\" not required after loading"));}// Use the effect
-this.loadingEffects.delete(name);this.effects.push({name,effect});this.changeOutputTrack(outputTrack);// When the effect's track is updated, update the next effect or output stream.
-// TODO: using EffectEvent.TrackUpdated will cause the entire web-media-effects lib to be built
-// and makes the size of the webrtc-core build much larger, so we use type assertion here as a
-// temporary workaround.
-effect.on('track-updated',track=>{var _c;var effectIndex=this.effects.findIndex(e=>e.name===name);if(effectIndex===this.effects.length-1){this.changeOutputTrack(track);}else {(_c=this.effects[effectIndex+1])===null||_c===void 0?void 0:_c.effect.replaceInputTrack(track);}});});}/**
-     * Get an effect from the effects list.
+     */addEffect(effect){return __awaiter$2(this,void 0,void 0,function*(){// Check if the effect has already been added.
+if(this.effects.some(e=>e.id===effect.id)){return;}// Load the effect. Because loading is asynchronous, keep track of the loading effects.
+this.loadingEffects.set(effect.kind,effect);yield effect.load(this.outputTrack);// After loading, check whether or not we still want to use this effect. If another effect of
+// the same kind was added while this effect was loading, we only want to use the latest effect,
+// so dispose this one. If the effects list was cleared while this effect was loading, also
+// dispose it.
+if(effect!==this.loadingEffects.get(effect.kind)){yield effect.dispose();throw new WebrtcCoreError(WebrtcCoreErrorType.ADD_EFFECT_FAILED,"Another effect with kind ".concat(effect.kind," was added while effect ").concat(effect.id," was loading, or the effects list was cleared."));}this.loadingEffects.delete(effect.kind);/**
+             * Handle when the effect's output track has been changed. This will update the input of the
+             * next effect in the effects list of the output of the stream.
+             *
+             * @param track - The new output track of the effect.
+             */var handleEffectTrackUpdated=track=>{var _d;var effectIndex=this.effects.findIndex(e=>e.id===effect.id);if(effectIndex===this.effects.length-1){this.changeOutputTrack(track);}else if(effectIndex>=0){(_d=this.effects[effectIndex+1])===null||_d===void 0?void 0:_d.replaceInputTrack(track);}else {logger$3.error("Effect with ID ".concat(effect.id," not found in effects list."));}};/**
+             * Handle when the effect has been disposed. This will remove all event listeners from the
+             * effect.
+             */var handleEffectDisposed=()=>{effect.off('track-updated',handleEffectTrackUpdated);effect.off('disposed',handleEffectDisposed);};// TODO: using EffectEvent.TrackUpdated or EffectEvent.Disposed will cause the entire
+// web-media-effects lib to be rebuilt and inflates the size of the webrtc-core build, so
+// we use type assertion here as a temporary workaround.
+effect.on('track-updated',handleEffectTrackUpdated);effect.on('disposed',handleEffectDisposed);// Add the effect to the effects list. If an effect of the same kind has already been added,
+// dispose the existing effect and replace it with the new effect. If the existing effect was
+// enabled, also enable the new effect.
+var existingEffectIndex=this.effects.findIndex(e=>e.kind===effect.kind);if(existingEffectIndex>=0){var[existingEffect]=this.effects.splice(existingEffectIndex,1,effect);if(existingEffect.isEnabled){// If the existing effect is not the first effect in the effects list, then the input of the
+// new effect should be the output of the previous effect in the effects list. We know the
+// output track of the previous effect must exist because it must have been loaded (and all
+// loaded effects have an output track).
+var inputTrack=existingEffectIndex===0?this.inputTrack:this.effects[existingEffectIndex-1].getOutputTrack();yield effect.replaceInputTrack(inputTrack);// Enabling the new effect will trigger the track-updated event, which will handle the new
+// effect's updated output track.
+yield effect.enable();}yield existingEffect.dispose();}else {this.effects.push(effect);}// Emit an event with the effect so others can listen to the effect events.
+this[exports.LocalStreamEventNames.EffectAdded].emit(effect);});}/**
+     * Get an effect from the effects list by ID.
      *
-     * @param name - The name of the effect you want to get.
+     * @param id - The id of the effect you want to get.
      * @returns The effect or undefined.
-     */getEffect(name){var _c;return (_c=this.effects.find(e=>e.name===name))===null||_c===void 0?void 0:_c.effect;}/**
+     */getEffectById(id){return this.effects.find(effect=>effect.id===id);}/**
+     * Get an effect from the effects list by kind.
+     *
+     * @param kind - The kind of the effect you want to get.
+     * @returns The effect or undefined.
+     */getEffectByKind(kind){return this.effects.find(effect=>effect.kind===kind);}/**
      * Get all the effects from the effects list.
      *
-     * @returns A list of effect items, each containing the name and the effect itself.
-     */getAllEffects(){return this.effects;}/**
+     * @returns A list of effects.
+     */getEffects(){return this.effects;}/**
      * Cleanup the local effects.
      */disposeEffects(){return __awaiter$2(this,void 0,void 0,function*(){this.loadingEffects.clear();// Dispose of any effects currently in use
-if(this.effects.length>0){this.changeOutputTrack(this.inputTrack);yield Promise.all(this.effects.map(item=>item.effect.dispose()));this.effects=[];}});}}_a$6$1=exports.LocalStreamEventNames.ConstraintsChange,_b=exports.LocalStreamEventNames.OutputTrackChange;var LocalStream=AddEvents(_LocalStream);/**
+if(this.effects.length>0){this.changeOutputTrack(this.inputTrack);yield Promise.all(this.effects.map(effect=>effect.dispose()));this.effects=[];}});}}_a$6$1=exports.LocalStreamEventNames.ConstraintsChange,_b=exports.LocalStreamEventNames.OutputTrackChange,_c=exports.LocalStreamEventNames.EffectAdded;var LocalStream=AddEvents(_LocalStream);/**
  * An audio LocalStream.
  */class LocalAudioStream extends LocalStream{/**
      * Apply constraints to the stream.

package/dist/esm/index.js

@@ -2795,7 +2795,7 @@ return devices.filter(device=>deviceKinds.includes(device.kind)).every(device=>d
 // (Firefox) will allow the user to access device information.
 var callbackRes=yield callback();// Stop tracks in the stream so the browser (Safari) will know that there is not an active
 // stream running.
-stream.getTracks().forEach(track=>track.stop());return callbackRes;}return callback();}catch(e){logger$3.error(e);throw new Error('Failed to ensure device permissions.');}});}var media=/*#__PURE__*/Object.freeze({__proto__:null,get DeviceKind(){return DeviceKind;},getUserMedia:getUserMedia,getDisplayMedia:getDisplayMedia,enumerateDevices:enumerateDevices,setOnDeviceChangeHandler:setOnDeviceChangeHandler$1,checkDevicePermissions:checkDevicePermissions,ensureDevicePermissions:ensureDevicePermissions});var WebrtcCoreErrorType;(function(WebrtcCoreErrorType){WebrtcCoreErrorType["DEVICE_PERMISSION_DENIED"]="DEVICE_PERMISSION_DENIED";WebrtcCoreErrorType["CREATE_STREAM_FAILED"]="CREATE_STREAM_FAILED";})(WebrtcCoreErrorType||(WebrtcCoreErrorType={}));/**
+stream.getTracks().forEach(track=>track.stop());return callbackRes;}return callback();}catch(e){logger$3.error(e);throw new Error('Failed to ensure device permissions.');}});}var media=/*#__PURE__*/Object.freeze({__proto__:null,get DeviceKind(){return DeviceKind;},getUserMedia:getUserMedia,getDisplayMedia:getDisplayMedia,enumerateDevices:enumerateDevices,setOnDeviceChangeHandler:setOnDeviceChangeHandler$1,checkDevicePermissions:checkDevicePermissions,ensureDevicePermissions:ensureDevicePermissions});var WebrtcCoreErrorType;(function(WebrtcCoreErrorType){WebrtcCoreErrorType["DEVICE_PERMISSION_DENIED"]="DEVICE_PERMISSION_DENIED";WebrtcCoreErrorType["CREATE_STREAM_FAILED"]="CREATE_STREAM_FAILED";WebrtcCoreErrorType["ADD_EFFECT_FAILED"]="ADD_EFFECT_FAILED";})(WebrtcCoreErrorType||(WebrtcCoreErrorType={}));/**
  * Represents a WebRTC core error, which contains error type and error message.
  */class WebrtcCoreError{/**
      * Creates new error.
@@ -2912,13 +2912,13 @@ this[_a$1$1]=new TypedEvent$1();this[_b$1]=new TypedEvent$1();this.outputStream=
      * Get the track of the output stream.
      *
      * @returns The output track.
-     */get outputTrack(){return this.outputStream.getTracks()[0];}}_a$1$1=StreamEventNames.MuteStateChange,_b$1=StreamEventNames.Ended;var Stream=AddEvents(_Stream);var _a$6$1,_b;var LocalStreamEventNames;(function(LocalStreamEventNames){LocalStreamEventNames["ConstraintsChange"]="constraints-change";LocalStreamEventNames["OutputTrackChange"]="output-track-change";})(LocalStreamEventNames||(LocalStreamEventNames={}));/**
+     */get outputTrack(){return this.outputStream.getTracks()[0];}}_a$1$1=StreamEventNames.MuteStateChange,_b$1=StreamEventNames.Ended;var Stream=AddEvents(_Stream);var _a$6$1,_b,_c;var LocalStreamEventNames;(function(LocalStreamEventNames){LocalStreamEventNames["ConstraintsChange"]="constraints-change";LocalStreamEventNames["OutputTrackChange"]="output-track-change";LocalStreamEventNames["EffectAdded"]="effect-added";})(LocalStreamEventNames||(LocalStreamEventNames={}));/**
  * A stream which originates on the local device.
  */class _LocalStream extends Stream{/**
      * Create a LocalStream from the given values.
      *
      * @param stream - The initial output MediaStream for this Stream.
-     */constructor(stream){super(stream);this[_a$6$1]=new TypedEvent$1();this[_b]=new TypedEvent$1();this.effects=[];this.loadingEffects=new Map();this.inputStream=stream;}/**
+     */constructor(stream){super(stream);this[_a$6$1]=new TypedEvent$1();this[_b]=new TypedEvent$1();this[_c]=new TypedEvent$1();this.effects=[];this.loadingEffects=new Map();this.inputStream=stream;}/**
      * Get the track within the MediaStream with which this LocalStream was created.
      *
      * @returns The track within the MediaStream with which this LocalStream
@@ -2958,28 +2958,52 @@ if(this.inputTrack.id===this.outputTrack.id){this.inputStream=this.outputStream;
 this[StreamEventNames.Ended].emit();}/**
      * Adds an effect to a local stream.
      *
-     * @param name - The name of the effect.
      * @param effect - The effect to add.
-     */addEffect(name,effect){return __awaiter$2(this,void 0,void 0,function*(){// Load the effect
-this.loadingEffects.set(name,effect);var outputTrack=yield effect.load(this.outputTrack);// Check that the loaded effect is the latest one and dispose if not
-if(effect!==this.loadingEffects.get(name)){yield effect.dispose();throw new Error("Effect \"".concat(name,"\" not required after loading"));}// Use the effect
-this.loadingEffects.delete(name);this.effects.push({name,effect});this.changeOutputTrack(outputTrack);// When the effect's track is updated, update the next effect or output stream.
-// TODO: using EffectEvent.TrackUpdated will cause the entire web-media-effects lib to be built
-// and makes the size of the webrtc-core build much larger, so we use type assertion here as a
-// temporary workaround.
-effect.on('track-updated',track=>{var _c;var effectIndex=this.effects.findIndex(e=>e.name===name);if(effectIndex===this.effects.length-1){this.changeOutputTrack(track);}else {(_c=this.effects[effectIndex+1])===null||_c===void 0?void 0:_c.effect.replaceInputTrack(track);}});});}/**
-     * Get an effect from the effects list.
+     */addEffect(effect){return __awaiter$2(this,void 0,void 0,function*(){// Check if the effect has already been added.
+if(this.effects.some(e=>e.id===effect.id)){return;}// Load the effect. Because loading is asynchronous, keep track of the loading effects.
+this.loadingEffects.set(effect.kind,effect);yield effect.load(this.outputTrack);// After loading, check whether or not we still want to use this effect. If another effect of
+// the same kind was added while this effect was loading, we only want to use the latest effect,
+// so dispose this one. If the effects list was cleared while this effect was loading, also
+// dispose it.
+if(effect!==this.loadingEffects.get(effect.kind)){yield effect.dispose();throw new WebrtcCoreError(WebrtcCoreErrorType.ADD_EFFECT_FAILED,"Another effect with kind ".concat(effect.kind," was added while effect ").concat(effect.id," was loading, or the effects list was cleared."));}this.loadingEffects.delete(effect.kind);/**
+             * Handle when the effect's output track has been changed. This will update the input of the
+             * next effect in the effects list of the output of the stream.
+             *
+             * @param track - The new output track of the effect.
+             */var handleEffectTrackUpdated=track=>{var _d;var effectIndex=this.effects.findIndex(e=>e.id===effect.id);if(effectIndex===this.effects.length-1){this.changeOutputTrack(track);}else if(effectIndex>=0){(_d=this.effects[effectIndex+1])===null||_d===void 0?void 0:_d.replaceInputTrack(track);}else {logger$3.error("Effect with ID ".concat(effect.id," not found in effects list."));}};/**
+             * Handle when the effect has been disposed. This will remove all event listeners from the
+             * effect.
+             */var handleEffectDisposed=()=>{effect.off('track-updated',handleEffectTrackUpdated);effect.off('disposed',handleEffectDisposed);};// TODO: using EffectEvent.TrackUpdated or EffectEvent.Disposed will cause the entire
+// web-media-effects lib to be rebuilt and inflates the size of the webrtc-core build, so
+// we use type assertion here as a temporary workaround.
+effect.on('track-updated',handleEffectTrackUpdated);effect.on('disposed',handleEffectDisposed);// Add the effect to the effects list. If an effect of the same kind has already been added,
+// dispose the existing effect and replace it with the new effect. If the existing effect was
+// enabled, also enable the new effect.
+var existingEffectIndex=this.effects.findIndex(e=>e.kind===effect.kind);if(existingEffectIndex>=0){var[existingEffect]=this.effects.splice(existingEffectIndex,1,effect);if(existingEffect.isEnabled){// If the existing effect is not the first effect in the effects list, then the input of the
+// new effect should be the output of the previous effect in the effects list. We know the
+// output track of the previous effect must exist because it must have been loaded (and all
+// loaded effects have an output track).
+var inputTrack=existingEffectIndex===0?this.inputTrack:this.effects[existingEffectIndex-1].getOutputTrack();yield effect.replaceInputTrack(inputTrack);// Enabling the new effect will trigger the track-updated event, which will handle the new
+// effect's updated output track.
+yield effect.enable();}yield existingEffect.dispose();}else {this.effects.push(effect);}// Emit an event with the effect so others can listen to the effect events.
+this[LocalStreamEventNames.EffectAdded].emit(effect);});}/**
+     * Get an effect from the effects list by ID.
      *
-     * @param name - The name of the effect you want to get.
+     * @param id - The id of the effect you want to get.
      * @returns The effect or undefined.
-     */getEffect(name){var _c;return (_c=this.effects.find(e=>e.name===name))===null||_c===void 0?void 0:_c.effect;}/**
+     */getEffectById(id){return this.effects.find(effect=>effect.id===id);}/**
+     * Get an effect from the effects list by kind.
+     *
+     * @param kind - The kind of the effect you want to get.
+     * @returns The effect or undefined.
+     */getEffectByKind(kind){return this.effects.find(effect=>effect.kind===kind);}/**
      * Get all the effects from the effects list.
      *
-     * @returns A list of effect items, each containing the name and the effect itself.
-     */getAllEffects(){return this.effects;}/**
+     * @returns A list of effects.
+     */getEffects(){return this.effects;}/**
      * Cleanup the local effects.
      */disposeEffects(){return __awaiter$2(this,void 0,void 0,function*(){this.loadingEffects.clear();// Dispose of any effects currently in use
-if(this.effects.length>0){this.changeOutputTrack(this.inputTrack);yield Promise.all(this.effects.map(item=>item.effect.dispose()));this.effects=[];}});}}_a$6$1=LocalStreamEventNames.ConstraintsChange,_b=LocalStreamEventNames.OutputTrackChange;var LocalStream=AddEvents(_LocalStream);/**
+if(this.effects.length>0){this.changeOutputTrack(this.inputTrack);yield Promise.all(this.effects.map(effect=>effect.dispose()));this.effects=[];}});}}_a$6$1=LocalStreamEventNames.ConstraintsChange,_b=LocalStreamEventNames.OutputTrackChange,_c=LocalStreamEventNames.EffectAdded;var LocalStream=AddEvents(_LocalStream);/**
  * An audio LocalStream.
  */class LocalAudioStream extends LocalStream{/**
      * Apply constraints to the stream.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/internal-media-core",
-  "version": "2.2.1",
+  "version": "2.2.2",
   "files": [
     "dist/cjs",
     "dist/esm",
@@ -46,7 +46,7 @@
   "dependencies": {
     "@babel/runtime": "^7.18.9",
     "@webex/ts-sdp": "1.6.0",
-    "@webex/web-client-media-engine": "3.11.0",
+    "@webex/web-client-media-engine": "3.11.1",
     "detectrtc": "^1.4.1",
     "events": "^3.3.0",
     "typed-emitter": "^2.1.0",