@ale-rainbow/web-sdk 5.1.0

package/lib/services/deviceManagement/deviceManagement.service.d.ts

@@ -0,0 +1,290 @@
+/**
+ * @module DeviceManagement
+ */
+import type { Subscription } from "rxjs";
+import { RBEvent } from "../../models/event.model";
+import { Service } from "../../services/service";
+/** @internal */
+export declare const DEVICE_MANAGEMENT_SVC = "DeviceManagementService";
+/**
+ * @eventProperty
+ */
+export declare enum DeviceManagementEvents {
+    /**
+     * @eventProperty
+     * This RB event is send when the application cannot access the audio/video devices. The user should check the app / browser configuration and access to OS devices
+     */
+    ON_AUDIO_VIDEO_DEVICE_ACCESS_ERROR = "rainbowonaudiovideodeviceaccesserror",
+    /**
+     * @eventProperty
+     * This RB event is send when the application detects any kind of change in the devices list (audio input / output or video input devices)
+     * **Event Data**
+     * - **kind**: The kind of the device (audioinput, audiooutput or videoinput)
+     * - **action**: Could be added (new device is added) / removed (device is removed) / updated (the id of the device has updated)
+     */
+    ON_AUDIO_VIDEO_DEVICE_LIST_UPDATE = "rainbowonaudiovideodevicelistupdate",
+    /**
+     * @eventProperty
+     * This RB event is send when a new device is selected to be used
+     * **Event Data**
+     * - **kind**: The kind of the device (audioinput, audiooutput or videoinput)
+     * - **plugIn**: True if the new device is selected after a plug-in
+     * - **plugOut**: True if the new device is selected after a plug-out of the current device used
+     */
+    ON_NEW_AUDIO_VIDEO_DEVICE_SELECTED = "rainbowonnewaudiovideodeviceselected",
+    /**
+     * @eventProperty
+     * This RB event is send when a new secondary device is selected to be used; This is used only for incoming calls / IMs that could be played
+     * also on the secondary device, if it's activated in the settings
+     */
+    ON_NEW_SECONDARY_OUTPUT_DEVICE_SELECTED = "rainbowonnewsecondaryoutputdeviceselected"
+}
+export interface DeviceManagementService {
+    /**
+     * Return all available cameras
+     */
+    getAllCameras: () => MediaDeviceInfo[];
+    /**
+     * Return all available microphones
+     */
+    getAllMicrophones: () => MediaDeviceInfo[];
+    /**
+     * Return all available speakers
+     */
+    getAllSpeakers: () => MediaDeviceInfo[];
+    /**
+     * Return the current selected microphone (that's used in all VoIP calls)
+     */
+    getCurrentMicrophone: () => MediaDeviceInfo;
+    /**
+     * Return the current selected speaker (that's used in all VoIP calls)
+     */
+    getCurrentSpeaker: () => MediaDeviceInfo | undefined;
+    /**
+     * Return the current selected camera (that's used in all VoIP calls)
+     */
+    getCurrentCamera: () => MediaDeviceInfo;
+    /**
+     * This API can be used to modify the current camera. This will result in sending
+     * an update event of type ON_NEW_AUDIO_VIDEO_DEVICE_SELECTED
+     * @param camera - The new device to be used; Should be of type videoinput
+     */
+    setCurrentCamera: (camera: MediaDeviceInfo) => void;
+    /**
+     * This API can be used to modify the current speaker. This will result in sending
+     * an update event of type DeviceManagementEvents.ON_NEW_AUDIO_VIDEO_DEVICE_SELECTED
+     * @param speaker - The new device to be used; Should be of type audiooutput
+     */
+    setCurrentSpeaker: (speaker: MediaDeviceInfo) => void;
+    /**
+     * This API can be used to modify the current microphone. This will result in sending
+     * an update event of type ON_NEW_AUDIO_VIDEO_DEVICE_SELECTED
+     * @param microphone - The new device to be used; Should be of type audioinput
+     */
+    setCurrentMicrophone: (microphone: MediaDeviceInfo) => void;
+    /**
+     * Set the output speaker of the audio element with the given speaker.
+     * This method is useful if you're developing an audio application and want to configure
+     * the speaker to be used by an audio tag in the same way as Rainbow's audio tags.
+     * @param element - The Audio element to whom we want to change the output ID
+     * @param speaker - The speaker to be used
+     */
+    setSpeakerForAudioElement: (element: HTMLAudioElement, speaker: MediaDeviceInfo) => Promise<void>;
+    /**
+     * Subscribe to updates on the deviceManagement service (all events are of RBEvent type);
+     * @param handler - The call-back function that will be subscribed to the RxJS subject
+     * @param eventNames - a list of event names that the user wants to receive when subscribing (used a filter)
+     */
+    subscribe: (handler: (event: RBEvent<DeviceManagementEvents>) => any, eventNames?: DeviceManagementEvents | DeviceManagementEvents[]) => Subscription;
+    /**
+     * Forces the global audio element to re-seat its sinkId, even if the current device was already
+     * applied -- but only when the selected output is a Bluetooth device (detected from its label).
+     * Call this when a call's remote audio stream is about to start playing (e.g. on answer /
+     * session-accept). A sink applied minutes earlier -- typically right after the Bluetooth headset
+     * paired, before any audio ever played through it -- can end up bound to an audio session the OS
+     * has since suspended; re-issuing setSinkId() opens a fresh one.
+     */
+    refreshAudioOutputSink: () => void;
+}
+/**
+ * This service manages the input / output audio and video devices used by the application
+ * @internal
+ */
+export declare class DeviceManagementServiceRB extends Service implements DeviceManagementService {
+    private logger;
+    private webrtcConfigAndUtils;
+    private settingsService;
+    private xmppService;
+    private webHidManagerService;
+    private mainService;
+    private rxSubject;
+    private deviceWatcher;
+    private deviceChangeHandler;
+    private devicePollingInterval;
+    private lastDeviceFingerprint;
+    private xmppConnectionSubscription;
+    private audioInputDevices;
+    private audioOutputDevices;
+    private videoInputDevices;
+    private currentAudioInputDevice;
+    private currentAudioOutputDevice;
+    private currentVideoInputDevice;
+    private currentSecondaryOutputDevice;
+    private getUserMediaForAudioDone;
+    private getUserMediaForVideoDone;
+    started: boolean;
+    private manualAleDeviceSelection;
+    private permissionMonitorAbortController;
+    static getInstance(): DeviceManagementServiceRB;
+    static build(): DeviceManagementServiceRB;
+    private constructor();
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    /**
+    * Subscribe to updates on the deviceManagement service (all events are of RBEvent type);
+    * @param handler - The call-back function that will be subscribed to the RxJS subject
+    * @param filterEvent - a list of event names that the user wants to receive when subscribing (used a filter)
+    */
+    subscribe(handler: (event: RBEvent<DeviceManagementEvents>) => any, eventNames?: DeviceManagementEvents | DeviceManagementEvents[]): Subscription;
+    canUseWebHID(): boolean;
+    private sendEvent;
+    private devicesToIgnore;
+    private inputDevicesToAcceptEvenWhenNotDefault;
+    private arrayContains;
+    private getHashFromLabel;
+    private compareHashInLabel;
+    private getParenthesizedName;
+    private getBrandFromLabel;
+    /**
+     * Set the output sinkID of the audio element with the output device given
+     * @param element - The Audio element to whom we want to change the output ID
+     * @param outputDevice - The output device to be used
+     */
+    setSpeakerForAudioElement(element: HTMLAudioElement, outputDevice: MediaDeviceInfo): Promise<void>;
+    /**
+     * Return the current audio input device selected (that's used in all VoIP calls)
+     */
+    getCurrentMicrophone(): MediaDeviceInfo;
+    getCurrentMicrophoneName(): string;
+    /**
+     * This API can be used to modify the current audio input device. This will result in sending an update event of type ON_NEW_AUDIO_VIDEO_DEVICE_SELECTED
+     * @param device - The new device to be used; Should be of type audioinput
+     */
+    setCurrentMicrophone(device: MediaDeviceInfo): void;
+    /**
+     * Return all available audio input devices (type MediaDeviceInfo)
+     */
+    getAllMicrophones(): MediaDeviceInfo[];
+    /**
+     * Return the current audio output device selected (that's used in all VoIP calls)
+     */
+    getCurrentSpeaker(): MediaDeviceInfo | undefined;
+    /**
+     * This API can be used to modify the current audio output device. This will result in sending
+     * an update event of type DeviceManagementEvents.ON_NEW_AUDIO_VIDEO_DEVICE_SELECTED
+     * @param device - The new device to be used; Should be of type audiooutput
+     */
+    setCurrentSpeaker(device: MediaDeviceInfo): void;
+    /**
+     * Return all available audio output devices (type MediaDeviceInfo)
+     */
+    getAllSpeakers(): MediaDeviceInfo[];
+    /**
+     * Return the current video input device selected (that's used in all VoIP calls)
+     */
+    getCurrentCamera(): MediaDeviceInfo;
+    /**
+     * This API can be used to modify the currentvideo input device. This will result in sending an update
+     * event of type ON_NEW_AUDIO_VIDEO_DEVICE_SELECTED
+     * @param device - The new device to be used; Should be of type videoinput
+     */
+    setCurrentCamera(device: MediaDeviceInfo): void;
+    /**
+     * Return all available video input devices (type MediaDeviceInfo)
+     */
+    getAllCameras(): MediaDeviceInfo[];
+    /**
+     * Return the secondary output device to be used for incoming calls / IMs to play sound on
+     */
+    getCurrentSecondaryOutputDevice(): MediaDeviceInfo;
+    /**
+     * This API can be used to modify the secondary output device (used for incoming call ringing).
+     * This will result in sending an update event of type
+     * DeviceManagementEvents.ON_NEW_SECONDARY_OUTPUT_DEVICE_SELECTED
+     * @param device - The new device to be used; Should be of type audiooutput
+     */
+    setCurrentSecondaryOutputDevice(device: MediaDeviceInfo): void;
+    /**
+     * "default" and "communications" are not real devices: Chromium exposes them on Windows as
+     * aliases that always follow the OS "Default device" / "Default communication device".
+     * They must never be used for the secondary ringer, otherwise the ringing tone follows the
+     * headset as soon as one is plugged (the headset becomes the OS communication device), which
+     * defeats the whole purpose of the secondary ringer -- CRRAINB-54478.
+     * The settings picker already filters them out for the same reason.
+     * @param device - the device to test
+     */
+    private isPseudoOutputDevice;
+    /**
+     * Choose a secondary output device among the currently available ones: a real device
+     * (never a "default"/"communications" alias), preferably not the one already used for the
+     * call audio. Returns null when no real output device is available.
+     */
+    private pickSecondaryOutputDevice;
+    /**
+     * Make sure the secondary output device still points to a real, still-connected device.
+     * Called after every audio output device list change: a "default"/"communications" alias
+     * silently re-targets itself to the new OS device (typically a freshly plugged headset),
+     * so it must be replaced by a real device -- CRRAINB-54478.
+     * @returns true when the secondary output device has been replaced
+     */
+    private ensureRealSecondaryOutputDevice;
+    private startDeviceWatcher;
+    private pollDeviceChange;
+    checkDeviceList(): Promise<void>;
+    private testGetUserMedia;
+    private monitorMediaPermission;
+    private isDeviceSelectedByDefaultByOS;
+    private isAleManagedDevice;
+    private updateAleManagedDeviceFlag;
+    private getAleManagedDeviceFromList;
+    /**
+     * Called when we need to update the current audio input device (the device has been disconnected or null before)
+     * We set the device to the "default" one by the system;
+     * In case there're several devices with the same groupID, we choose the last one in the list;
+     * @param tempAudioInputDevices - the list of audio input devices currently connected/detected
+     */
+    private updateCurrentAudioInputDevice;
+    /**
+     * This function watches for any changes on the audio input devices list change;
+     * Could be related to the number of input devices (connected or disconnected) or change of ID on some of the devices
+     * @param tempAudioInputDevices - [required] the list of audio input devices currently connected/detected
+     */
+    private updateCurrentAudioInputDevices;
+    /**
+     * Called when we need to update the current audio output device (the device has been disconnected or null before)
+     * Try to find the same device as the current input device, if possible and then use it; Otherwise go to communiocations or default device;
+     * @param tempAudioOutputDevices - the list of audio output devices currently connected/detected
+     */
+    private updateCurrentAudioOutputDevice;
+    /**
+     * Applies setSinkId on the element, swallowing any failure.
+     * @returns true if the sink was applied, false if it threw (e.g. AbortError on device churn)
+     */
+    private trySetSinkId;
+    refreshAudioOutputSink(): void;
+    private isBluetoothOutputDevice;
+    private setGlobalTagSinkId;
+    /**
+     * This function watches for any changes on the audio output devices list change;
+     * Could be related to the number of output devices (connected or disconnected) or change of ID on some of the devices
+     * @param tempAudioOutputDevices - the list of audio output devices currently connected/detected
+     */
+    private updateCurrentAudioOutputDevices;
+    /**
+     * Called when we need to update the current video input device (the device has been disconnected or null before)
+     * @param tempVideoInputDevices - the list of video input devices currently connected/detected
+     */
+    private updateCurrentVideoInputDevice;
+    private updateCurrentVideoInputDevices;
+}
+//# sourceMappingURL=deviceManagement.service.d.ts.map

package/lib/services/deviceManagement/deviceManagement.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deviceManagement.service.d.ts","sourceRoot":"","sources":["../../../src/services/deviceManagement/deviceManagement.service.ts"],"names":[],"mappings":"AAGA;;GAEG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAEzC,OAAO,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAC;AAKlE,OAAO,EAAE,OAAO,EAAE,MAAM,uCAAuC,CAAC;AAOhE,gBAAgB;AAChB,eAAO,MAAM,qBAAqB,4BAA4B,CAAC;AAE/D;;GAEG;AACH,oBAAY,sBAAsB;IAE9B;;;OAGG;IACH,kCAAkC,yCAAyC;IAE3E;;;;;;OAMG;IACH,iCAAiC,wCAAwC;IAEzE;;;;;;;OAOG;IACH,kCAAkC,yCAAyC;IAE3E;;;;OAIG;IACH,uCAAuC,8CAA8C;CACxF;AAED,MAAM,WAAW,uBAAuB;IAEpC;;OAEG;IACH,aAAa,EAAE,MAAM,eAAe,EAAE,CAAC;IAEvC;;OAEG;IACH,iBAAiB,EAAE,MAAM,eAAe,EAAE,CAAC;IAE3C;;OAEG;IACH,cAAc,EAAE,MAAM,eAAe,EAAE,CAAC;IAExC;;OAEG;IACH,oBAAoB,EAAE,MAAM,eAAe,CAAC;IAE5C;;OAEG;IACH,iBAAiB,EAAE,MAAM,eAAe,GAAG,SAAS,CAAC;IAErD;;OAEG;IACH,gBAAgB,EAAE,MAAM,eAAe,CAAC;IAExC;;;;OAIG;IACH,gBAAgB,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,IAAI,CAAC;IAEpD;;;;OAIG;IACH,iBAAiB,EAAE,CAAC,OAAO,EAAE,eAAe,KAAK,IAAI,CAAC;IAEtD;;;;OAIG;IACH,oBAAoB,EAAE,CAAC,UAAU,EAAE,eAAe,KAAK,IAAI,CAAC;IAE5D;;;;;;OAMG;IACH,yBAAyB,EAAE,CAAC,OAAO,EAAE,gBAAgB,EAAE,OAAO,EAAE,eAAe,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAElG;;;;OAIG;IACH,SAAS,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,sBAAsB,CAAC,KAAK,GAAG,EAAE,UAAU,CAAC,EAAE,sBAAsB,GAAG,sBAAsB,EAAE,KAAK,YAAY,CAAC;IAEtJ;;;;;;;OAOG;IACH,sBAAsB,EAAE,MAAM,IAAI,CAAC;CACtC;AA8RD;;;GAGG;AACH,qBAAa,yBAA0B,SAAQ,OAAQ,YAAW,uBAAuB;IACrF,OAAO,CAAC,MAAM,CAA8C;IAC5D,OAAO,CAAC,oBAAoB,CAA4D;IACxF,OAAO,CAAC,eAAe,CAAkD;IACzE,OAAO,CAAC,WAAW,CAA0C;IAC7D,OAAO,CAAC,oBAAoB,CAAgE;IAC5F,OAAO,CAAC,WAAW,CAA0C;IAC7D,OAAO,CAAC,SAAS,CAAoC;IACrD,OAAO,CAAC,aAAa,CAAa;IAClC,OAAO,CAAC,mBAAmB,CAA6B;IACxD,OAAO,CAAC,qBAAqB,CAA+C;IAC5E,OAAO,CAAC,qBAAqB,CAAuB;IACpD,OAAO,CAAC,0BAA0B,CAAe;IACjD,OAAO,CAAC,iBAAiB,CAAyB;IAClD,OAAO,CAAC,kBAAkB,CAAyB;IACnD,OAAO,CAAC,iBAAiB,CAAyB;IAElD,OAAO,CAAC,uBAAuB,CAAyB;IACxD,OAAO,CAAC,wBAAwB,CAAyB;IACzD,OAAO,CAAC,uBAAuB,CAAyB;IACxD,OAAO,CAAC,4BAA4B,CAAyB;IAE7D,OAAO,CAAC,wBAAwB,CAAkB;IAClD,OAAO,CAAC,wBAAwB,CAAkB;IAE3C,OAAO,EAAE,OAAO,CAAS;IAEhC,OAAO,CAAC,wBAAwB,CAAkB;IAElD,OAAO,CAAC,gCAAgC,CAAgC;WAE1D,WAAW;WAIX,KAAK;IAInB,OAAO;IAEM,KAAK;IAwCL,IAAI;IAoBjB;;;;MAIE;IACK,SAAS,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,sBAAsB,CAAC,KAAK,GAAG,EAAE,UAAU,CAAC,EAAE,sBAAsB,GAAG,sBAAsB,EAAE,GAAG,YAAY;IAWjJ,YAAY,IAAI,OAAO;IAK9B,OAAO,CAAC,SAAS;IAUjB,OAAO,CAAC,eAAe,CAA8K;IACrM,OAAO,CAAC,sCAAsC,CAAwE;IAEtH,OAAO,CAAC,aAAa;IAOrB,OAAO,CAAC,gBAAgB;IAexB,OAAO,CAAC,kBAAkB;IAS1B,OAAO,CAAC,oBAAoB;IAW5B,OAAO,CAAC,iBAAiB;IAKzB;;;;OAIG;IACU,yBAAyB,CAAC,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,eAAe;IAgC/F;;OAEG;IACI,oBAAoB,IAAI,eAAe;IAIvC,wBAAwB,IAAI,MAAM;IA2CzC;;;OAGG;IACI,oBAAoB,CAAC,MAAM,EAAE,eAAe,GAAG,IAAI;IAQ1D;;OAEG;IACI,iBAAiB,IAAI,eAAe,EAAE;IAI7C;;OAEG;IACI,iBAAiB,IAAI,eAAe,GAAG,SAAS;IAIvD;;;;OAIG;IACI,iBAAiB,CAAC,MAAM,EAAE,eAAe,GAAG,IAAI;IAcvD;;OAEG;IACI,cAAc,IAAI,eAAe,EAAE;IAI1C;;OAEG;IACI,gBAAgB,IAAI,eAAe;IAI1C;;;;OAIG;IACI,gBAAgB,CAAC,MAAM,EAAE,eAAe,GAAG,IAAI;IAQtD;;OAEG;IACI,aAAa,IAAI,eAAe,EAAE;IAIzC;;OAEG;IACI,+BAA+B,IAAI,eAAe;IAIzD;;;;;OAKG;IACI,+BAA+B,CAAC,MAAM,EAAE,eAAe,GAAG,IAAI;IAQrE;;;;;;;;OAQG;IACH,OAAO,CAAC,oBAAoB;IAI5B;;;;OAIG;IACH,OAAO,CAAC,yBAAyB;IASjC;;;;;;OAMG;IACH,OAAO,CAAC,+BAA+B;IAuBvC,OAAO,CAAC,kBAAkB;YAyBZ,gBAAgB;IAejB,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;YA4E/B,gBAAgB;YAqChB,sBAAsB;IAcpC,OAAO,CAAC,6BAA6B;IAqBrC,OAAO,CAAC,kBAAkB;IAM1B,OAAO,CAAC,0BAA0B;IAKlC,OAAO,CAAC,2BAA2B;IAqBnC;;;;;OAKG;IACH,OAAO,CAAC,6BAA6B;IA8BrC;;;;OAIG;IACH,OAAO,CAAC,8BAA8B;IAsRtC;;;;OAIG;IACH,OAAO,CAAC,8BAA8B;IAqDtC;;;OAGG;YACW,YAAY;IAUnB,sBAAsB,IAAI,IAAI;IAMrC,OAAO,CAAC,uBAAuB;YAIjB,kBAAkB;IAkDhC;;;;OAIG;IACH,OAAO,CAAC,+BAA+B;IAgZvC;;;OAGG;IACH,OAAO,CAAC,6BAA6B;IAkBrC,OAAO,CAAC,8BAA8B;CA0JzC"}

package/lib/services/deviceManagement/index.d.ts

@@ -0,0 +1,2 @@
+export { type DeviceManagementService, DeviceManagementEvents, DEVICE_MANAGEMENT_SVC } from "./deviceManagement.service";
+//# sourceMappingURL=index.d.ts.map

package/lib/services/deviceManagement/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/services/deviceManagement/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,uBAAuB,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC"}