aliyun-rtc-sdk 6.13.7 → 6.14.0

package/dist/types/index.d.ts

@@ -634,6 +634,11 @@ declare class AliRtcEngine_2 extends default_2<AliRtcEngineEventListener> {
      * @param {IAudioConstraints} audioConstraints 音频采集参数
      */
     startAudioCapture(audioConstraints?: IAudioConstraints): Promise<void>;
+    /**
+     * @brief 设置音频采集参数
+     * @param constraints 音频采集参数
+     */
+    setAudioConstraints(constraints: IAudioConstraints): Promise<void>;
     /**
      * 关闭音频采集
      * @note 调用此接口后，入会后、离会再入会，采集设备保持关闭状态
@@ -2170,7 +2175,7 @@ declare class BizControl extends default_2<BizControlListener> {
      * @ignore
      */
     static logName: string;
-    protected self: LocalUser | undefined;
+    protected self: LocalUser;
     protected userMap: RemoteUserMap;
     private usersViewMap;
     rtsManager: RtsManager;
@@ -2192,12 +2197,11 @@ declare class BizControl extends default_2<BizControlListener> {
     private defaultStreamType;
     private audioMuted;
     private playoutVolume;
+    private refreshUrlTimer?;
     private audioVolumeIndicationInterval;
     private indicationTimer;
     private parameter;
     constructor(config: BizControlConfig);
-    private publishRetryOptionsHook;
-    private subscribeRetryOptionsHook;
     private addSignalingManagerListener;
     isAutoSubAudio(): boolean;
     setAutoSubAudio(value: boolean): void;
@@ -2234,10 +2238,15 @@ declare class BizControl extends default_2<BizControlListener> {
      * @returns {void}
      */
     onRemotePublishStateChange(publishInfo: PublishUser): void;
+    /** 定期更新所有人的推拉流地址，便于重连
+     * @param pushStreamUrl 已有的推流地址，根据地址中的过期时间来设置定时器
+     * @private
+     */
+    private setTimeoutToUpdateAllStreamUrls;
     /**
      * 登陆成功后初始化用户管理，创建自己
      * @param {AliRtcAuthInfo} authInfo
-     * @param {string} pushStreamUrl
+     * @param {JoinResult} data
      * @returns {Promise<void>}
      */
     init(authInfo: AliRtcAuthInfo, data: JoinResult): void;
@@ -2320,7 +2329,7 @@ declare class BizControl extends default_2<BizControlListener> {
     setAudioRedEnabled(enable: boolean): void;
     setParameter(parameter: string): void;
     getParameter(): string;
-    sendDataChannelMessage(message: AliRtcDataChannelMsg): Promise<void> | undefined;
+    sendDataChannelMessage(message: AliRtcDataChannelMsg): Promise<void>;
 }
 
 declare interface BizControlConfig {
@@ -2386,6 +2395,15 @@ declare enum CodecType {
     UNKNOWN = ""
 }
 
+/**
+ * websocket链接状态
+ */
+declare enum CONNECTSTATUS {
+    DISCONNECTED = 0,
+    CONNECTING = 1,
+    CONNECTED = 2
+}
+
 declare interface DeviceStatus {
     micOpen: boolean;
     micInterrupted: boolean;
@@ -2411,17 +2429,41 @@ declare enum DisplayType {
     WHEN_NO_VIDEO = 2
 }
 
-declare interface ISignalingInterface {
-    join(authInfo: AliRtcAuthInfo, userName: string, connectRetryCount?: number): Promise<JoinResult>;
-    leave(): Promise<SignalingResult>;
-    publish(publishInfo: PublishInfo): Promise<SignalingResult>;
-    roleUpdate(role: AliRtcSdkClientRole): Promise<SignalingResult>;
-    setChannelProfile(channelProfile: AliRtcSdkChannelProfile): void;
-    refreshUrl(info: RefreshInfo): Promise<RefreshUrlResult>;
-    refreshAuthInfo(authInfo: AliRtcAuthInfo): Promise<void>;
-    reportStatus(status: string): Promise<void>;
-    on(event: string, listener: Function): void;
-    reset(): void;
+declare interface IResponse {
+    version: number;
+    code: number;
+    msgtype: MessageType;
+    tid: string;
+    isproxy?: boolean;
+}
+
+declare interface ISendPackage {
+    version: number;
+    msgtype: MessageType;
+    tid: string;
+    header: {
+        appid: string;
+        channelid: string;
+        sessionid: string;
+        userid: string;
+        displayName?: string;
+        clientversion?: string;
+        platform?: string;
+    };
+    data: {
+        seq: number;
+        l1ip?: string;
+        status?: string;
+        clientrole?: string;
+        configure?: {
+            clientrole?: AliRtcSdkClientRole;
+            channelprofile: AliRtcSdkChannelProfile;
+        };
+        auth?: SendPackageAuthInfo;
+        sessionid?: string;
+        pushstreamurl?: string;
+        users?: any[];
+    };
 }
 
 /**
@@ -2585,7 +2627,7 @@ declare class LocalUser extends User {
      * @ignore
      */
     static logName: string;
-    protected url: string;
+    private _url;
     private joinTime;
     private _isPublishing;
     private publishPromise;
@@ -2610,6 +2652,8 @@ declare class LocalUser extends User {
     private dataPubState;
     private parameter;
     constructor(config: LocalUserConfig);
+    get url(): string;
+    set url(value: string);
     get joined(): boolean;
     get isPublishing(): boolean;
     get publishStreams(): PublishStreamInfo;
@@ -2644,6 +2688,7 @@ declare class LocalUser extends User {
     muteLocalMic(mute: boolean): void;
     muteLocalScreen(mute: boolean): void;
     setMicrophoneDeviceId(deviceId: string): void;
+    setMicrophoneConstraints(constraints: MediaTrackConstraints): void;
     updatePubId(): void;
     clearPublishState(): void;
     leave(): Promise<void>;
@@ -2856,6 +2901,23 @@ declare interface MediaTrackInfo {
     type?: CmdType;
 }
 
+declare enum MessageType {
+    KEEPALIVE = "keepalive",
+    JOINCHANNEL = "joinchannel",
+    NOTIFYJOIN = "notifyjoin",
+    NOTIFYSTATUS = "notifystatus",
+    STATUSREPORT = "statusreport",
+    LEAVECHANNEL = "leavechannel",
+    NOTIFYLEAVE = "notifyleave",
+    NOTIFYPUBLISH = "notifypublish",
+    BYE = "bye",
+    RECONNECT = "reconnect",
+    PUBLISH = "publish",
+    REFRESHURL = "refreshurl",
+    UNSUBSCRIBE = "unsubscribe",
+    ROLEUPDATE = "roleupdate"
+}
+
 declare enum MPU_TASK_TRANSACTION_TYPE {
     MPU_TASK_TRANSACTION_START = 0,
     MPU_TASK_TRANSACTION_UPDATE = 1,
@@ -2892,6 +2954,53 @@ declare interface OSSToken {
     expiration: number;
 }
 
+declare class PackageCreater {
+    protected authInfo: AliRtcAuthInfo;
+    protected userName: string;
+    protected seqIndex: number;
+    constructor(authInfo: AliRtcAuthInfo, userName: string);
+    get roleAuth(): SendPackageAuthInfo | undefined;
+    refreshAuthInfo(authInfo: AliRtcAuthInfo): void;
+    getSeqIndex(): number;
+    /**
+     * 创建一个心跳包
+     * @returns
+     */
+    createKeepAlivePackage(): ISendPackage;
+    /**
+     * 创建一个用于发送入会消息的Package
+     * @returns
+     */
+    createJoinPackage(): ISendPackage;
+    /**
+     * 创建一个用于发送离会消息的Package
+     * @returns
+     */
+    crateLeavePackage(): ISendPackage;
+    createStatusPackage(status: string): ISendPackage;
+    /**
+     * 创建一个用于发送推流消息的Package
+     * @returns
+     */
+    createPublishPackage(): ISendPackage;
+    createRoleUpdatePackage(): ISendPackage;
+    createReconnectPackage(data?: ReconnectData): ISendPackage;
+    createRefreshUrlPackage(): ISendPackage;
+    /**
+     * 创建一个Response包
+     * @param {string} tid            Notify消息的tid
+     * @param {MessageType} msgType   消息类型
+     * @returns {IResponse}
+     */
+    createResponsePackage(tid: string, msgType: MessageType): IResponse;
+    /**
+     *
+     * @param messageType
+     * @returns
+     */
+    protected createBaseSendPackage(messageType: MessageType): ISendPackage;
+}
+
 declare type Parameter = {
     [key: string]: any;
 };
@@ -2988,6 +3097,14 @@ declare interface PublishUser {
     userid: string;
 }
 
+declare interface ReconnectData {
+    role?: RoleForReconnectData;
+    auth?: SendPackageAuthInfo;
+    publish?: {
+        users: [PublishInfo];
+    };
+}
+
 declare interface RefreshInfo {
     pushstreamurl?: string;
     users?: RefreshUser[];
@@ -3167,12 +3284,14 @@ declare class RemoteUser extends User {
     private dc;
     private dcMsgWaitingPieces;
     streamInfo: RemoteStreamInfo;
-    streamUrl: string;
+    private _streamUrl;
     private parameter;
     private monitorTimerId?;
     private monitorDataCache;
     private trackTraceIdMap;
     constructor(config: RemoteUserConfig);
+    get streamUrl(): string;
+    set streamUrl(value: string);
     isWantSubAudio(): boolean;
     setWantSubAudio(value: boolean): void;
     isWantSubVideo(): boolean;
@@ -3361,6 +3480,11 @@ declare interface RemoteUserViewMap {
     screenViews: HTMLVideoElement[];
 }
 
+declare interface RoleForReconnectData {
+    channelprofile?: AliRtcSdkChannelProfile;
+    clientrole?: AliRtcSdkClientRole;
+}
+
 /**
  * RoomServerMessageCenter支持的事件
  */
@@ -3386,6 +3510,247 @@ declare interface RoomServerListener {
     onError: (err: AliRtcError) => void;
 }
 
+/**
+ * RoomServer消息中心
+ * 负责发送和接收信令数据，消息重发、回复Response
+ */
+declare class RoomServerMessageCenter extends default_2<RoomServerListener> {
+    static logName: string;
+    protected authInfo: AliRtcAuthInfo;
+    protected userName: string;
+    protected channelProfile: AliRtcSdkChannelProfile;
+    protected clientRole: AliRtcSdkClientRole;
+    private slsReporter;
+    protected wsClient: Socket;
+    protected packageCreater: PackageCreater;
+    protected keepAliveTimer: number;
+    protected packageCache: Map<string, ISendPackage>;
+    protected isFirstConnect: boolean;
+    protected aliveChecker: number;
+    protected reconnectData?: ReconnectData;
+    constructor(authInfo: AliRtcAuthInfo, userName: string, channelProfile: AliRtcSdkChannelProfile, clientRole: AliRtcSdkClientRole, slsReporter: SLSReporter, maxConnectRetryCount?: number);
+    get retryCount(): number;
+    /**
+     * 开始连接信令
+     * @param roomserverurl
+     */
+    start(roomserverurl: string): void;
+    /**
+     * 开始心跳计时器，并自动发送心跳包
+     */
+    startKeepAlive(): void;
+    /**
+     * 停止心跳计时器
+     */
+    stopKeepAlive(): void;
+    /**
+     * 发送入会、重连前所缓存信息
+     */
+    sendPkgCache(): void;
+    /**
+     * 发送离开房间
+     */
+    leave(): void;
+    /**
+     * 透明通道消息上报
+     * @param status
+     */
+    reportStatus(status: string): void;
+    /**
+     * 发送推流消息
+     */
+    publish(_pubInfo: PublishInfo): void;
+    /**
+     * 更新角色
+     */
+    roleUpdate(role: string): void;
+    /**
+     * 更新推拉流地址
+     * @param {RefreshInfo} info
+     */
+    refreshUrl(info: RefreshInfo): void;
+    refreshAuthInfo(authInfo: AliRtcAuthInfo): void;
+    /**
+     * 关闭websocket连接，并销毁
+     */
+    close(): void;
+    /**
+     * 通过此方法发送数据到业务信令
+     * 此方法会自动保存发送的package，并做重发.
+     * response包不要通过此方法发送
+     * @param pkg
+     */
+    protected sendPackage(pkg: ISendPackage): void;
+    /**
+     * 更新重连 payload
+     * @param {ReconnectData} reconnectData
+     */
+    updateReconnectData(reconnectData?: ReconnectData): void;
+    /**
+     * 收到websocket连接成功的消息
+     * ws连接建立成功后立刻发送join消息
+     */
+    protected onOpen(): void;
+    /**
+     * 收到业务信令消息
+     * @param event
+     */
+    protected onMessage(event: MessageEvent): void;
+    /**
+     * 收到错误消息
+     * @param event
+     */
+    protected onError(event: Event): void;
+    /**
+     * 连接失败
+     */
+    protected onConnectFail(): void;
+    /**
+     * 鉴权失败
+     */
+    protected onAuthInvalid(): void;
+    /**
+     * 网络异常
+     */
+    protected onNetworkError(): void;
+    /**
+     * 收到websocket断开消息
+     * @param event
+     */
+    protected onClose(event: CloseEvent): void;
+    protected onKeepAliveRsp(): void;
+    protected onReconnectStart(): void;
+    protected onReconnectFail(): void;
+    /**
+     * 处理 Keepalive 心跳，加速判断网络异常
+     */
+    protected checkAlive(): void;
+    /**
+     * 处理收到的业务信令
+     * @param response
+     */
+    protected onRecvMessage(response: any): void;
+    /**
+     * 收到入会消息的response
+     * @param response
+     */
+    protected onJoinResult(response: any): void;
+    /**
+     * 收到离开消息的response
+     * @param response
+     */
+    protected onLeaveResult(response: any): void;
+    /**
+     * 收到publish消息的response
+     * @param response
+     */
+    protected onPublishResult(response: any): void;
+    /**
+     * 收到roleUpdate消息的response
+     * @param response
+     */
+    protected onRoleUpdateResult(response: any): void;
+    /**
+     * 收到 refreshurl 消息的response
+     * @param response
+     */
+    protected onRefreshUrlResult(response: any): void;
+    /**
+     * 收到重联消息的response
+     * @param response
+     */
+    protected onReconnectResult(response: any): void;
+    /**
+     * 收到业务信令下发的消息
+     * @param response
+     */
+    protected onNotifyJoin(response: any): void;
+    /**
+     * 收到业务信令下发的透明通道消息
+     * @param response
+     */
+    protected onNotifyStatus(response: any): void;
+    /**
+     * 收到远端用户离开的通知
+     * @param response
+     */
+    protected onNotifyLeave(response: any): void;
+    /**
+     * 收到远端用户推流的通知
+     * @param response
+     */
+    protected onNotifyPublish(response: any): void;
+    /**
+     * 收到statusreport的response
+     * @param response
+     */
+    protected onStatusReport(response: any): void;
+    /**
+     * 收到被踢出频道的消息
+     * @param {any} response
+     */
+    protected onBye(response: any): void;
+}
+
+declare class RoomServerSignaling extends default_2<RoomServerListener> {
+    /**
+     * @ignore
+     */
+    static logName: string;
+    protected messageCenter?: RoomServerMessageCenter;
+    protected authInfo?: AliRtcAuthInfo;
+    protected userName?: string;
+    protected channelProfile: AliRtcSdkChannelProfile;
+    protected clientRole: AliRtcSdkClientRole;
+    private slsReporter;
+    protected reconnectData?: ReconnectData;
+    protected roomServerUri: string;
+    constructor(channelProfile: AliRtcSdkChannelProfile, clientRole: AliRtcSdkClientRole, slsReporter: SLSReporter, env?: AliRtcEnv);
+    /**
+     * 更新重连数据
+     * @param {ReconnectData} reconnectData
+     */
+    private updateReconnectData;
+    /**
+     * 释放资源
+     */
+    reset(): void;
+    /**
+     * 加入频道
+     * @param {AliRtcAuthInfo} authInfo
+     * @returns
+     */
+    join(authInfo: AliRtcAuthInfo, userName: string, maxConnectRetryCount?: number): Promise<JoinResult>;
+    /**
+     * 离开频道
+     * @returns
+     */
+    leave(): Promise<SignalingResult>;
+    /**
+     * 开始推流
+     * @param pubInfo
+     * @returns
+     */
+    publish(pubInfo: PublishInfo): Promise<SignalingResult>;
+    roleUpdate(role: AliRtcSdkClientRole): Promise<SignalingResult>;
+    setChannelProfile(channelProfile: AliRtcSdkChannelProfile): void;
+    /**
+     * 更新推流地址
+     */
+    refreshUrl(info: RefreshInfo): Promise<RefreshUrlResult>;
+    /**
+     * 上报设备状态
+     * @param status
+     */
+    reportStatus(status: string): Promise<void>;
+    protected handleSignalError(code: number, description: string, errorCode?: AliRtcErrorCode): AliRtcError;
+    refreshAuthInfo(authInfo: AliRtcAuthInfo): Promise<void>;
+    /**
+     * 初始化MessageCenter，增加事件监听
+     */
+    protected initMessageCenter(): void;
+}
+
 declare class RtsManager extends default_2<RtsManagerEventListener> {
     /**
      * @ignore
@@ -3402,16 +3767,19 @@ declare class RtsManager extends default_2<RtsManagerEventListener> {
     private connected;
     private _pcTraceId;
     private _localJoinTime;
-    private publishRetryHook?;
-    private subscribeRetryOptionsHook?;
     private connectionResolve?;
     private connectingPromise?;
     private dcResolve?;
     private dcConnectingPromise?;
     private _publishingTracks;
     private parameter;
-    constructor(localStreamManager: LocalStreamManager, slsReporter: SLSReporter, publishRetryHook: () => void, subscribeRetryOptionsHook: () => RemoteSubscribeOptions | undefined, parameter: Parameter);
+    constructor(localStreamManager: LocalStreamManager, slsReporter: SLSReporter, parameter: Parameter);
     private addRTSListener;
+    /**
+     * 更新鉴权信息，传入一个新的带鉴权的 URL，RTS 会去除鉴权信息做更新
+     * @param newUrlWithAuth
+     */
+    updateAuth(newUrlWithAuth: string): void;
     get pcTraceId(): string;
     set localJoinTime(time: number);
     setEncodedInsertableStreams(enable: boolean): void;
@@ -3443,7 +3811,7 @@ declare class RtsManager extends default_2<RtsManagerEventListener> {
     private getSubConfig;
     private httpSubscribe;
     private subscribeAdd;
-    subscibeDelete(subscribeOptions: RemoteSubscribeOptions): Promise<{
+    subscribeDelete(subscribeOptions: RemoteSubscribeOptions): Promise<{
         url: string;
         stream: any;
     } | undefined>;
@@ -3475,12 +3843,19 @@ declare enum RtsPeerConnectionType {
     SUBSCRIBE = "subscribe"
 }
 
+declare interface SendPackageAuthInfo {
+    timestamp: number;
+    nonce?: string;
+    token: string;
+    tokenrole: AliRtcSdkTokenRole;
+}
+
 declare class SignalingManager extends default_2<RoomServerListener> {
     /**
      * @ignore
      */
     static logName: string;
-    protected signaling?: ISignalingInterface;
+    protected signaling?: RoomServerSignaling;
     protected authInfo?: AliRtcAuthInfo;
     protected userName?: string;
     protected channelProfile: AliRtcSdkChannelProfile;
@@ -3560,7 +3935,7 @@ declare class SignalingManager extends default_2<RoomServerListener> {
      * 收到远端用户推流状态变化消息
      * @param {PublishInfo[]} users
      */
-    protected onNotifyPublish(users: PublishInfo[]): void;
+    protected onNotifyPublish(users: PublishUser[]): void;
     /**
      * 收到被踢掉消息
      * @param {string} reason
@@ -3579,9 +3954,8 @@ declare class SignalingManager extends default_2<RoomServerListener> {
     protected onNetworkError(err: AliRtcError): void;
     /**
      * 收到网络异常消息
-     * @param {AliRtcError} _err
      */
-    protected onAuthInvalid(_err: AliRtcError): void;
+    protected onAuthInvalid(): void;
     protected onReconnectStart(): void;
     /**
      * 收到重连成功消息
@@ -3785,6 +4159,91 @@ declare interface SLSToken {
     expiration: number;
 }
 
+/**
+ * Websocket类
+ */
+declare class Socket extends default_2<SocketListener> {
+    /**
+     * @ignore
+     */
+    static logName: string;
+    protected ws?: WebSocket;
+    protected socketStatus: CONNECTSTATUS;
+    protected wsUrl: string;
+    protected lastConnectStartTime: number;
+    protected maxConnectRetryCount: number;
+    connectRetryCount: number;
+    protected gotErr: boolean;
+    protected closedByInvoke: boolean;
+    protected isReconnecting: boolean;
+    protected networkAvailableChecked: boolean;
+    private reconnectTimeoutId;
+    constructor(maxConnectRetryCount?: number);
+    get connectUrl(): string;
+    /**
+     * 返回websocket连接的状态
+     */
+    get connectStatus(): CONNECTSTATUS;
+    /**
+     * 开始连接
+     * @param wsUrl
+     */
+    start(wsUrl: string): void;
+    /**
+     * 发送消息
+     * @param pkg
+     */
+    send(pkg: ISendPackage | IResponse): boolean;
+    /**
+     * 主动断开连接
+     */
+    close(): void;
+    reconnect(): void;
+    /**
+     * 连接成功
+     * @param event
+     */
+    protected onOpen(event: Event): void;
+    /**
+     * 收到消息
+     * @param event
+     */
+    protected onMessage(event: MessageEvent): void;
+    /**
+     * 收到错误
+     * @param event
+     */
+    protected onError(event: Event): void;
+    /**
+     * 连接断开
+     * @param event
+     */
+    protected onClose(event: CloseEvent): Promise<void>;
+    /**
+     * 初始化websocket
+     */
+    protected initWebSocket(): void;
+    /**
+     * 反初始化websocket
+     */
+    protected uninitWebsocket(): void;
+}
+
+/**
+ * Socket的支持的事件
+ */
+declare interface SocketListener {
+    onOpen: (event: Event) => void;
+    onMessage: (event: MessageEvent) => void;
+    onError: (event: Event) => void;
+    onClose: (event: CloseEvent) => void;
+    onConnectFail: () => void;
+    onAuthInvalid: () => void;
+    onNetworkError: () => void;
+    onReconnectStart: () => void;
+    onReconnectFail: (event: Event) => void;
+}
+
 declare interface StopPreviewConfig {
     videoElement?: HTMLVideoElement;
     primary?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aliyun-rtc-sdk",
-  "version": "6.13.7",
+  "version": "6.14.0",
   "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.3",
-    "aliyun-rts-sdk": "2.9.3-beta.0",
+    "aliyun-rts-sdk": "^2.10.2",
     "crypto-js": "^4.1.1",
     "dateformat": "^5.0.3",
     "eventemitter3": "^5.0.1",