@telnyx/react-voice-commons-sdk 1.1.0 → 1.2.0

package/src/types/telnyx-sdk.d.ts

@@ -24,7 +24,15 @@ declare module '@telnyx/react-native-voice-sdk' {
     };
   }
 
+  /** A STUN/TURN server for WebRTC peer connections (core `TelnyxIceServer`). */
+  export interface TelnyxIceServer {
+    urls: string;
+    username?: string;
+    credential?: string;
+  }
+
   export interface ClientOptions {
+    environment?: 'production' | 'development';
     login?: string;
     password?: string;
     token?: string;
@@ -38,9 +46,13 @@ declare module '@telnyx/react-native-voice-sdk' {
     enableMissedCallNotifications?: boolean;
     useTrickleIce?: boolean;
     enableCallReports?: boolean;
+    enableQualityMetrics?: boolean;
     callReportInterval?: number;
     callReportLogLevel?: string;
     callReportMaxLogEntries?: number;
+    /** Custom ICE servers (STUN/TURN) for WebRTC peer connections */
+    iceServers?: TelnyxIceServer[];
+    sdkName?: string;
     sdkVersion?: string;
   }
 
@@ -55,6 +67,52 @@ declare module '@telnyx/react-native-voice-sdk' {
     PURGE = 'purge',
   }
 
+  /**
+   * Quality rating derived from the MOS score (same bands as iOS and Android).
+   */
+  export enum CallQualityLevel {
+    EXCELLENT = 'excellent',
+    GOOD = 'good',
+    FAIR = 'fair',
+    POOR = 'poor',
+    BAD = 'bad',
+    UNKNOWN = 'unknown',
+  }
+
+  /** A raw WebRTC stats report, copied as a plain object. */
+  export type QualityStatsRecord = Record<string, unknown>;
+
+  /**
+   * Snapshot of call quality metrics at a single sampling point. Field names
+   * and units match iOS `CallQualityMetrics`.
+   */
+  export interface CallQualityMetrics {
+    /** The call identifier this metrics snapshot belongs to. */
+    callId: string;
+    /** ISO-8601 timestamp of when the metrics were collected. */
+    timestamp: string;
+    /** Jitter in seconds, or null when unavailable. */
+    jitter: number | null;
+    /** Round-trip time in seconds, or null when unavailable. */
+    rtt: number | null;
+    /** Mean Opinion Score (1.0–5.0), or null when it cannot be calculated. */
+    mos: number | null;
+    /** Quality rating derived from `mos`; UNKNOWN when `mos` is null. */
+    quality: CallQualityLevel;
+    /** Instantaneous inbound (remote) audio level, 0.0–1.0. */
+    inboundAudioLevel: number;
+    /** Instantaneous outbound (local) audio level, 0.0–1.0. */
+    outboundAudioLevel: number;
+    /** Raw `inbound-rtp` audio stats, or null when unavailable. */
+    inboundAudio: QualityStatsRecord | null;
+    /** Raw `outbound-rtp` audio stats, or null when unavailable. */
+    outboundAudio: QualityStatsRecord | null;
+    /** Raw `remote-inbound-rtp` audio stats, or null when unavailable. */
+    remoteInboundAudio: QualityStatsRecord | null;
+    /** Raw `remote-outbound-rtp` audio stats, or null when unavailable. */
+    remoteOutboundAudio: QualityStatsRecord | null;
+  }
+
   export class Call extends EventEmitter {
     callId: string;
     state: CallState;
@@ -67,17 +125,24 @@ declare module '@telnyx/react-native-voice-sdk' {
     /**
      * Custom headers received from the WebRTC INVITE message.
      * These headers are passed during call initiation and can contain application-specific information.
-     * Format should be [{"name": "X-Header-Name", "value": "Value"}] where header names must start with "X-".
+     * Format: `[{"name": "X-Header-Name", "value": "Value"}]`; header names must start with `X-`.
      */
     inviteCustomHeaders: { name: string; value: string }[] | null;
 
     /**
      * Custom headers received from the WebRTC ANSWER message.
      * These headers are passed during call acceptance and can contain application-specific information.
-     * Format should be [{"name": "X-Header-Name", "value": "Value"}] where header names must start with "X-".
+     * Format: `[{"name": "X-Header-Name", "value": "Value"}]`; header names must start with `X-`.
      */
     answerCustomHeaders: { name: string; value: string }[] | null;
 
+    /**
+     * Callback invoked with each call quality metrics snapshot (every 200 ms by
+     * default) while collection is active. Snapshots are also emitted as the
+     * `telnyx.call.qualityMetrics` event.
+     */
+    onQualityMetrics: ((metrics: CallQualityMetrics) => void) | null;
+
     constructor(options: any);
 
     answer(customHeaders?: { name: string; value: string }[]): Promise<void>;