aliyun-rtc-sdk 7.2.1 → 7.2.2

package/dist/types/index.d.ts

@@ -267,6 +267,7 @@ declare class AliRtcEngine_2 extends default_2<AliRtcEngineEventListener> {
     private _localCheckAuthInfoTimestamp;
     private _proxyAiTid;
     private _agentParam;
+    sessionId?: string;
     constructor(config?: AliRtcEngineConfig | undefined);
     /**
      * 获取当前频道号，已经入会成功返回频道号，否则返回undefined
@@ -1324,6 +1325,21 @@ declare interface AliRtcEngineEventListener {
      * @param result 结果
      */
     AIAgentResult: (code: number, action: string, result: string) => void;
+    /**
+     * @brief 网络质量回调
+     * @param event 网络质量信息
+     * @param event.subscribe 下行网络质量
+     * @param event.subscribe.rtt 下行网络往返延时（ms）
+     * @param event.subscribe.loss 下行网络丢包率
+     * @param event.subscribe.quality 下行网络质量类型
+     */
+    networkQuality: (event: {
+        subscribe: {
+            rtt: number;
+            loss: number;
+            quality: AliRtcNetworkQuality;
+        };
+    }) => void;
 }
 
 export declare enum AliRtcEngineLocalDeviceExceptionType {
@@ -1928,6 +1944,26 @@ export declare enum AliRtcLogLevel {
     NONE = 5
 }
 
+/**
+ * @brief 网络质量类型
+ */
+declare enum AliRtcNetworkQuality {
+    /** 网络极好 */
+    AliRtcNetworkExcellent = 0,
+    /** 网络好 */
+    AliRtcNetworkGood = 1,
+    /** 网络不好 */
+    AliRtcNetworkPoor = 2,
+    /** 网络差 */
+    AliRtcNetworkBad = 3,
+    /** 网络极差 */
+    AliRtcNetworkVeryBad = 4,
+    /** 网络断开 */
+    AliRtcNetworkDisconnected = 5,
+    /** 网络未知 */
+    AliRtcNetworkUnknown = 6
+}
+
 /**
  * @brief OnBye类型枚举
  */
@@ -2310,6 +2346,7 @@ declare class BizControl extends default_2<BizControlListener> {
     private parameter;
     private audio3AConfig;
     private dcReadyHelper?;
+    private networkQualityTimer?;
     constructor(config: BizControlConfig);
     private addSignalingManagerListener;
     private addRTSListener;
@@ -2480,6 +2517,13 @@ declare interface BizControlListener {
     occurError: (error: AliRtcError, uid?: string) => void;
     remoteDataChannelMessage: (uid: string, message: AliRtcDataChannelMsg) => void;
     remoteUserSubscribedDataChannel: (uid: string) => void;
+    networkQuality: (event: {
+        subscribe: {
+            rtt: number;
+            loss: number;
+            quality: AliRtcNetworkQuality;
+        };
+    }) => void;
 }
 
 declare enum ClientEventType {
@@ -3005,9 +3049,7 @@ declare interface LocalUserConfig {
     signalingManager: SignalingManager;
     pluginManager: PluginManager;
     audioVolumeIndicationInterval: number;
-    parameter: {
-        [key: string]: any;
-    };
+    parameter: Parameter;
 }
 
 /**
@@ -3175,9 +3217,86 @@ declare class PackageCreator {
     protected createBaseSendPackage(messageType: MessageType): ISendPackage;
 }
 
-declare type Parameter = {
+/**
+ * SDK 参数配置
+ */
+declare interface Parameter {
+    /** 是否在推流信息中报告 L1 IP */
+    reportL1IP?: boolean;
+    /** 数据通道配置 */
+    data?: ParameterData;
+    /** 是否使用 AudioContext 进行音量控制 */
+    enableAudioContextPlayoutVolume?: boolean;
+    /** 网络相关配置 */
+    net?: ParameterNet;
+    /** 加入房间模式，如 'Conference'、'AIUser' 等 */
+    joinMode?: string;
+    /** 是否启用空白音频（用于保持音频轨道活跃） */
+    enableBlankAudio?: boolean;
+    /** 音频 3A 处理配置 */
+    audio?: ParameterAudio;
+    /** 支持其他自定义参数 */
     [key: string]: any;
-};
+}
+
+/**
+ * 音频 3A 处理配置参数
+ */
+declare interface ParameterAudio {
+    /** 是否使用服务端配置的 3A 设置 */
+    useAudio3AConfigFromServer?: boolean;
+    /** 是否启用系统回声消除 */
+    useSysEchoCancellation?: boolean;
+    /** 是否启用系统噪声抑制 */
+    useSysNoiseSuppression?: boolean;
+    /** 是否启用系统自动增益控制 */
+    useSysAutoGainControl?: boolean;
+    /** 是否启用智能 AEC */
+    useAIAEC?: boolean;
+    /** 是否启用软件 3A 处理 */
+    enableSoft3A?: boolean;
+    /** 是否启用旁路软 3A 检查 */
+    enableSoft3ACheck?: boolean;
+    /** 是否仅使用硬件 3A */
+    useHardOnly?: boolean;
+    /** 是否导出音频数据 */
+    dumpAudioData?: boolean;
+}
+
+/**
+ * 数据通道配置参数
+ */
+declare interface ParameterData {
+    /** 是否启用发布端数据通道 */
+    enablePubDataChannel?: boolean;
+    /** 是否启用订阅端数据通道 */
+    enableSubDataChannel?: boolean;
+}
+
+/**
+ * 网络相关配置参数
+ */
+declare interface ParameterNet {
+    /** 是否使用 TCP 传输 */
+    useTCP?: boolean;
+    /** 是否启用累积延迟 */
+    cumuDelay?: boolean;
+    /** 是否禁用心跳检测 */
+    disableHeartbeat?: boolean;
+    /** 心跳探活参数 */
+    heartbeat?: {
+        /** 心跳间隔，毫秒数，最小 200，默认 2500 */
+        interval?: number;
+        /** 超时时间，毫秒数 */
+        timeout?: number;
+        /** 是否启用心跳日志（监听 hebtSent/hebtReceived 事件） */
+        enableLog?: boolean;
+    };
+    /** 数据通道配置 */
+    datachannelInitOptions?: RTCDataChannelInit;
+    /** 媒体超时时间(毫秒)，有效范围 1000-100000 */
+    mediaTimeout?: number;
+}
 
 declare class PluginManager extends default_2<PluginManagerListener> {
     private plugins;
@@ -3428,6 +3547,7 @@ declare class RemoteUser extends User {
      * @ignore
      */
     static logName: string;
+    get logName(): string;
     remoteCallId: string;
     remoteUserInfo: AliRtcRemoteUserInfo;
     protected localUser?: LocalUser;
@@ -3480,7 +3600,9 @@ declare class RemoteUser extends User {
     setPlayoutVolume(value: number): void;
     getAudioMuted(): boolean;
     get hasAudioTrack(): boolean;
+    get audioSSRC(): string;
     get hasVideoTrack(): boolean;
+    get videoSSRC(): string;
     get hasVideoLargeTrack(): boolean;
     get hasVideoSmallTrack(): boolean;
     get hasScreenTrack(): boolean;
@@ -3639,9 +3761,7 @@ declare interface RemoteUserConfig {
     localUser?: LocalUser;
     audioVolumeIndicationInterval: number;
     playoutVolume: number;
-    parameter: {
-        [key: string]: any;
-    };
+    parameter: Parameter;
 }
 
 declare interface RemoteUserMap {
@@ -3958,12 +4078,16 @@ declare class RtsManager extends default_2<RtsManagerEventListener> {
     private dcResolve?;
     private dcReject?;
     private dcConnectingPromise?;
+    private _prevDownlinkStat?;
     private _publishingTracks;
     private parameter;
     preferredPubL1Ip?: string;
     preferredSubL1Ip?: string;
+    private httpPublishUrlMap;
+    private httpSubscribeUrlMap;
     private traceIdMap;
     constructor(localStreamManager: LocalStreamManager, slsReporter: SLSReporter, parameter: Parameter);
+    private createRtsInstance;
     private addRTSListener;
     /**
      * 更新鉴权信息，传入一个新的带鉴权的 URL，RTS 会去除鉴权信息做更新
@@ -3983,6 +4107,8 @@ declare class RtsManager extends default_2<RtsManagerEventListener> {
     private setConnected;
     get isConnecting(): boolean;
     get isConnected(): boolean;
+    private suffixHttpUrl;
+    private getSuffixedUrl;
     get publishingTracks(): TrackInfo[];
     private getPubMsid;
     private updatePublishingTracks;
@@ -3997,6 +4123,11 @@ declare class RtsManager extends default_2<RtsManagerEventListener> {
     publishAddDataChannel(streamUrl: string): Promise<any>;
     publishStopDataChannel(streamUrl: string, datachannel: any): Promise<void>;
     unpublish(): Promise<void>;
+    getSubscribeNetworkQuality(): Promise<{
+        rtt: number;
+        loss: number;
+        quality: AliRtcNetworkQuality;
+    }>;
     /**
      * 获取 sub/subAdd config
      * @param {ISubscribeConfig | ISubConfigItem} options
@@ -4223,6 +4354,8 @@ declare class SLSReporter {
     reportSubscribeMonitor(callId: string, remoteId: string, traceId: string, msid: string, stats: any[]): void;
     reportNetworkMonitor(candidates: any[]): void;
     reportLoopAudioDelay(ssrc: string, result: any): void;
+    reportCumuAudioDelay(audioSSRC: string, result: any): void;
+    reportCumuVideoDelay(videoSSRC: string, result: any): void;
     /**
      * 加入房间成功埋点
      * @param {number} joinTime

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aliyun-rtc-sdk",
-  "version": "7.2.1",
+  "version": "7.2.2",
   "type": "module",
   "description": "rtc web sdk of aliyun",
   "main": "dist/aliyun-rtc-sdk.umd.js",
@@ -10,7 +10,7 @@
     "@aliyun-sls/web-sts-plugin": "^0.3.5",
     "@aliyun-sls/web-track-browser": "^0.3.5",
     "aliyun-queen-engine": "^6.3.14",
-    "aliyun-rts-sdk": "2.13.7",
+    "aliyun-rts-sdk": "2.13.8",
     "crypto-js": "^4.1.1",
     "dateformat": "^5.0.3",
     "eventemitter3": "^5.0.1",