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

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
@@ -339,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
@@ -636,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
      *
@@ -2782,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;
@@ -2791,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;
@@ -2936,6 +2977,7 @@ declare interface RemoteUserConfig {
     signalingManager: SignalingManager;
     localUserId: string;
     audioVolumeIndicationInterval: number;
+    playoutVolume: number;
 }
 
 declare interface RemoteUserMap {
@@ -3473,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);
@@ -3596,6 +3639,7 @@ 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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aliyun-rtc-sdk",
-  "version": "6.11.5",
+  "version": "6.11.6-beta.1",
   "type": "module",
   "description": "rtc web sdk of aliyun",
   "main": "dist/aliyun-rtc-sdk.js",
@@ -12,6 +12,7 @@
     "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",