@ale-rainbow/web-sdk 5.1.0

package/lib/services/call/callRecorder.service.d.ts

@@ -0,0 +1,358 @@
+import type { Call } from "../../models/call.model";
+import type { Subscription } from "rxjs";
+import { Service } from "../../services/service";
+import type { FileDescriptor } from "../../models/common";
+import type { Contact } from "../../models/contact.model";
+import { CallServiceRB } from "./call.service";
+import { FileDocumentServiceRB } from "../fileDocument/fileDocument.service";
+export declare const CALL_RECORDER_SVC = "CallRecorderService";
+export declare enum CallRecorderServiceEvents {
+    /**
+     * @eventProperty
+     * Fired when the recorder starts capturing the call audio/video.
+     * Fired also when the distant is starting to record the call
+     */
+    RECORDING_STARTED = "recordingStarted",
+    /**
+     * @eventProperty
+     * Fired when the recorder has stopped and the recording session is over
+     * Fired also when the distant stop to record the call
+     */
+    RECORDING_ENDED = "recordingEnded",
+    /**
+     * @eventProperty
+     * Fired when the recording is paused.
+     * Fired also when the distant pauses the recording of the call
+     */
+    RECORDING_PAUSED = "recordingPaused",
+    /**
+     * @eventProperty
+     * Fired when a paused recording is resumed.
+     * Fired also when the distant resumes the recording of the call
+     */
+    RECORDING_RESUMED = "recordingResumed",
+    /**
+     * @eventProperty
+     * The recording is in progress.
+     */
+    RECORDING_IS_IN_PROGRESS = "recordingInProgress",
+    /**
+     * @eventProperty
+     * The recording is available in storage.
+     */
+    RECORDING_IS_AVAILABLE_IN_STORAGE = "recordingIsAvailableInStorage",
+    /**
+     * @eventProperty
+     * The recording is saved on pc.
+     */
+    RECORDING_SAVED_ON_PC = "recordingSavedOnPc",
+    /**
+     * @eventProperty
+     * The recording failed and no file could be produced (start error, mid-recording
+     * MediaRecorder error, or empty recording). Previously such failures were silent.
+     */
+    RECORDING_FAILED = "recordingFailed",
+    /**
+     * @eventProperty
+     * Fired 15 minutes before the recording reaches its maximum allowed duration, to warn the user
+     * that it will be stopped automatically.
+     */
+    RECORDING_MAX_DURATION_WARNING = "recordingMaxDurationWarning",
+    /**
+     * @eventProperty
+     * Fired when the recording reached its maximum allowed duration: it is stopped and saved automatically.
+     */
+    RECORDING_MAX_DURATION_REACHED = "recordingMaxDurationReached",
+    /**
+     * @eventProperty
+     * Fired when an ongoing recording is stopped and saved automatically because the call ended.
+     */
+    RECORDING_STOPPED_CALL_ENDED = "recordingStoppedCallEnded"
+}
+export interface CallRecorderInstance {
+    /**
+     * The id of the CallRecorderInstance.
+     */
+    id: string;
+    /**
+     *  This 'mediaRecorder' is the MediaRecorder instance used to record the call.
+     *  It is created when the recording starts and used to manage the recording process.
+    */
+    mediaRecorder?: MediaRecorder;
+    /**
+     *  This 'audioContext' is the AudioContext instance used to manage audio processing.
+     *  It is created when the recording starts and used to handle audio streams.
+    */
+    audioContext: AudioContext;
+    /**
+     *  This 'subscriptions' is an array of subscriptions used to manage the lifecycle of the call recorder instance.
+     */
+    subscriptions?: Subscription[];
+    /**
+     *  This 'data' is the Blob instance that contains the recorded data.
+    */
+    data?: Blob;
+    /**
+     *  This 'chunks' accumulates the Blob chunks emitted by the MediaRecorder timeslice.
+     *  They are assembled into 'data' only once, when the recording stops, to avoid keeping
+     *  a single growing in-memory Blob for the whole call.
+    */
+    chunks?: Blob[];
+    /**
+     *  This 'mimeType' is the effective MIME type reported by the MediaRecorder, used to
+     *  assemble the final Blob from the chunks.
+    */
+    mimeType?: string;
+    /**
+     *  This 'duration' is the duration of the recording in seconds.
+    */
+    duration?: number;
+    /**
+     *  This 'durationTimer' is a subscription that manages the duration of the recording.
+    */
+    durationTimer?: Subscription;
+    /**
+     *  This 'maxDurationWarningShown' guards the "will be stopped soon" warning so it is emitted only once.
+    */
+    maxDurationWarningShown?: boolean;
+    /**
+     *  This 'incomingCallNotified' guards the "recording paused by an incoming call" notification so it is emitted
+     *  only once per answer, even when several answer paths run for the same call. Cleared when the recording resumes.
+    */
+    incomingCallNotified?: boolean;
+    /**
+     *  This 'fileName' is the name of the file that will be created for the recording.
+    */
+    fileName?: string;
+    /**
+     *  This 'backupFileDescriptor' is the FileDescriptor instance that contains the backup file information.
+    */
+    backupFileDescriptor?: FileDescriptor;
+    /** The other party of the recorded P2P call (for the call_record file descriptor metadata). */
+    callContact?: Contact;
+    /** When the recording started. */
+    recordStartTime?: Date;
+    /** When the user stopped the recording (the upload that follows must not count in its duration). */
+    recordStopTime?: Date;
+    /** When the current pause started; unset while the recording is running. */
+    pauseStartTime?: Date;
+    /** Time spent paused so far, in milliseconds (nothing is recorded while paused). */
+    totalPauseDuration?: number;
+    /** When the call itself started (may be earlier than the recording). */
+    callStartDate?: Date;
+    /** *****************
+     * DESKTOP APP ONLY
+    ********************/
+    /**
+     *  This 'fullPathUrl' is the full path URL of the file where the recording will be saved.
+     *  It is used in the desktop application to save the file locally.
+    */
+    fullPathUrl?: string;
+    /**
+     *  This 'inputPeerConnection' is the RTCPeerConnection instance used to manage the input stream of the call.
+    */
+    inputPeerConnection?: RTCPeerConnection;
+    /**
+     *  This 'ouputPeerConnection' is the RTCPeerConnection instance used to manage the output stream of the call.
+    */
+    ouputPeerConnection?: RTCPeerConnection;
+    /**
+     * Cleanup function for the fixed-FPS canvas redraw loop used for external video tracks.
+     * Must be called when the recording instance is removed.
+     */
+    fixedFpsCleanup?: () => void;
+}
+/**
+ * The CallRecorderService class contains the methods and their implementations required for recording.
+*/
+export declare class CallRecorderService extends Service {
+    callService: CallServiceRB;
+    fileDocumentService: FileDocumentServiceRB;
+    private conversationService;
+    private xmppService;
+    private fileStorageService;
+    private fileServerService;
+    private errorHelperService;
+    private logger;
+    private eventService;
+    private mainService;
+    private contactService;
+    private webrtcP2PServce;
+    private p2pRecapService;
+    private centralizedService;
+    private rxSubject;
+    private recorders;
+    private blankVideoTrack;
+    private blankVideoTrackInterval;
+    private blankVideoStream;
+    private videoElement;
+    private canvasElement;
+    static getInstance(): CallRecorderService;
+    static build(): CallRecorderService;
+    protected constructor();
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    sendEvent(name: CallRecorderServiceEvents): void;
+    subscribe(handler: any): Subscription;
+    private buildRecordingFileName;
+    private formatRecordingParty;
+    /**
+     *  This API allows the user to start e recording of the current call.
+     * @param callToRecord - The call to record
+     */
+    startRecording(callToRecord: Call, recordingName?: string): Promise<void>;
+    /**
+     * This method builds the local peer connection for the call recording.
+     * @param recorderInstance - The CallRecorderInstance containing the recording data.
+     * @param session - The JingleSession for the call.
+     * @param addVideo - Whether to add video to the recording.
+     * @param secondSession - The second JingleSession for the call, if applicable.
+     */
+    private buildLocalPeerConnection;
+    /**
+     * This API allows the user to stop the recording of the current call.
+     * @param callToRecord - The call to record
+     */
+    stopRecording(callToRecord: Call): Promise<void>;
+    /**
+     *  This API allows the user to pause the recording of the current call.
+     * @param callToRecord - The call to record
+     */
+    pauseRecording(callToRecord: Call): void;
+    /**
+     * This API allows the user to resume the recording of the current call.
+     * @param callToRecord - The call to record
+     */
+    resumeRecording(callToRecord: Call): void;
+    /**
+     * Close the pause in progress, if any, and add its length to the total pause duration of the recording.
+     * @param recorderInstance - The recorder instance being resumed or stopped
+     * @param endDate - When the pause ends
+     */
+    private endPause;
+    /**
+     * Announce that the recording has been paused or resumed (CRRAINB-54989), the same way the start of a
+     * recording is announced: the event drives the local beep, and the remote party is told either through a
+     * recording message when it is a Rainbow user -- so its UI shows the same state -- or through a beep
+     * played into the call audio when it is not.
+     * @param call - The recorded call
+     * @param state - "pause" or "resume"
+     */
+    private notifyRecordingStateChange;
+    /**
+     * This API allows the user to cancel the recording.
+     * It means that you can stop a recording without saving the recording file.
+     * @param callToRecord - The call to record
+     */
+    cancelRecording(callToRecord: Call): void;
+    /**
+     * This API allows the user to get the recording duration.
+     * @param callToRecord - The call that will be recorded.
+     */
+    getRecordingDuration(callToRecord: Call): number;
+    /**
+     * Whether a recording is currently capturing audio, whatever the call type (P2P, hybrid or hub telephony).
+     * A paused or stopped recording does not count.
+     */
+    hasRecordingInProgress(): boolean;
+    /**
+     * US9: answering an incoming call holds the current call, which pauses its ongoing recording.
+     * Publishes ON_RECORDING_PAUSED_INCOMING_CALL so the UI informs the user, once per recording.
+     */
+    notifyIncomingCallWhileRecording(): void;
+    /**
+     * Enforces the maximum recording duration: warns the user 15 minutes before the limit (once), then stops
+     * and saves the recording automatically when the limit is reached. Called on every duration timer tick.
+     * @param recorderInstance - The recorder instance whose duration is being tracked.
+     * @param call - The call being recorded.
+     */
+    private checkMaxRecordingDuration;
+    /**
+     * This method adds listeners for the call events.
+     * @param call - The call for which to add listeners.
+     * @param secondCall - The second call for which to add listeners, if applicable.
+     */
+    private addListenersForCall;
+    /**
+     * This method creates a black video track for the call recording.
+     * @param blob - The Blob to convert to a file.
+     * @param recorderInstance - The CallRecorderInstance containing the recording data.
+     */
+    private onCreateFileFromBlobForSafari;
+    /**
+     * This method retrieves or creates a video track for the call recording.
+     * @param session - The JingleSession for the call.
+     * @param secondSession - The second JingleSession for the call, if applicable.
+     */
+    /**
+     * Wraps a source video track in a canvas-based redraw loop running at a fixed FPS.
+     * This ensures consistent frame rate regardless of what the remote source delivers,
+     * and prevents the loopback peer connection from inheriting low-FPS constraints.
+     * @param sourceTrack - The original video track to wrap.
+     * @param fps - Target frame rate for the recording (default 30).
+     */
+    private createFixedFpsTrack;
+    private getOrCreateVideoTrack;
+    /**
+     * This method creates a black video track for the call recording.
+     */
+    private createBlackTrack;
+    /**
+     * This method uploads the file to the server.
+     * @param recordingInstance - The CallRecorderInstance containing the recording data.
+     * @param backup - Whether to upload as a backup file or not.
+     */
+    uploadFileToServer(recordingInstance: CallRecorderInstance, backup?: boolean, recordingMetadata?: {
+        callRecord?: boolean;
+        callId?: string;
+        calledUserId?: string;
+        calledDisplayName?: string;
+        callDate?: string;
+        startCallRecordDate?: string;
+        endCallRecordDate?: string;
+        totalPauseDuration?: number;
+    }): Promise<FileDescriptor>;
+    /**
+     * This method either handles the error event from the MediaRecorder or fill the data attrbute from recorderInstance with Blob.
+     * @param event - The data available event from the MediaRecorder.
+     * @param recorderInstance - The CallRecorderInstance containing the recording data.
+    */
+    onDataAvailable(event: any, recorderInstance: CallRecorderInstance): Promise<void>;
+    /**
+     * This method handles the error event from the MediaRecorder or manage the file by uploading it on the server or writing it to disk.
+     * @param recordingInstance - The CallRecorderInstance containing the recording data.
+     */
+    private onStop;
+    /**
+     * This method handles the error event from the MediaRecorder.
+     * @param recorderInstance - The CallRecorderInstance containing the recording data.
+     * @param isTempFile - Whether the file is a temporary file or not.
+     */
+    private writeFileToDisk;
+    /**
+     * This method creates the final file for the recording.
+     * @param recordingInstance - The CallRecorderInstance containing the recording data.
+     */
+    private createFinalFileForRecording;
+    /**
+     * This method removes the recording instance from the list of recorders.
+     * @param recorderInstance - The CallRecorderInstance to remove.
+     */
+    private removeRecordingInstance;
+    /**
+     * This method injects metadata into the Blob.
+     * @param blob - The Blob to inject metadata into.
+     */
+    private injectMetadata;
+    /**
+     * This method closes the AudioContext.
+     * @param audioContext - The AudioContext to close.
+     */
+    private closeAudioContext;
+    /**
+     * This method handles the error event from the MediaRecorder.
+     * @param event - The error event from the MediaRecorder.
+     */
+    private onError;
+}
+//# sourceMappingURL=callRecorder.service.d.ts.map

package/lib/services/call/callRecorder.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"callRecorder.service.d.ts","sourceRoot":"","sources":["../../../src/services/call/callRecorder.service.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,IAAI,EAAU,MAAM,wCAAwC,CAAC;AAE3E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAMzC,OAAO,EAAE,OAAO,EAAE,MAAM,uCAAuC,CAAC;AAMhE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AAI1D,OAAO,EAAqB,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAClE,OAAO,EAAE,qBAAqB,EAAE,MAAM,sCAAsC,CAAC;AAM7E,eAAO,MAAM,iBAAiB,wBAAwB,CAAC;AAUvD,oBAAY,yBAAyB;IACjC;;;;OAIG;IACH,iBAAiB,qBAAqB;IAEtC;;;;OAIG;IACH,eAAe,mBAAmB;IAElC;;;;OAIG;IACH,gBAAgB,oBAAoB;IAEpC;;;;OAIG;IACH,iBAAiB,qBAAqB;IAEtC;;;OAGG;IACH,wBAAwB,wBAAwB;IAEhD;;;OAGG;IACH,iCAAiC,kCAAkC;IAEnE;;;OAGG;IACH,qBAAqB,uBAAuB;IAE5C;;;;OAIG;IACH,gBAAgB,oBAAoB;IAEpC;;;;OAIG;IACH,8BAA8B,gCAAgC;IAE9D;;;OAGG;IACH,8BAA8B,gCAAgC;IAE9D;;;OAGG;IACH,4BAA4B,8BAA8B;CAC7D;AAED,MAAM,WAAW,oBAAoB;IAEjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;;MAGE;IACF,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B;;;MAGE;IACF,YAAY,EAAE,YAAY,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,YAAY,EAAE,CAAC;IAE/B;;MAEE;IACF,IAAI,CAAC,EAAE,IAAI,CAAC;IAEZ;;;;MAIE;IACF,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC;IAEhB;;;MAGE;IACF,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;MAEE;IACF,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;MAEE;IACF,aAAa,CAAC,EAAE,YAAY,CAAC;IAE7B;;MAEE;IACF,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAElC;;;MAGE;IACF,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B;;MAEE;IACF,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;MAEE;IACF,oBAAoB,CAAC,EAAE,cAAc,CAAC;IAEtC,+FAA+F;IAC/F,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,kCAAkC;IAClC,eAAe,CAAC,EAAE,IAAI,CAAC;IACvB,oGAAoG;IACpG,cAAc,CAAC,EAAE,IAAI,CAAC;IACtB,4EAA4E;IAC5E,cAAc,CAAC,EAAE,IAAI,CAAC;IACtB,oFAAoF;IACpF,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,wEAAwE;IACxE,aAAa,CAAC,EAAE,IAAI,CAAC;IAErB;;yBAEqB;IAErB;;;MAGE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;MAEE;IACF,mBAAmB,CAAC,EAAE,iBAAiB,CAAC;IAExC;;MAEE;IACF,mBAAmB,CAAC,EAAE,iBAAiB,CAAC;IAExC;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,IAAI,CAAC;CAMhC;AAOD;;EAEE;AACF,qBAAa,mBAAoB,SAAQ,OAAO;IACrC,WAAW,EAAE,aAAa,CAA+B;IACzD,mBAAmB,EAAE,qBAAqB,CAAuC;IACxF,OAAO,CAAC,mBAAmB,CAA8D;IACzF,OAAO,CAAC,WAAW,CAA0C;IAC7D,OAAO,CAAC,kBAAkB,CAAwD;IAClF,OAAO,CAAC,iBAAiB,CAAsD;IAC/E,OAAO,CAAC,kBAAkB,CAAwD;IAClF,OAAO,CAAC,MAAM,CAA8C;IAC5D,OAAO,CAAC,YAAY,CAA4C;IAChE,OAAO,CAAC,WAAW,CAA0C;IAC7D,OAAO,CAAC,cAAc,CAAgD;IACtE,OAAO,CAAC,eAAe,CAAoD;IAC3E,OAAO,CAAC,eAAe,CAAsD;IAC7E,OAAO,CAAC,kBAAkB,CAAa;IACvC,OAAO,CAAC,SAAS,CAA4C;IAE7D,OAAO,CAAC,SAAS,CAA4C;IAG7D,OAAO,CAAC,eAAe,CAAmB;IAC1C,OAAO,CAAC,uBAAuB,CAAiB;IAChD,OAAO,CAAC,gBAAgB,CAAc;IACtC,OAAO,CAAC,YAAY,CAAmB;IACvC,OAAO,CAAC,aAAa,CAAoB;WAK3B,WAAW;WAIX,KAAK;IAInB,SAAS;IAEI,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAKtB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAe3B,SAAS,CAAC,IAAI,EAAE,yBAAyB;IAIzC,SAAS,CAAC,OAAO,EAAE,GAAG,GAAG,YAAY;IAI5C,OAAO,CAAC,sBAAsB;IAY9B,OAAO,CAAC,oBAAoB;IAK5B;;;OAGG;IACU,cAAc,CAAC,YAAY,EAAE,IAAI,EAAE,aAAa,CAAC,EAAE,MAAM;IAwMtE;;;;;;OAMG;YACW,wBAAwB;IA6DtC;;;OAGG;IACU,aAAa,CAAC,YAAY,EAAE,IAAI;IAgC7C;;;OAGG;IACI,cAAc,CAAC,YAAY,EAAE,IAAI;IAqBxC;;;OAGG;IACI,eAAe,CAAC,YAAY,EAAE,IAAI;IAgCzC;;;;OAIG;IACH,OAAO,CAAC,QAAQ;IAMhB;;;;;;;OAOG;YACW,0BAA0B;IAoBxC;;;;OAIG;IACI,eAAe,CAAC,YAAY,EAAE,IAAI;IAuBzC;;;OAGG;IACI,oBAAoB,CAAC,YAAY,EAAE,IAAI,GAAG,MAAM;IAKvD;;;OAGG;IACI,sBAAsB,IAAI,OAAO;IAIxC;;;OAGG;IACI,gCAAgC,IAAI,IAAI;IAO/C;;;;;OAKG;IACH,OAAO,CAAC,yBAAyB;IAejC;;;;OAIG;IACH,OAAO,CAAC,mBAAmB;IA2E3B;;;;OAIG;IACH,OAAO,CAAC,6BAA6B;IAQrC;;;;OAIG;IACH;;;;;;OAMG;YACW,mBAAmB;YAkCnB,qBAAqB;IAqEnC;;OAEG;YACW,gBAAgB;IAsB9B;;;;OAIG;IACU,kBAAkB,CAAC,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,GAAE,OAAe,EAAE,iBAAiB,GAAE;QAAE,UAAU,CAAC,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,CAAC;QAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAAC,kBAAkB,CAAC,EAAE,MAAM,CAAC;KAAS,GAAG,OAAO,CAAC,cAAc,CAAC;IA0B7V;;;;MAIE;IACW,eAAe,CAAC,KAAK,EAAE,GAAG,EAAE,gBAAgB,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAe/F;;;OAGG;YACW,MAAM;IA2CpB;;;;OAIG;YAEW,eAAe;IAkC7B;;;OAGG;YACW,2BAA2B;IAiGzC;;;OAGG;IACH,OAAO,CAAC,uBAAuB;IAuC/B;;;OAGG;YACW,cAAc;IAwC5B;;;OAGG;IACH,OAAO,CAAC,iBAAiB;IAWzB;;;OAGG;IACH,OAAO,CAAC,OAAO;CAKlB"}

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

@@ -0,0 +1,3 @@
+export type { CallService } from "./call.service";
+export { CALL_SVC, CallServiceEvents } from "./call.service";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/services/call/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC"}