aliyun-rtc-sdk 6.14.6 → 7.0.0-beta.2

package/dist/types/index.d.ts

@@ -19,6 +19,17 @@ declare interface AliEngineCameraCapturerConfiguration {
     deviceId?: string;
 }
 
+declare interface AliRtcAIAgentParam {
+    /*! ai agent id */
+    agentId: string;
+    /*! ai agent的区域 */
+    region: string;
+    /*! 启动ai agent的action */
+    action: string;
+    /*! 启动ai agent的参数 */
+    params: string;
+}
+
 declare enum AliRtcAudioTrack {
     /** 无麦克风 */
     AliRtcAudioTrackNo = 0,
@@ -62,6 +73,17 @@ declare enum AliRtcCameraDirection {
     CAMERA_FRONT = 1
 }
 
+export declare enum AliRtcCapabilityProfile {
+    Default = 0,
+    Human = 1,
+    Robot = 2
+}
+
+export declare type AliRtcChannelParam = {
+    userName?: string;
+    capabilityProfile?: AliRtcCapabilityProfile;
+};
+
 export declare interface AliRtcCheckResult {
     support: boolean;
     detail: {
@@ -233,6 +255,8 @@ declare class AliRtcEngine_2 extends default_2<AliRtcEngineEventListener> {
     private _authInfoExpiredTimer;
     private _serverCheckAuthInfoTimestamp;
     private _localCheckAuthInfoTimestamp;
+    private _proxyAiTid;
+    private _agentParam;
     constructor(config?: AliRtcEngineConfig);
     /**
      * 获取当前频道号，已经入会成功返回频道号，否则返回undefined
@@ -366,6 +390,7 @@ declare class AliRtcEngine_2 extends default_2<AliRtcEngineEventListener> {
      * ```
      * @param {AliRtcAuthInfo | string} authInfoOrToken (多参数/单参数)   认证信息，从App Server获取。
      * @param {string} userName    任意用于显示的用户名称。不是User ID
+     * @param {any} extraData      入会自定义数据
      * @note
      *    - 异步接口，方法执行成功则为成功入会
      *    - 正常情况一个Appid对应一个App，只有同一个AppId的应用可进行互相童话,不同AppId和channelID不同都不能互通
@@ -373,7 +398,28 @@ declare class AliRtcEngine_2 extends default_2<AliRtcEngineEventListener> {
      *    - 如果已在会中想重新入会，需要先调用 {@link leaveChannel} 离会，且确保方法执行成功
      *    - 用户加入频道后，默认订阅频道内所有其他用户的音视频流，默认推送音视频流到远端，因此将会产生计费，如果想要取消默认订阅可以 {@link joinChannel} 前调用 {@link setDefaultSubscribeAllRemoteAudioStreams} 和 {@link setDefaultSubscribeAllRemoteVideoStreams}
      */
-    joinChannel(authInfoOrToken: AliRtcAuthInfo | string, userName?: string): Promise<void>;
+    joinChannel(authInfoOrToken: AliRtcAuthInfo | string, userNameOrParam?: string | AliRtcChannelParam, extraData?: any): Promise<void>;
+    /**
+     * @brief 加入频道
+     * @details 该方法让用户加入频道，一个频道内可以加入多个用户进行互相通话。
+     * @details 一般在调用该方法前会根据场景先选择频道模式，通过调用 {@link setChannelProfile} 实现，默认频道模式为通信模式 {@link AliRtcSdkChannelProfile.AliRtcSdkCommunication}
+     * ``` javascript
+     * // 设置频道为互动模式
+     * engine.setChannelProfile(AliRtcSdkChannelProfile.AliRtcInteractiveLive);
+     * // 设置角色为主播角色
+     * engine.setClientRole(AliRtcSdkClientRole.AliRtcSdkInteractive);
+     * ```
+     * @param token          认证信息，从App Server获取。
+     * @param channelParam   入会参数，详见{@link AliRtcChannelParam}
+     * @param agentParam     入会参数，详见{@link AliRtcAIAgentParam}
+     * @note
+     *    - 异步接口，方法执行成功则为成功入会
+     *    - 正常情况一个AppId对应一个App，只有同一个AppId的应用可进行互相通话,不同AppId和channelID不同都不能互通
+     *    - 当入会成功后，会触发远端用户收到 {@link AliRtcEngineEventListener.remoteUserOnLineNotify} 回调
+     *    - 如果已在会中想重新入会，需要先调用 {@link leaveChannel} 离会，且确保方法执行成功
+     *    - 用户加入频道后，默认订阅频道内所有其他用户的音视频流，默认推送音视频流到远端，因此将会产生计费，如果想要取消默认订阅可以 {@link joinChannel} 前调用 {@link setDefaultSubscribeAllRemoteAudioStreams} 和 {@link setDefaultSubscribeAllRemoteVideoStreams}
+     */
+    joinAIChannel(token: string, channelParam: AliRtcChannelParam, agentParam: AliRtcAIAgentParam): Promise<void>;
     /**
      * 离开频道
      * @note 如果当前不在频道内，调用 leaveChannel 不会对实例产生任何影响，但会产生消息，通知频道内其他用户
@@ -1200,6 +1246,11 @@ declare interface AliRtcEngineEventListener {
      * @param reason 出错原因，可选
      */
     remoteVideoPlayError: (uid: string, reason: string | undefined) => void;
+    /**
+     * 远程用户订阅数据通道
+     * @param uid 用户ID
+     */
+    remoteUserSubscribedDataChannel: (uid: string) => void;
     /**
      * rtc 传输数据统计
      * @param stats 统计信息
@@ -1246,6 +1297,13 @@ declare interface AliRtcEngineEventListener {
      * @param message 消息
      */
     dataChannelMsg: (uid: string, message: AliRtcDataChannelMsg) => void;
+    /**
+     * @brief AI agent处理结果
+     * @param code 返回code码
+     * @param action 结果对应的action
+     * @param result 结果
+     */
+    AIAgentResult: (code: number, action: string, result: string) => void;
 }
 
 export declare enum AliRtcEngineLocalDeviceExceptionType {
@@ -2202,6 +2260,7 @@ declare class BizControl extends default_2<BizControlListener> {
     private audioVolumeIndicationInterval;
     private indicationTimer;
     private parameter;
+    private dcReadyHelper?;
     constructor(config: BizControlConfig);
     private addSignalingManagerListener;
     isAutoSubAudio(): boolean;
@@ -2250,7 +2309,7 @@ declare class BizControl extends default_2<BizControlListener> {
      * @param {JoinResult} data
      * @returns {Promise<void>}
      */
-    init(authInfo: AliRtcAuthInfo, data: JoinResult): void;
+    init(authInfo: AliRtcAuthInfo, data: JoinResult, channelParam: AliRtcChannelParam): void;
     leave(): Promise<void>;
     /**
      * 离会后清除所有数据
@@ -2330,7 +2389,7 @@ declare class BizControl extends default_2<BizControlListener> {
     setAudioRedEnabled(enable: boolean): void;
     setParameter(parameter: string): void;
     getParameter(): string;
-    sendDataChannelMessage(message: AliRtcDataChannelMsg): Promise<void>;
+    sendDataChannelMessage(message: AliRtcDataChannelMsg): void;
 }
 
 declare interface BizControlConfig {
@@ -2366,6 +2425,7 @@ declare interface BizControlListener {
     remoteSubscribeError: (error: AliRtcError, uid?: string) => void;
     occurError: (error: AliRtcError, uid?: string) => void;
     remoteDataChannelMessage: (uid: string, message: AliRtcDataChannelMsg) => void;
+    remoteUserSubscribedDataChannel: (uid: string) => void;
 }
 
 declare enum ClientEventType {
@@ -2864,7 +2924,7 @@ declare class LocalUser extends User {
     getCurrentMicDeviceId(): string | undefined;
     enableAudioVolumeIndication(interval: number): void;
     sendSEI(message: ArrayBuffer, repeatCount: number, payloadType: number): Promise<void>;
-    sendDataChannelMessage(message: AliRtcDataChannelMsg): Promise<void>;
+    sendDataChannelMessage(message: AliRtcDataChannelMsg): void;
     getStats(): Promise<{
         audio: AliRtcLocalAudioStats[];
         video: AliRtcLocalVideoStats[];
@@ -3008,7 +3068,7 @@ declare class PackageCreater {
      * 创建一个用于发送入会消息的Package
      * @returns
      */
-    createJoinPackage(): ISendPackage;
+    createJoinPackage(extraData?: any): ISendPackage;
     /**
      * 创建一个用于发送离会消息的Package
      * @returns
@@ -3547,6 +3607,7 @@ declare interface RoomServerListener {
     onReconnectFail: (err: AliRtcError) => void;
     onReconnectSuccess: (users: JoinInfo[]) => void;
     onError: (err: AliRtcError) => void;
+    onUnknownMessage: (response: any) => void;
 }
 
 /**
@@ -3567,13 +3628,15 @@ declare class RoomServerMessageCenter extends default_2<RoomServerListener> {
     protected isFirstConnect: boolean;
     protected aliveChecker: number;
     protected reconnectData?: ReconnectData;
+    private joinChannelExtraData?;
     constructor(authInfo: AliRtcAuthInfo, userName: string, channelProfile: AliRtcSdkChannelProfile, clientRole: AliRtcSdkClientRole, slsReporter: SLSReporter, maxConnectRetryCount?: number);
     get retryCount(): number;
     /**
      * 开始连接信令
      * @param roomserverurl
+     * @param joinChannelExtraData 发送 joinChannel 信令时额外携带的数据
      */
-    start(roomserverurl: string): void;
+    start(roomserverurl: string, joinChannelExtraData?: any): void;
     /**
      * 开始心跳计时器，并自动发送心跳包
      */
@@ -3729,6 +3792,7 @@ declare class RoomServerMessageCenter extends default_2<RoomServerListener> {
      * @param {any} response
      */
     protected onBye(response: any): void;
+    protected onUnknownMessage(response: any): void;
 }
 
 declare class RoomServerSignaling extends default_2<RoomServerListener> {
@@ -3759,7 +3823,7 @@ declare class RoomServerSignaling extends default_2<RoomServerListener> {
      * @param {AliRtcAuthInfo} authInfo
      * @returns
      */
-    join(authInfo: AliRtcAuthInfo, userName: string, maxConnectRetryCount?: number): Promise<JoinResult>;
+    join(authInfo: AliRtcAuthInfo, userName: string, maxConnectRetryCount?: number, joinChannelExtraData?: any): Promise<JoinResult>;
     /**
      * 离开频道
      * @returns
@@ -3916,7 +3980,7 @@ declare class SignalingManager extends default_2<RoomServerListener> {
      * @param {AliRtcAuthInfo} authInfo
      * @returns
      */
-    join(authInfo: AliRtcAuthInfo, userName?: string, maxConnectRetryCount?: number, timeRecorder?: TimeRecorder): Promise<JoinResult>;
+    join(authInfo: AliRtcAuthInfo, userName?: string, maxConnectRetryCount?: number, timeRecorder?: TimeRecorder, joinChannelExtraData?: any): Promise<JoinResult>;
     retryJoin(): void;
     /**
      * 向业务信令发送离会
@@ -4016,6 +4080,7 @@ declare class SignalingManager extends default_2<RoomServerListener> {
      * @param {AliRtcError} err
      */
     protected onError(err: AliRtcError): void;
+    protected onUnknownMessage(message: any): void;
 }
 
 declare interface SignalingResult {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aliyun-rtc-sdk",
-  "version": "6.14.6",
+  "version": "7.0.0-beta.2",
   "type": "module",
   "description": "rtc web sdk of aliyun",
   "main": "dist/aliyun-rtc-sdk.umd.js",