aliyun-rtc-sdk 6.11.5-beta.6 → 6.11.6-beta.1

package/dist/plugins/beautyPlugin.d.ts

@@ -0,0 +1,208 @@
+import EventEmitter from 'eventemitter3';
+import { LocalStream, IProfile } from 'aliyun-rts-sdk';
+import { IVideoConstraints, IAudioConstraints } from 'media-device';
+import { QueenEngineWorker } from 'aliyun-queen-engine';
+import { BeautyParams } from 'aliyun-queen-engine/dist/QueenTypes';
+
+declare enum VideoStreamSource {
+    Camera = 0,
+    Screen = 1,
+    Image = 2
+}
+declare enum AudioStreamSource {
+    Microphone = 0,
+    Screen = 1,
+    Mixed = 2
+}
+/**
+ * ------------------    模式    ----- 采样率  -----  声道  -----  码率（kbps）  -----
+ *
+ * standard:           标准音质         48000       单声道          64
+ *
+ * high:                 高音质         48000       单声道         128
+ *
+ * standard-stereo:   立体声音质         48000       双声道         80
+ *
+ * high-stereo:       立体声高音质       48000       双声道         192
+ */
+type AudioProfileKey = 'standard' | 'high' | 'standard-stereo' | 'high-stereo';
+
+declare enum AliRtcRawDataStreamType {
+    /** 相机流 */
+    AliRtcSdkStreamTypeCapture = 0,
+    /** 屏幕共享流 */
+    AliRtcSdkStreamTypeScreen = 1
+}
+
+interface AliRtcLocalStreamListener {
+    videotrackended: () => void;
+    audiotrackended: () => void;
+}
+declare class AliRtcLocalStreamInfo extends EventEmitter<AliRtcLocalStreamListener> {
+    type: AliRtcRawDataStreamType;
+    originVideoTrack?: MediaStreamTrack;
+    videoSource?: VideoStreamSource;
+    private _videoMuted;
+    originAudioTrack?: MediaStreamTrack;
+    audioSource?: AudioStreamSource;
+    private _audioMuted;
+    private _targetVideoTrack?;
+    private _targetDualVideoTrack?;
+    private _targetAudioTrack?;
+    private _publishVideoStream?;
+    private _publishDualVideoStream?;
+    private _publishAudioStream?;
+    private _previewStream?;
+    plugins: AliRtcPlugin[];
+    private _profileManager?;
+    cameraVideoConstraints?: IVideoConstraints;
+    micAudioConstraints?: IAudioConstraints;
+    private get profileManager();
+    get audioProfile(): AudioProfileKey | undefined;
+    constructor(type: AliRtcRawDataStreamType);
+    private onVideoTrackEnded;
+    private onAudioTrackEnded;
+    updateSource(newStream: LocalStream, newVideoSource?: VideoStreamSource, newAudioSource?: AudioStreamSource): Promise<void>;
+    get currentProfile(): string | undefined;
+    get currentVideoTrack(): MediaStreamTrack | undefined;
+    get currentDualVideoTrack(): MediaStreamTrack | undefined;
+    get publishVideoStream(): LocalStream | undefined;
+    get publishDualVideoStream(): LocalStream | undefined;
+    get currentAudioTrack(): MediaStreamTrack | undefined;
+    get publishAudioStream(): LocalStream | undefined;
+    get previewStream(): LocalStream | undefined;
+    /**
+     * 更新 VideoTrack
+     * @param videoTrack
+     */
+    updateVideoTrack(videoTrack?: MediaStreamTrack, force?: boolean): Promise<void>;
+    /**
+     * 更新 DualVideoTrack
+     * @param videoTrack
+     * @param force
+     */
+    updateDualVideoTrack(videoTrack?: MediaStreamTrack, force?: boolean): Promise<void>;
+    /**
+     * 更新 AudioTrack
+     * @param audioTrack
+     */
+    updateAudioTrack(audioTrack?: MediaStreamTrack, force?: boolean): Promise<void>;
+    /**
+     * 设置音频流静音
+     * @param muted
+     */
+    setAudioMuted(muted: boolean): void;
+    get isAudioMuted(): boolean;
+    /**
+     * 设置视频流静音
+     * @param muted
+     */
+    setVideoMuted(muted: boolean): void;
+    get isVideoMuted(): boolean;
+    process(localStreamInfos: AliRtcLocalStreamInfo[]): Promise<void>;
+    /**
+     * 停止视频流
+     */
+    stopVideo(): void;
+    /**
+     * 停止音频流
+     */
+    stopAudio(): void;
+    /**
+     * 停止视频流和音频流
+     */
+    stop(): void;
+    /**
+     * 应该在执行完 plugin 后调用
+     * @param profileName
+     * @param profileValue
+     */
+    updateVideoProfile(profileName?: string, profileValue?: IProfile): Promise<void>;
+    get videoProfile(): string | undefined;
+    setVideoContentHint(hint?: string): void;
+    /**
+     * 应该在执行完 plugin 后调用
+     * @param profileName
+     */
+    updateAudioProfile(profileKey: AudioProfileKey): Promise<void>;
+    /**
+     * 复制视频 profile 到指定 LocalStream
+     * @param publishStream
+     */
+    cloneVideoProfile(publishStream: LocalStream): Promise<void>;
+    addPlugin(plugin: AliRtcPlugin): void;
+    removePlugin(plugin: AliRtcPlugin): boolean;
+}
+
+declare enum AliRtcPluginType {
+    PRE_PROCESSOR = 0,
+    POST_PROCESSOR = 1
+}
+declare enum AliRtcPluginTrackType {
+    AUDIO = 0,
+    VIDEO = 1,
+    BOTH = 2
+}
+interface AliRtcPluginListener {
+    enabled: () => void;
+    disabled: () => void;
+    updated: () => void;
+    ready: () => void;
+    overload: (info: any) => void;
+    error: (error: any) => void;
+    unsupported: () => void;
+}
+declare abstract class AliRtcPlugin extends EventEmitter<AliRtcPluginListener> {
+    name: string;
+    options: any;
+    type: AliRtcPluginType;
+    streamType: AliRtcRawDataStreamType;
+    trackType: AliRtcPluginTrackType;
+    zIndex: number;
+    private _isEnable;
+    lastInputAudioTrack?: MediaStreamTrack;
+    lastOutputAudioTrack?: MediaStreamTrack;
+    lastInputVideoTrack?: MediaStreamTrack;
+    lastOutputVideoTrack?: MediaStreamTrack;
+    constructor(name: string, streamType?: AliRtcRawDataStreamType, trackType?: AliRtcPluginTrackType);
+    get initOptions(): {};
+    getOptions(): any;
+    abstract setOptions(options: any): void;
+    abstract isSupported(version: string): boolean;
+    init(): Promise<void>;
+    enable(): void;
+    disable(): void;
+    get isEnable(): boolean;
+    protected audioUpdated(streamInfo: AliRtcLocalStreamInfo): boolean;
+    protected videoUpdated(streamInfo: AliRtcLocalStreamInfo): boolean;
+    execute(streamInfo: AliRtcLocalStreamInfo, streamInfos: AliRtcLocalStreamInfo[]): Promise<void>;
+    abstract shouldUpdate(streamInfo: AliRtcLocalStreamInfo, streamInfos: AliRtcLocalStreamInfo[]): boolean;
+    abstract process(streamInfo: AliRtcLocalStreamInfo, streamInfos: AliRtcLocalStreamInfo[]): Promise<void>;
+    clear(_streamInfo?: AliRtcLocalStreamInfo): void;
+}
+
+type AliRtcBeautyPluginOptions = {
+    licenseKey?: string;
+} & BeautyParams;
+declare class AliRtcBeautyPlugin extends AliRtcPlugin {
+    engineReady: boolean;
+    _queenEngine?: QueenEngineWorker;
+    canvas?: HTMLCanvasElement;
+    dirty: boolean;
+    lastFrameTimestamp: number;
+    continuousStuckCount: number;
+    get initOptions(): {
+        licenseKey: string;
+    };
+    setOptions(options: AliRtcBeautyPluginOptions): void;
+    constructor();
+    init(): Promise<void>;
+    isSupported(): boolean;
+    private initQueen;
+    shouldUpdate(streamInfo: AliRtcLocalStreamInfo): boolean;
+    process(streamInfo: AliRtcLocalStreamInfo): Promise<void>;
+    get queenEngine(): QueenEngineWorker | undefined;
+    clear(streamInfo?: AliRtcLocalStreamInfo): void;
+}
+
+export { AliRtcBeautyPlugin as default };

package/dist/plugins/beautyPlugin.js

@@ -0,0 +1 @@
+(function(r,u){typeof exports=="object"&&typeof module<"u"?module.exports=u(require("eventemitter3"),require("aliyun-queen-engine")):typeof define=="function"&&define.amd?define(["eventemitter3","aliyun-queen-engine"],u):(r=typeof globalThis<"u"?globalThis:r||self,r.AliRtcBeautyPlugin=u(r.n,r.aliyunQueenEngine))})(this,function(r,u){"use strict";var c;(function(t){t[t.AliRtcSdkStreamTypeCapture=0]="AliRtcSdkStreamTypeCapture",t[t.AliRtcSdkStreamTypeScreen=1]="AliRtcSdkStreamTypeScreen"})(c||(c={}));var h=c,p=Object.defineProperty,l=(t,e,i)=>e in t?p(t,e,{enumerable:!0,configurable:!0,writable:!0,value:i}):t[e]=i,n=(t,e,i)=>(l(t,typeof e!="symbol"?e+"":e,i),i),d;(function(t){t[t.PRE_PROCESSOR=0]="PRE_PROCESSOR",t[t.POST_PROCESSOR=1]="POST_PROCESSOR"})(d||(d={}));var a;(function(t){t[t.AUDIO=0]="AUDIO",t[t.VIDEO=1]="VIDEO",t[t.BOTH=2]="BOTH"})(a||(a={}));class T extends r{constructor(e,i=h.AliRtcSdkStreamTypeCapture,s=a.VIDEO){super(),n(this,"name"),n(this,"options"),n(this,"type",d.PRE_PROCESSOR),n(this,"streamType"),n(this,"trackType"),n(this,"zIndex",1),n(this,"_isEnable",!0),n(this,"lastInputAudioTrack"),n(this,"lastOutputAudioTrack"),n(this,"lastInputVideoTrack"),n(this,"lastOutputVideoTrack"),this.name=e,this.streamType=i,this.trackType=s,this.options=this.initOptions}get initOptions(){return{}}getOptions(){return this.options}async init(){}enable(){this._isEnable||(this._isEnable=!0,this.init(),this.emit("enabled"))}disable(){this._isEnable&&(this._isEnable=!1,this.clear(),this.emit("disabled"))}get isEnable(){return this._isEnable}audioUpdated(e){return this.lastInputAudioTrack?.id!==e.currentAudioTrack?.id}videoUpdated(e){return this.lastInputVideoTrack?.id!==e.currentVideoTrack?.id}async execute(e,i){const s=this.shouldUpdate(e,i);this.lastInputAudioTrack=e.currentAudioTrack,this.lastInputVideoTrack=e.currentVideoTrack,s?await this.process(e,i):(this.lastOutputAudioTrack&&(this.trackType===a.BOTH||this.trackType===a.AUDIO)&&this.lastOutputAudioTrack&&e.updateAudioTrack(this.lastOutputAudioTrack),this.lastOutputVideoTrack&&(this.trackType===a.BOTH||this.trackType===a.VIDEO)&&this.lastOutputVideoTrack&&e.updateVideoTrack(this.lastOutputVideoTrack)),this.lastOutputAudioTrack=e.currentAudioTrack,this.lastOutputVideoTrack=e.currentVideoTrack}clear(e){this.lastInputAudioTrack=void 0,this.lastInputVideoTrack=void 0,this.lastOutputAudioTrack=void 0,this.lastOutputVideoTrack=void 0}}var k=Object.defineProperty,y=(t,e,i)=>e in t?k(t,e,{enumerable:!0,configurable:!0,writable:!0,value:i}):t[e]=i,o=(t,e,i)=>(y(t,typeof e!="symbol"?e+"":e,i),i);class g extends T{constructor(){super("AliRtcBeauty"),o(this,"engineReady",!1),o(this,"_queenEngine"),o(this,"canvas"),o(this,"dirty",!1),o(this,"lastFrameTimestamp",0),o(this,"continuousStuckCount",0),this.zIndex=0}get initOptions(){return{licenseKey:""}}setOptions(e){const i=!!e.segmentBackgroundProcess?.enable,s=!!e.setSegmentBackgroundImage?.backgroundImgUrl;this.options={...this.options,...e},s?delete this.options.segmentBackgroundProcess:i&&delete this.options.setSegmentBackgroundImage,this.engineReady&&this.queenEngine?.setEngineParams(this.options)}async init(){await this.initQueen()}isSupported(){const e=!(typeof TransformStream>"u"||typeof MediaStreamTrackProcessor>"u"||typeof MediaStreamTrackGenerator>"u"),i=!(typeof OffscreenCanvas>"u"||typeof WebGL2RenderingContext>"u"),s=WebAssembly.validate(new Uint8Array([0,97,115,109,1,0,0,0,1,5,1,96,0,1,123,3,2,1,0,10,10,1,8,0,65,0,253,15,253,98,11]));return e&&i&&s}async initQueen(){this.canvas=document.createElement("canvas");const{licenseKey:e=""}=this.options,i=new u.QueenEngineWorker(u.kQueenVersion.Pro);return this._queenEngine=i,await new Promise(s=>{i.init(e,()=>{this.engineReady=!0,this.emit("ready"),i.setEngineParams(this.options),s(i)},function(){},this.canvas)}),i}shouldUpdate(e){return this.videoUpdated(e)||this.dirty}async process(e){if(!e.originVideoTrack){this.clear(e),e.updateVideoTrack();return}if(!this.queenEngine||!this.engineReady)return;this.dirty=!1;const i=this.queenEngine.renderMediaStreamTrack(e.originVideoTrack);i&&e.updateVideoTrack(i)}get queenEngine(){return this._queenEngine}clear(e){this.canvas=void 0,this.engineReady=!1,this._queenEngine=void 0,this.queenEngine?.engineDestory(),super.clear(e)}}return g});

package/dist/types/index.d.ts

@@ -124,6 +124,10 @@ export declare class AliRtcEngine extends default_2<AliRtcEngineEventListener> {
      * @ignore
      */
     static logName: string;
+    /**
+     * @ignore
+     */
+    static logError: boolean;
     /**
      * 检查浏览器是否支持 WebRTC
      * @param {string} direction
@@ -326,6 +330,7 @@ export declare class AliRtcEngine extends default_2<AliRtcEngineEventListener> {
      * @note 只可以在 {@link joinChannel} 之前设置
      */
     setAudioOnlyMode(audioOnly: boolean): void;
+    setAudioRedEnabled(audioRedEnabled: boolean): void;
     /**
      * 设定鉴权信息过期事件定时器
      * @param expireTimestamp 鉴权信息过期时间
@@ -338,7 +343,29 @@ export declare class AliRtcEngine extends default_2<AliRtcEngineEventListener> {
     private clearCheckAuthInfoTimer;
     private startDefaultDevicesCapture;
     /**
-     * @brief 加入频道
+     * @brief 加入频道(单参数)
+     * @details 该方法让用户加入频道，一个频道内可以加入多个用户进行互相通话。
+     * @details 一般在调用该方法前会根据场景先选择频道模式，通过调用 {@link setChannelProfile} 实现，默认频道模式为通信模式 {@link AliRtcSdkChannelProfile.AliRtcSdkCommunication}
+     * ``` javascript
+     * // 设置频道为互动模式
+     * engine.setChannelProfile(AliRtcSdkChannelProfile.AliRtcInteractivelive);
+     * // 设置角色为主播角色
+     * engine.setClientRole(AliRtcSdkClientRole.AliRtcSdkInteractive);
+     * ```
+     * @param {string} token    单参数认证信息，从App Server获取。
+     * @param {string} channelId    频道ID
+     * @param {string} userId    用户ID
+     * @param {string} userName    任意用于显示的用户名称。不是User ID
+     * @note
+     *    - 异步接口，方法执行成功则为成功入会
+     *    - 正常情况一个Appid对应一个App，只有同一个AppId的应用可进行互相童话,不同AppId和channelID不同都不能互通
+     *    - 当入会成功后，会触发远端用户收到 {@link AliRtcEngineEventListener.remoteUserOnLineNotify} 回调
+     *    - 如果已在会中想重新入会，需要先调用 {@link leaveChannel} 离会，且确保方法执行成功
+     *    - 用户加入频道后，默认订阅频道内所有其他用户的音视频流，默认推送音视频流到远端，因此将会产生计费，如果想要取消默认订阅可以 {@link joinChannel} 前调用 {@link setDefaultSubscribeAllRemoteAudioStreams} 和 {@link setDefaultSubscribeAllRemoteVideoStreams}
+     */
+    joinChannel(token: string, channelId: string, userId: string, userName: string): Promise<void>;
+    /**
+     * @brief 加入频道(多参数)
      * @details 该方法让用户加入频道，一个频道内可以加入多个用户进行互相通话。
      * @details 一般在调用该方法前会根据场景先选择频道模式，通过调用 {@link setChannelProfile} 实现，默认频道模式为通信模式 {@link AliRtcSdkChannelProfile.AliRtcSdkCommunication}
      * ``` javascript
@@ -635,6 +662,19 @@ export declare class AliRtcEngine extends default_2<AliRtcEngineEventListener> {
      * - >100：放大音量
      */
     setRecordingVolume(volume: number): void;
+    /**
+     * @brief 设置播放音量
+     * @param volume 播放音量，取值范围[0,100], 0：静音；100：原始音量
+     *   @note 注意此方法与 {@link setRemoteAudioVolume} 相互影响，以后调用的一个为准
+     */
+    setPlayoutVolume(volume: number): void;
+    /**
+     * @brief 设置播放音量
+     * @param userId 用户ID
+     * @param volume 播放音量，取值范围[0,100], 0：静音；100：原始音量
+     * @note 注意此方法与 {@link setPlayoutVolume} 相互影响，以后调用的一个为准
+     */
+    setRemoteAudioVolume(userId: string, volume: number): void;
     /**
      * 设置麦克风 profile
      *
@@ -2781,6 +2821,7 @@ declare class RemoteUser extends User {
     private screenSubState;
     streamInfo: RemoteStreamInfo;
     streamUrl: string;
+    private playoutVolume;
     constructor(config: RemoteUserConfig);
     isWantSubAudio(): boolean;
     setWantSubAudio(value: boolean): void;
@@ -2790,6 +2831,7 @@ declare class RemoteUser extends User {
     setWantSubScreen(value: boolean): void;
     setRemoteDefaultVideoStreamType(type: AliRtcVideoStreamType): void;
     setAudioMuted(value: boolean): void;
+    setPlayoutVolume(value: number): void;
     getAudioMuted(): boolean;
     get hasAudioTrack(): boolean;
     get hasVideoTrack(): boolean;
@@ -2935,6 +2977,7 @@ declare interface RemoteUserConfig {
     signalingManager: SignalingManager;
     localUserId: string;
     audioVolumeIndicationInterval: number;
+    playoutVolume: number;
 }
 
 declare interface RemoteUserMap {
@@ -3158,6 +3201,7 @@ declare class RtsManager extends default_2<RtsManagerEventListener> {
     static logName: string;
     private rts;
     private encodedInsertableStreams;
+    private audioRedEnabled;
     private localStreamManager;
     private connecting;
     private connected;
@@ -3168,6 +3212,7 @@ declare class RtsManager extends default_2<RtsManagerEventListener> {
     private _publishingTracks;
     constructor(localStreamManager: LocalStreamManager);
     setEncodedInsertableStreams(enable: boolean): void;
+    setAudioRedEnabled(enable: boolean): void;
     destroy(): void;
     private startConnect;
     private setConnected;
@@ -3470,6 +3515,7 @@ declare class UserManager extends default_2<UserManagerListener> {
     private wantSubScreen;
     private defaultStreamType;
     private audioMuted;
+    private playoutVolume;
     private audioVolumeIndicationInterval;
     private indicationTimer;
     constructor(config: UserManagerConfig);
@@ -3593,8 +3639,10 @@ declare class UserManager extends default_2<UserManagerListener> {
     private stopIndication;
     private startIndication;
     enableAudioVolumeIndication(interval: number): void;
+    setPlayoutVolume(volume: number): void;
     refreshAuthInfo(authInfo: AliRtcRefreshAuthInfo): void;
     setEnableMediaExtensionMsg(enable: boolean): void;
+    setAudioRedEnabled(enable: boolean): void;
 }
 
 declare interface UserManagerConfig {

package/package.json

@@ -1,16 +1,18 @@
 {
   "name": "aliyun-rtc-sdk",
-  "version": "6.11.5-beta.6",
+  "version": "6.11.6-beta.1",
+  "type": "module",
   "description": "rtc web sdk of aliyun",
   "main": "dist/aliyun-rtc-sdk.js",
   "types": "dist/types/index.d.ts",
   "dependencies": {
     "aliyun-queen-engine": "^6.3.3",
-    "aliyun-rts-sdk": "2.8.1-beta.1",
+    "aliyun-rts-sdk": "2.8.1-beta.5",
     "browser-log-reporter": "^1.1.5",
     "eventemitter3": "^5.0.1",
     "useragent-util": "^1.1.3"
   },
+  "homepage": "https://help.aliyun.com/zh/live/user-guide/quick-use",
   "files": [
     "dist/aliyun-rtc-sdk.js",
     "dist/types",