@telnyx/webrtc 2.27.0-beta.2 → 2.27.0-beta.4

package/lib/src/Modules/Verto/BaseSession.d.ts

@@ -22,6 +22,7 @@ export default abstract class BaseSession {
     invalidMethodErrorCode: number;
     authenticationRequiredErrorCode: number;
     callReportId: string | null;
+    callReportVoiceSdkId: string | null;
     dc: string | null;
     region: string | null;
     connection: Connection;
@@ -30,8 +31,11 @@ export default abstract class BaseSession {
     protected _reconnectTimeout: any;
     protected _autoReconnect: boolean;
     protected _idle: boolean;
+    protected _reconnectAttempts: number;
     private _tokenExpiryTimeout;
     private static readonly TOKEN_EXPIRY_WARNING_SECONDS;
+    private static readonly CALL_REPORT_UPLOAD_DRAIN_TIMEOUT_MS;
+    private _pendingCallReportUploads;
     private _executeQueue;
     private _pong;
     private registerAgent;
@@ -42,6 +46,8 @@ export default abstract class BaseSession {
     get reconnectDelay(): number;
     execute(msg: BaseMessage): Promise<any>;
     executeRaw(text: string): void;
+    trackCallReportUpload(upload: Promise<void>): void;
+    private _drainCallReportUploads;
     validateOptions(): boolean;
     broadcast(_params: BroadcastParams): void;
     disconnect(): Promise<void>;
@@ -54,6 +60,7 @@ export default abstract class BaseSession {
     off(eventName: SwEvent.Notification | 'telnyx.notification', callback?: (event: INotification) => void): this;
     off(eventName: string, callback?: Function): this;
     connect(): Promise<void>;
+    resetReconnectAttempts(): void;
     protected _handleLoginError(error: any): void;
     clearReconnectToken(): void;
     private _checkTokenExpiry;
@@ -66,7 +73,16 @@ export default abstract class BaseSession {
     }): Promise<void>;
     private _login;
     protected _onSocketOpen(): Promise<void>;
-    onNetworkClose(): void;
+    private _flushIntermediateCallReports;
+    private _getSocketCloseCodeName;
+    private _getSocketCloseError;
+    private _createSocketCloseFlushReason;
+    onNetworkClose(event?: {
+        code?: number;
+        reason?: string;
+        wasClean?: boolean;
+        error?: unknown;
+    }): void;
     protected _onSocketMessage(_response: any): void;
     protected _removeSubscription(protocol: string, channel?: string): void;
     protected _addSubscription(protocol: string, handler: Function, channel: string): void;

package/lib/src/Modules/Verto/util/constants/errorCodes.d.ts

@@ -28,6 +28,7 @@ export declare const TELNYX_WARNING_CODES: {
     readonly HIGH_JITTER: 31002;
     readonly HIGH_PACKET_LOSS: 31003;
     readonly LOW_MOS: 31004;
+    readonly LOW_LOCAL_AUDIO: 31005;
     readonly LOW_BYTES_RECEIVED: 32001;
     readonly LOW_BYTES_SENT: 32002;
     readonly ICE_CONNECTIVITY_LOST: 33001;
@@ -41,5 +42,5 @@ export declare const TELNYX_WARNING_CODES: {
     readonly SESSION_NOT_REATTACHED: 35001;
 };
 export declare const SDP_CREATE_OFFER_FAILED: 40001, SDP_CREATE_ANSWER_FAILED: 40002, SDP_SET_LOCAL_DESCRIPTION_FAILED: 40003, SDP_SET_REMOTE_DESCRIPTION_FAILED: 40004, SDP_SEND_FAILED: 40005, MEDIA_MICROPHONE_PERMISSION_DENIED: 42001, MEDIA_DEVICE_NOT_FOUND: 42002, MEDIA_GET_USER_MEDIA_FAILED: 42003, HOLD_FAILED: 44001, INVALID_CALL_PARAMETERS: 44002, BYE_SEND_FAILED: 44003, SUBSCRIBE_FAILED: 44004, PEER_CLOSED_DURING_INIT: 44005, WEBSOCKET_CONNECTION_FAILED: 45001, WEBSOCKET_ERROR: 45002, RECONNECTION_EXHAUSTED: 45003, GATEWAY_FAILED: 45004, LOGIN_FAILED: 46001, INVALID_CREDENTIALS: 46002, AUTHENTICATION_REQUIRED: 46003, ICE_RESTART_FAILED: 47001, NETWORK_OFFLINE: 48001, UNEXPECTED_ERROR: 49001;
-export declare const HIGH_RTT: 31001, HIGH_JITTER: 31002, HIGH_PACKET_LOSS: 31003, LOW_MOS: 31004, LOW_BYTES_RECEIVED: 32001, LOW_BYTES_SENT: 32002, ICE_CONNECTIVITY_LOST: 33001, ICE_GATHERING_TIMEOUT: 33002, ICE_GATHERING_EMPTY: 33003, PEER_CONNECTION_FAILED: 33004, ONLY_HOST_ICE_CANDIDATES: 33005, ANSWER_WHILE_PEER_ACTIVE: 33006, DUPLICATE_INBOUND_ANSWER: 33007, TOKEN_EXPIRING_SOON: 34001, SESSION_NOT_REATTACHED: 35001;
+export declare const HIGH_RTT: 31001, HIGH_JITTER: 31002, HIGH_PACKET_LOSS: 31003, LOW_MOS: 31004, LOW_LOCAL_AUDIO: 31005, LOW_BYTES_RECEIVED: 32001, LOW_BYTES_SENT: 32002, ICE_CONNECTIVITY_LOST: 33001, ICE_GATHERING_TIMEOUT: 33002, ICE_GATHERING_EMPTY: 33003, PEER_CONNECTION_FAILED: 33004, ONLY_HOST_ICE_CANDIDATES: 33005, ANSWER_WHILE_PEER_ACTIVE: 33006, DUPLICATE_INBOUND_ANSWER: 33007, TOKEN_EXPIRING_SOON: 34001, SESSION_NOT_REATTACHED: 35001;
 export declare const HAS_NON_HOST_ICE_CANDIDATE_REGEX: RegExp;

package/lib/src/Modules/Verto/util/constants/warnings.d.ts

@@ -40,6 +40,13 @@ export declare const SDK_WARNINGS: {
         readonly causes: readonly ["Combination of high latency, jitter, and/or packet loss", "Poor network conditions"];
         readonly solutions: readonly ["Check network connectivity", "Use a wired connection", "Close bandwidth-heavy applications"];
     };
+    readonly 31005: {
+        readonly name: "LOW_LOCAL_AUDIO";
+        readonly message: "Low local microphone audio detected";
+        readonly description: "Local outbound audio level stayed below the acceptable threshold before the microphone produced real audio, or stayed silent for a long continuous window after audio was confirmed. This may indicate that the microphone is not capturing enough audio even while RTP is being sent.";
+        readonly causes: readonly ["Microphone input level is too low", "Wrong microphone selected", "Microphone is obstructed or too far from the speaker", "Operating system input gain is muted or very low"];
+        readonly solutions: readonly ["Check the selected microphone", "Increase microphone input gain", "Move closer to the microphone", "Verify the microphone is not muted at the operating system or hardware level"];
+    };
     readonly 32001: {
         readonly name: "LOW_BYTES_RECEIVED";
         readonly message: "No audio data received";

package/lib/src/Modules/Verto/util/interfaces.d.ts

@@ -33,8 +33,10 @@ export interface IVertoOptions {
     rtcIp?: string;
     rtcPort?: number;
     mutedMicOnStart?: boolean;
+    maxReconnectAttempts?: number;
     enableCallReports?: boolean;
     callReportInterval?: number;
+    callReportFlushInterval?: number;
     debugLogLevel?: 'debug' | 'info' | 'warn' | 'error';
     debugLogMaxEntries?: number;
     skipLastVoiceSdkId?: boolean;

package/lib/src/Modules/Verto/util/webrtc/index.d.ts

@@ -9,7 +9,7 @@ declare const streamIsValid: (stream: MediaStream) => boolean;
 declare const audioIsMediaTrackConstraints: (audio: boolean | MediaTrackConstraints) => boolean;
 declare const videoIsMediaTrackConstraints: (video: boolean | MediaTrackConstraints) => boolean;
 declare const attachMediaStream: (tag: any, stream: MediaStream) => void;
-declare const detachMediaStream: (tag: any) => void;
+declare const detachMediaStream: (tag: any, stream?: MediaStream) => void;
 declare const muteMediaElement: (tag: any) => void;
 declare const unmuteMediaElement: (tag: any) => void;
 declare const toggleMuteMediaElement: (tag: any) => void;

package/lib/src/Modules/Verto/util/webrtc/index.native.d.ts

@@ -5,7 +5,7 @@ declare const _enumerateDevices: () => any;
 declare const streamIsValid: (stream: MediaStream) => boolean;
 declare const getSupportedConstraints: () => {};
 declare const attachMediaStream: (htmlElementId: string, stream: MediaStream) => any;
-declare const detachMediaStream: (htmlElementId: string) => any;
+declare const detachMediaStream: (htmlElementId: string, _stream?: MediaStream) => any;
 declare const muteMediaElement: (htmlElementId: string) => any;
 declare const unmuteMediaElement: (htmlElementId: string) => any;
 declare const toggleMuteMediaElement: (htmlElementId: string) => any;

package/lib/src/Modules/Verto/webrtc/BaseCall.d.ts

@@ -1,4 +1,5 @@
 import BrowserSession from '../BrowserSession';
+import { type ICallReportFlushReason } from './CallReportCollector';
 import Call from './Call';
 import Peer from './Peer';
 import { Direction, State } from './constants';
@@ -122,6 +123,8 @@ export default abstract class BaseCall implements IWebRTCCall {
     private _hasUsablePeerConnection;
     private _init;
     protected _finalize(): void;
+    private _getCallReportVoiceSdkId;
+    flushIntermediateCallReport(flushReason?: ICallReportFlushReason): void;
     private _flushIntermediateReport;
     private _postCallReport;
     private _startStats;

package/lib/src/Modules/Verto/webrtc/CallEstablishmentTimings.d.ts

@@ -7,6 +7,7 @@ export interface ICallEstablishmentTimings {
         delta: number;
     }>;
 }
-export declare function collectCallEstablishmentTimings(mode: 'trickle' | 'non-trickle', direction: 'outbound' | 'inbound'): ICallEstablishmentTimings;
+export declare function callMarkName(callId: string, suffix: string): string;
+export declare function collectCallEstablishmentTimings(callId: string, mode: 'trickle' | 'non-trickle', direction: 'outbound' | 'inbound'): ICallEstablishmentTimings;
 export declare function logCallEstablishmentTimings(timings: ICallEstablishmentTimings): void;
-export declare function clearCallMarks(): void;
+export declare function clearCallMarks(callId: string): void;

package/lib/src/Modules/Verto/webrtc/CallReportCollector.d.ts

@@ -55,6 +55,7 @@ export interface ITransportStats {
 export interface ICallReportOptions {
     enabled: boolean;
     interval: number;
+    intermediateReportInterval?: number;
 }
 export interface ILogCollectorOptions {
     enabled: boolean;
@@ -112,11 +113,22 @@ export interface ICallSummary {
     startTimestamp?: string;
     endTimestamp?: string;
 }
+export interface ICallReportFlushReason {
+    type: 'buffer-limit' | 'manual' | 'socket-close' | 'socket-error';
+    socketClose?: {
+        code?: number;
+        codeName?: string;
+        reason?: string;
+        wasClean?: boolean;
+        error?: string;
+    };
+}
 export interface ICallReportPayload {
     summary: ICallSummary;
     stats: IStatsInterval[];
     logs?: ILogEntry[];
     segment?: number;
+    flushReason?: ICallReportFlushReason;
 }
 export declare class CallReportCollector {
     private options;
@@ -134,9 +146,12 @@ export declare class CallReportCollector {
     private intervalBitrates;
     private previousStats;
     private previousCandidatePairId;
+    private static readonly INITIAL_COLLECTION_INTERVAL_MS;
+    private static readonly INITIAL_COLLECTION_DURATION_MS;
     private readonly MAX_BUFFER_SIZE;
     private static readonly STATS_FLUSH_THRESHOLD;
     private static readonly LOGS_FLUSH_THRESHOLD;
+    private static readonly DEFAULT_INTERMEDIATE_REPORT_INTERVAL_MS;
     onFlushNeeded: (() => void) | null;
     onWarning: ((warning: ITelnyxWarning) => void) | null;
     private static readonly CONSECUTIVE_BREACHES_REQUIRED;
@@ -144,6 +159,8 @@ export declare class CallReportCollector {
     private static readonly THRESHOLD_JITTER_MS;
     private static readonly THRESHOLD_PACKET_LOSS_PCT;
     private static readonly THRESHOLD_MOS;
+    private static readonly THRESHOLD_LOCAL_AUDIO_LEVEL;
+    private static readonly CONFIRMED_LOCAL_AUDIO_SILENCE_MS;
     private _breachCounters;
     private _activeWarnings;
     private _lastWarningEmitted;
@@ -151,22 +168,37 @@ export declare class CallReportCollector {
     private _prevPacketsReceived;
     private _prevPacketsLost;
     private _lastLocalAudioTrackSnapshotJson;
+    private _hasConfirmedLocalAudio;
+    private _confirmedLocalAudioSilenceMs;
     private _segmentIndex;
+    private _lastIntermediateFlushTime;
     private _flushing;
-    private static readonly RETRY_DELAY_MS;
+    private _stopped;
+    private static readonly RETRY_DELAYS_MS;
+    private static readonly KEEPALIVE_BODY_LIMIT_BYTES;
     constructor(options: ICallReportOptions, logCollectorOptions?: ILogCollectorOptions);
     start(peerConnection: RTCPeerConnection): void;
     stop(): Promise<void>;
-    flush(summary: ICallSummary): ICallReportPayload | null;
+    flush(summary: ICallSummary, flushReason?: ICallReportFlushReason): ICallReportPayload | null;
     postReport(summary: ICallSummary, callReportId: string, host: string, voiceSdkId?: string): Promise<void>;
     sendPayload(payload: ICallReportPayload, callReportId: string, host: string, voiceSdkId?: string): Promise<void>;
     private _sendPayload;
     getStatsBuffer(): IStatsInterval[];
     getLogs(): ILogEntry[];
     cleanup(): void;
+    private _scheduleNextCollection;
+    private _collectionIntervalFor;
+    private _positiveInterval;
     private _collectStats;
+    private _getIntermediateReportInterval;
+    private _requestIntermediateFlushIfNeeded;
     private _checkQualityWarnings;
+    private _trackLowLocalAudio;
+    private _resetLowLocalAudioWarning;
+    private _getStatsIntervalDurationMs;
     private _trackBreach;
+    private _emitWarningOncePerEpisode;
+    private _emitWarning;
     private _createStatsEntry;
     private _resolveCandidate;
     private _getOutboundMediaSource;

package/lib/src/Modules/Verto/webrtc/interfaces.d.ts

@@ -1,3 +1,4 @@
+import type { ICallReportFlushReason } from './CallReportCollector';
 import { State } from './constants';
 export interface IMediaSettings {
     useSdpASBandwidthKbps?: boolean;
@@ -109,6 +110,7 @@ export interface IWebRTCCall {
     invite: () => void;
     answer: (params: AnswerParams) => void;
     hangup: (params?: IHangupParams, execute?: boolean) => Promise<void>;
+    flushIntermediateCallReport?: (reason?: ICallReportFlushReason) => void;
     hold: () => void;
     unhold: () => void;
     toggleHold: () => void;

package/lib/src/utils/interfaces.d.ts

@@ -35,8 +35,10 @@ export interface IClientOptions {
     env?: Environment;
     iceServers?: RTCIceServer[];
     mutedMicOnStart?: boolean;
+    maxReconnectAttempts?: number;
     enableCallReports?: boolean;
     callReportInterval?: number;
+    callReportFlushInterval?: number;
     mediaPermissionsRecovery?: {
         enabled: boolean;
         timeout: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@telnyx/webrtc",
-  "version": "2.27.0-beta.2",
+  "version": "2.27.0-beta.4",
   "description": "Telnyx WebRTC Client",
   "keywords": [
     "telnyx",