aliyun-rtc-sdk 6.11.8 → 6.12.0-beta.0

package/dist/types/index.d.ts

@@ -117,6 +117,22 @@ export declare enum AliRtcConnectionStatusChangeReason {
     AliRtcConnectionChangedNetworkInterrupted = 12
 }
 
+export declare class AliRtcDataChannelMsg {
+    data: ArrayBuffer;
+    networkTime: number;
+    futureOrProgress: number;
+    type: AliRtcDataMsgType;
+    constructor(data: ArrayBuffer, type?: AliRtcDataMsgType, networkTime?: number, progress?: number);
+    toBuffer(): ArrayBuffer;
+    static parse(buffer: ArrayBuffer): AliRtcDataChannelMsg | undefined;
+}
+
+export declare enum AliRtcDataMsgType {
+    AliEngineDataMsgNone = 0,
+    AliEngineDataMsgMusicProgress = 1,
+    AliEngineDataMsgCustom = 2
+}
+
 declare type AliRtcDualVideoPluginOptions = VideoScalerOptions;
 
 export declare class AliRtcEngine extends default_2<AliRtcEngineEventListener> {
@@ -194,6 +210,8 @@ export declare class AliRtcEngine extends default_2<AliRtcEngineEventListener> {
     static AliRtcLiveTranscodingState: typeof AliRtcLiveTranscodingState;
     static AliRtcLiveTranscodingErrorCode: typeof AliRtcLiveTranscodingErrorCode;
     static AliRtcTrascodingPublishTaskStatus: typeof AliRtcTrascodingPublishTaskStatus;
+    static AliRtcDataChannelMsg: typeof AliRtcDataChannelMsg;
+    static AliRtcDataMsgType: typeof AliRtcDataMsgType;
     /**
      * @brief 销毁 {@link AliRtcEngine}实例
      * @details 调用该方法将会释放所有内部使用的资源,当完成音视频通信之后都建议调用该方法释放实例.调用该方法后，你将不能再使用 {@link AliRtcEngine} 的其他方法和任何回调，如需要再次使用需要重新调用 {@link AliRtcEngine.getInstance} 方法创建一个新的实例。
@@ -458,6 +476,7 @@ export declare class AliRtcEngine extends default_2<AliRtcEngineEventListener> {
      * 用于在自动播放失败等场景恢复播放
      */
     resumeRemoteAudioStream(uid: string): void;
+    stopRemoteAudioPlay(uid: string): void;
     /**
      * @brief 是否推送本地视频流
      * @param enabled 是否开启/关闭本地视频流推送
@@ -952,6 +971,11 @@ export declare class AliRtcEngine extends default_2<AliRtcEngineEventListener> {
     enableBackgroundBlur(enable: boolean): void;
     setParameter(parameter: string): void;
     getParameter(): string;
+    /**
+     * @brief 发送 DataChannel 消息
+     * @param dataChannelMsg 伴奏控制消息
+     */
+    sendDataChannelMessage(dataChannelMsg: AliRtcDataChannelMsg): void;
 }
 
 declare interface AliRtcEngineConfig {
@@ -1110,6 +1134,14 @@ declare interface AliRtcEngineEventListener {
      * @param channel 当前频道
      */
     screenSharePublishStateChanged: (oldState: AliRtcPublishState, newState: AliRtcPublishState, elapseSinceLastState: number, channel: string) => void;
+    /**
+     * DataChannel 推流变更回调
+     * @param oldState 之前的推流状态
+     * @param newState 当前的推流状态
+     * @param elapseSinceLastState 状态变更时间间隔(毫秒)
+     * @param channel 当前频道
+     */
+    dataPublishStateChanged: (oldState: AliRtcPublishState, newState: AliRtcPublishState, elapseSinceLastState: number, channel: string) => void;
     /**
      * 相机流订阅情况变更回调
      * @param uid 用户ID
@@ -1137,6 +1169,15 @@ declare interface AliRtcEngineEventListener {
      * @param channel 当前频道
      */
     screenShareSubscribeStateChanged: (uid: string, oldState: AliRtcSubscribeState, newState: AliRtcSubscribeState, elapseSinceLastState: number, channel: string) => void;
+    /**
+     * DataChannel 订阅情况变更回调
+     * @param uid 用户ID
+     * @param oldState 之前的订阅状态
+     * @param newState 当前的订阅状态
+     * @param elapseSinceLastState 状态变更时间间隔(毫秒)
+     * @param channel 当前频道
+     */
+    dataSubscribeStateChanged: (uid: string, oldState: AliRtcSubscribeState, newState: AliRtcSubscribeState, elapseSinceLastState: number, channel: string) => void;
     /**
      * 收到媒体扩展信息回调
      * @param uid 用户ID，媒体信息发送用户的ID
@@ -1211,6 +1252,12 @@ declare interface AliRtcEngineEventListener {
      * @param message 错误消息
      */
     onOccurError: (error: AliRtcError) => void;
+    /**
+     * @brief 收到数据通道消息
+     * @param uid 用户ID
+     * @param message 消息
+     */
+    dataChannelMsg: (uid: string, message: AliRtcDataChannelMsg) => void;
 }
 
 export declare enum AliRtcEngineLocalDeviceExceptionType {
@@ -1269,6 +1316,7 @@ declare enum AliRtcEnv {
 declare class AliRtcError extends Error {
     _code: number;
     _extra?: any;
+    static fromRtsError(error: any): AliRtcError;
     static fromError(error: any, code?: number, fallbackMessage?: string): AliRtcError;
     constructor(code: number, message: string, extra?: any);
     get code(): number;
@@ -1407,6 +1455,8 @@ export declare enum AliRtcErrorCode {
     ERR_SDK_SUBSCRIBE_DUAL_STRAM_FAILED = 16844115,
     /** 订阅屏幕共享失败 */
     ERR_SDK_SUBSCRIBE_SCREEN_SHARE_FAILED = 16844116,
+    /** 订阅 DataChannel 失败 */
+    ERR_SDK_SUBSCRIBE_DATA_FAILED = 16844117,
     /****************************************************
      * 其他错误码
      ****************************************************/
@@ -2268,6 +2318,7 @@ declare class BizControl extends default_2<BizControlListener> {
     setAudioRedEnabled(enable: boolean): void;
     setParameter(parameter: string): void;
     getParameter(): string;
+    sendDataChannelMessage(message: AliRtcDataChannelMsg): Promise<void> | undefined;
 }
 
 declare interface BizControlConfig {
@@ -2283,6 +2334,7 @@ declare interface BizControlListener {
     audioSubscribeStateChanged: (uid: string, oldState: AliRtcSubscribeState, newState: AliRtcSubscribeState, elapseSinceLastState: number, channel: string) => void;
     videoSubscribeStateChanged: (uid: string, oldState: AliRtcSubscribeState, newState: AliRtcSubscribeState, elapseSinceLastState: number, channel: string) => void;
     screenSubscribeStateChanged: (uid: string, oldState: AliRtcSubscribeState, newState: AliRtcSubscribeState, elapseSinceLastState: number, channel: string) => void;
+    dataSubscribeStateChanged: (uid: string, oldState: AliRtcSubscribeState, newState: AliRtcSubscribeState, elapseSinceLastState: number, channel: string) => void;
     userAudioMuted: (uid: string, isMute: boolean) => void;
     userVideoMuted: (uid: string, isMute: boolean) => void;
     userScreenMuted: (userId: string, isMute: boolean) => void;
@@ -2300,6 +2352,7 @@ declare interface BizControlListener {
     remoteAudioPlayError: (uid: string, reason?: string) => void;
     remoteVideoPlayError: (uid: string, reason?: string) => void;
     remoteSubscribeError: (error: AliRtcError) => void;
+    remoteDataChannelMessage: (uid: string, message: AliRtcDataChannelMsg) => void;
 }
 
 declare enum ClientEventType {
@@ -2327,7 +2380,7 @@ declare enum CmdType {
 declare enum CodecType {
     OPUS = "opus",
     H264 = "H264",
-    UNKONWN = ""
+    UNKNOWN = ""
 }
 
 declare const _default: typeof AliRtcEngine;
@@ -2539,6 +2592,7 @@ declare class LocalUser extends User {
     private previewElements;
     private screenPreviewElements;
     private streamManager;
+    private dc;
     protected streamTracks?: TrackInfo[];
     protected publishId: string;
     protected signalingManager: SignalingManager;
@@ -2553,6 +2607,7 @@ declare class LocalUser extends User {
     private videoPubState;
     private videoSmallPubState;
     private screenPubState;
+    private dataPubState;
     private parameter;
     constructor(config: LocalUserConfig);
     get joined(): boolean;
@@ -2724,6 +2779,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>;
     getStats(): Promise<{
         audio: AliRtcLocalAudioStats[];
         video: AliRtcLocalVideoStats[];
@@ -2801,7 +2857,8 @@ declare enum MsidType {
     Audio = "sophon_audio",
     VideoLarge = "sophon_video_camera_large",
     VideoSmall = "sophon_video_camera_small",
-    Screen = "sophon_video_screen_share"
+    Screen = "sophon_video_screen_share",
+    Data = "sophon_data"
 }
 
 declare interface OSSSTSToken {
@@ -2928,7 +2985,7 @@ declare interface RefreshUser {
 }
 
 declare interface RemoteMediaTrackInfo extends MediaTrackInfo {
-    subscribed?: boolean;
+    subscribeState?: RemoteTrackSubscribeState;
 }
 
 declare class RemoteStreamInfo extends default_2<StreamListener> {
@@ -2940,6 +2997,7 @@ declare class RemoteStreamInfo extends default_2<StreamListener> {
     protected videoLargeInfo: RemoteMediaTrackInfo;
     protected videoSmallInfo: RemoteMediaTrackInfo;
     protected screenInfo: RemoteMediaTrackInfo;
+    protected dataInfo: RemoteMediaTrackInfo;
     protected audioVolume: number;
     protected audioMuted: boolean;
     protected userStatus?: DeviceStatus;
@@ -2964,7 +3022,9 @@ declare class RemoteStreamInfo extends default_2<StreamListener> {
      * @returns
      */
     getScreenInfo(): RemoteMediaTrackInfo;
+    getDataInfo(): RemoteMediaTrackInfo;
     get subscribingInfos(): RemoteMediaTrackInfo[];
+    get hasTrack(): boolean;
     /**
      * 远端流是否包含音频轨道
      * @returns
@@ -2990,37 +3050,46 @@ declare class RemoteStreamInfo extends default_2<StreamListener> {
      * @returns
      */
     get hasScreen(): boolean;
+    get hasData(): boolean;
     /**
      * 是否订阅远端流音频轨道
      * @returns
      */
+    get isAudioSubscribed(): boolean;
     get isAudioSubscribing(): boolean;
     /**
      * 是否订阅远端流视频轨道
      * @returns
      */
+    get isVideoSubscribed(): boolean;
     get isVideoSubscribing(): boolean;
     /**
      * 是否订阅远端流视频大流轨道
      * @returns
      */
+    get isVideoLargeSubscribed(): boolean;
     get isVideoLargeSubscribing(): boolean;
     /**
      * 是否订阅远端流视频小流轨道
      * @returns
      */
+    get isVideoSmallSubscribed(): boolean;
     get isVideoSmallSubscribing(): boolean;
     /**
      * 是否订阅远端流屏幕共享轨道
      * @returns
      */
+    get isScreenSubscribed(): boolean;
     get isScreenSubscribing(): boolean;
+    get isDataSubscribed(): boolean;
+    get isDataSubscribing(): boolean;
     get audioCodec(): CodecType;
     get videoCodec(): CodecType;
     get audioTrackInfo(): AliRtcAudioTrack;
     get videoTrackInfo(): AliRtcVideoTrack;
     updateTracks(tracks?: TrackInfo[]): UpdateTracksResult;
-    protected updateRemoteTrackSsrc(audioSsrc: string, videoLargeSsrc: string, videoSmallSsrc: string, screenSsrc: string): void;
+    protected updateRemoteTrackSsrc(audioSsrc: string, videoLargeSsrc: string, videoSmallSsrc: string, screenSsrc: string, dataSsrc: string): void;
+    markRemoteTrackSubscribing(option: SubscribeOptions): any;
     updateRemoteTrackSubState(option: SubscribeOptions): any;
     /**
      * 更新远端用户设备状态
@@ -3035,6 +3104,12 @@ declare interface RemoteSubscribeOptions {
     options: SubscribeOptions;
 }
 
+declare enum RemoteTrackSubscribeState {
+    NotSubscribe = 0,
+    Subscribing = 1,
+    Subscribed = 2
+}
+
 declare class RemoteUser extends User {
     /**
      * @ignore
@@ -3067,6 +3142,9 @@ declare class RemoteUser extends User {
     private videoLargeSubState;
     private videoSmallSubState;
     private screenSubState;
+    private dataSubState;
+    private dc;
+    private dcMsgWaitingPieces;
     streamInfo: RemoteStreamInfo;
     streamUrl: string;
     private parameter;
@@ -3095,6 +3173,7 @@ declare class RemoteUser extends User {
     get isVideoLargeSubscribing(): boolean;
     get isVideoSmallSubscribing(): boolean;
     get isScreenSubscribing(): boolean;
+    get isDataSubscribing(): boolean;
     get audioEnabled(): boolean;
     get videoEnabled(): boolean;
     get screenEnabled(): boolean;
@@ -3150,7 +3229,7 @@ declare class RemoteUser extends User {
      * 用保存的订阅参数恢复订阅
      */
     restore(): void;
-    resumeAudio(): Promise<void | undefined>;
+    resumeAudio(): Promise<void>;
     resumeVideo(videoTrack?: AliRtcVideoTrack): Promise<void>;
     resumePlay(): void;
     /**
@@ -3170,6 +3249,9 @@ declare class RemoteUser extends User {
     private updateScreenStream;
     private clearStream;
     private clearScreenStream;
+    private onDataChannelMessage;
+    private subscribeDataChannel;
+    private subscribeStopDataChannel;
     /**
      * 尝试更新订阅
      * 1. 需要新增订阅的情况：想要订阅 & 没有正在订阅 & 远端有流
@@ -3182,8 +3264,8 @@ declare class RemoteUser extends User {
     private handleAudioPaused;
     private handleVideoPlayFailded;
     private playAudio;
-    private stopPlayAudio;
-    playAll(isScreen?: boolean): void;
+    stopPlayAudio(): void;
+    playAll(isScreen?: boolean, isReplace?: boolean): void;
     /**
      * 播放
      */
@@ -3304,7 +3386,7 @@ declare class RtsManager extends default_2<RtsManagerEventListener> {
     set localJoinTime(time: number);
     setEncodedInsertableStreams(enable: boolean): void;
     setAudioRedEnabled(enable: boolean): void;
-    destroy(): void;
+    clear(): void;
     private startConnect;
     private setConnected;
     get isConnecting(): boolean;
@@ -3316,10 +3398,12 @@ declare class RtsManager extends default_2<RtsManagerEventListener> {
     private waitPublishSender;
     getPublishVideoStats(streamUrl: string, msid?: string): Promise<unknown>;
     getPublishAudioStats(streamUrl: string, msid?: string): Promise<unknown>;
-    publishAdd(streamUrl: string, stream: LocalStream, callId: string, extra?: PublishExtraParams, isResume?: boolean, retryTimes?: number, waitSender?: boolean, reason?: PublishReason): Promise<string>;
+    publishAdd(streamUrl: string, stream: LocalStream, callId: string, extra?: PublishExtraParams, isResume?: boolean, waitSender?: boolean, reason?: PublishReason): Promise<string>;
     publishDelete(streamUrl: string, options: PublishOptions): Promise<string>;
-    publishReplace(streamUrl: string, stream: LocalStream, extra?: PublishExtraParams): Promise<string>;
+    publishReplace(streamUrl: string, stream: LocalStream, extra?: PublishExtraParams): Promise<any>;
     publishStop(streamUrl: string): Promise<string>;
+    publishAddDataChannel(streamUrl: string): Promise<any>;
+    publishStopDataChannel(streamUrl: string, datachannel: any): Promise<void>;
     unpublish(): Promise<void>;
     /**
      * 获取 sub/subAdd config
@@ -3334,6 +3418,8 @@ declare class RtsManager extends default_2<RtsManagerEventListener> {
         stream: any;
     } | undefined>;
     subscibeStop(streamUrl: string): Promise<void>;
+    subscribeAddDataChannel(streamUrl: string): Promise<any>;
+    subscribeStopDatachannel(streamUrl: string, datachannel: any): Promise<any>;
     publish(streamUrl: string, callId: string, isResume?: boolean, reason?: PublishReason): Promise<string>;
     subscribe(remoteSubscribeOptions: RemoteSubscribeOptions, reason: SubscribeReason, callId: string, remoteCallId: string, startTs: number): Promise<any>;
     getSubscribeVideoStats(streamUrl: string, msid?: string): Promise<unknown>;
@@ -3352,6 +3438,10 @@ declare interface RtsManagerEventListener {
 }
 
 declare class SignalingManager extends default_2<RoomServerListener> {
+    /**
+     * @ignore
+     */
+    static logName: string;
     protected signaling?: ISignalingInterface;
     protected authInfo?: AliRtcAuthInfo;
     protected userName?: string;
@@ -3674,6 +3764,7 @@ declare interface StreamOptions {
     audio?: boolean;
     video?: boolean;
     screen?: boolean;
+    data?: boolean;
 }
 
 declare class StsManager extends default_2<StsManagerListener> {
@@ -3781,16 +3872,20 @@ declare interface UserListener {
     audioSubscribeStateChanged: (uid: string, oldState: AliRtcSubscribeState, newState: AliRtcSubscribeState, elapseSinceLastState: number) => void;
     videoSubscribeStateChanged: (uid: string, oldState: AliRtcSubscribeState, newState: AliRtcSubscribeState, elapseSinceLastState: number) => void;
     screenSubscribeStateChanged: (uid: string, oldState: AliRtcSubscribeState, newState: AliRtcSubscribeState, elapseSinceLastState: number) => void;
+    dataSubscribeStateChanged: (uid: string, oldState: AliRtcSubscribeState, newState: AliRtcSubscribeState, elapseSinceLastState: number) => void;
     audioPublishStateChanged: (oldState: AliRtcPublishState, newState: AliRtcPublishState, elapseSinceLastState: number) => void;
     videoPublishStateChanged: (oldState: AliRtcPublishState, newState: AliRtcPublishState, elapseSinceLastState: number) => void;
     dualStreamPublishStateChanged: (oldState: AliRtcPublishState, newState: AliRtcPublishState, elapseSinceLastState: number) => void;
     screenPublishStateChanged: (oldState: AliRtcPublishState, newState: AliRtcPublishState, elapseSinceLastState: number) => void;
+    dataPublishStateChanged: (oldState: AliRtcPublishState, newState: AliRtcPublishState, elapseSinceLastState: number) => void;
     localDeviceException: (localDeviceType: AliRtcEngineLocalDeviceType, localDeviceExceptionType: AliRtcEngineLocalDeviceExceptionType, description: string) => void;
+    publishDataError: (error: AliRtcError) => void;
     remoteAudioAutoPlayFail: (uid: string) => void;
     remoteVideoAutoPlayFail: (uid: string, track: AliRtcVideoTrack) => void;
     remoteAudioPlayError: (uid: string, reason?: string) => void;
     remoteVideoPlayError: (uid: string, reason?: string) => void;
     remoteSubscribeError: (error: AliRtcError) => void;
+    remoteDataChannelMessage: (uid: string, message: AliRtcDataChannelMsg) => void;
 }
 
 declare interface VideoScaler {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aliyun-rtc-sdk",
-  "version": "6.11.8",
+  "version": "6.12.0-beta.0",
   "type": "module",
   "description": "rtc web sdk of aliyun",
   "main": "dist/aliyun-rtc-sdk.js",
@@ -9,7 +9,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.8.1-beta.5",
+    "aliyun-rts-sdk": "2.9.1-beta.2",
     "crypto-js": "^4.1.1",
     "dateformat": "^5.0.3",
     "eventemitter3": "^5.0.1",