agora-rte-sdk 2.0.1-beta → 2.1.2

package/lib/configs/index.d.ts

@@ -1,5 +1,3 @@
-import { AREAS } from 'agora-rtc-sdk-ng';
-import { RtmStatusCode } from 'agora-rtm-sdk';
 import { AGRtcConfig } from '../core/rtc/adapter';
 declare global {
     interface Window {
@@ -48,20 +46,14 @@ export declare class AgoraRteEngineConfig {
     rtcConfigs: AGRtcConfig;
     logFilePath?: string;
     static logLevel: AgoraRteLogLevel;
-    static readonly platform: AgoraRteRuntimePlatform;
+    static get platform(): AgoraRteRuntimePlatform;
     userId: string;
     token: string;
     ignoreUrlRegionPrefix: boolean;
     language: RteLanguage;
     debugI18n: boolean;
     region: AgoraRegion;
-    private _rtcRegion?;
-    private _rtmRegion?;
     SCENE_JOIN_RETRY_ATTEMPTS: number;
     constructor(appId: string, opts?: AgoraRteOptions);
-    get rtcRegion(): AREAS;
-    get rtmRegion(): RtmStatusCode.AreaCode;
-    setRtcRegion(area: AgoraComponentRegion): void;
-    setRtmRegion(area: AgoraComponentRegion): void;
     static get version(): string;
 }

package/lib/core/decorator/lodash/index.d.ts

@@ -3,11 +3,21 @@ export declare const Lodash: {
     debounced: (wait?: number | undefined, options?: DebounceSettings | undefined) => (proto: any, propertyName: string, descriptor: PropertyDescriptor) => {
         configurable: boolean;
         enumerable: boolean;
-        get(): import("lodash").DebouncedFunc<any>;
+        get(this: {
+            __cacheMap: WeakMap<Object, any>;
+        }): any;
+        set(this: {
+            __cacheMap: WeakMap<Object, any>;
+        }, v: any): void;
     };
     throttled: (wait?: number | undefined, options?: ThrottleSettings | undefined) => (proto: any, propertyName: string, descriptor: PropertyDescriptor) => {
         configurable: boolean;
         enumerable: boolean;
-        get(): import("lodash").DebouncedFunc<any>;
+        get(this: {
+            __cacheMap: WeakMap<Object, any>;
+        }): any;
+        set(this: {
+            __cacheMap: WeakMap<Object, any>;
+        }, v: any): void;
     };
 };

package/lib/core/engine/index.d.ts

@@ -3,6 +3,7 @@ import { AgoraRteEngineConfig } from '../../configs';
 import { AgoraRteScene } from '../../scene';
 import { AgoraMediaControl } from '../media/control';
 import { AgoraRteService } from '../services/api';
+import { TagInfo } from '../services/oss';
 export declare class AgoraRteEngine extends AGEventEmitter {
     private _mediaControl;
     private _apiService;
@@ -21,5 +22,5 @@ export declare class AgoraRteEngine extends AGEventEmitter {
     createAgoraRteScene(sceneId: string): AgoraRteScene;
     getAgoraMediaControl(): AgoraMediaControl;
     getApiService(): AgoraRteService;
-    uploadSDKLogToAgoraService(roomId: string): Promise<void>;
+    uploadSDKLogToAgoraService(tagInfo: TagInfo): Promise<void>;
 }

package/lib/core/logger/index.d.ts

@@ -1,9 +1,5 @@
-export interface LogFileCollection {
-    electron?: File;
-    web?: File;
-    clean: () => void;
-}
 export declare class Logger {
+    private _lastObjectIndex;
     thread: any;
     constructor();
     static logger: Logger;
@@ -14,5 +10,9 @@ export declare class Logger {
     private static log;
     static originConsole: Console;
     static setupConsoleHijack(): void;
-    collectLogs(): Promise<LogFileCollection>;
+    collectConsoleLogs(): Promise<File>;
+    cleanupConsoleLogs(): Promise<void>;
+    private _addLocalFolderAsync;
+    private _readFile;
+    collectElectronLogs(logBasePath: string, logFolderPath: string): Promise<File>;
 }

package/lib/core/processor/channel-msg/handler.d.ts

@@ -10,6 +10,7 @@ export declare enum AgoraRteChannelMessageCmd {
     UserInfo = 21,
     UserProperty = 22,
     UserProperties = 23,
+    UserSubscribeInOut = 24,
     StreamInOut = 40,
     StreamsInOut = 41,
     MessageExtension = 99
@@ -67,6 +68,7 @@ export declare class AgoraRteChannelMessageHandle extends AGEventEmitter {
     private _handleChat;
     private _mergeProperties;
     private _handleRoomProperties;
+    private _handleUserSubscribe;
     private _handleUserInOut;
     private _handleUserInfo;
     private _handleUserProperty;

package/lib/core/rtc/adapter/base.d.ts

@@ -26,6 +26,7 @@ export declare abstract class RtcAudioDeviceManagerBase extends AGEventEmitter {
 }
 export declare abstract class RtcChannelAdapterBase extends AGEventEmitter {
     abstract join(token: string, streamUuid: string, connectionType: AGRtcConnectionType): Promise<void>;
+    abstract getSessionId(): string;
     abstract leave(connectionType?: AGRtcConnectionType): Promise<void>;
     abstract muteLocalVideo(mute: boolean, connectionType: AGRtcConnectionType): number;
     abstract muteLocalAudio(mute: boolean, connectionType: AGRtcConnectionType): number;

package/lib/core/rtc/adapter/electron/index.d.ts

@@ -26,6 +26,9 @@ export declare class RtcAdapterElectron extends RtcAdapterBase {
     cameraThread: AgoraRteElectronCameraThread;
     private _localVideoEnabled;
     private _localAudioEnabled;
+    static get remote(): any;
+    screenShareId?: string;
+    screenShareType?: AGScreenShareType;
     get configs(): {};
     get rtcEngine(): AgoraRtcEngine;
     constructor();
@@ -57,6 +60,10 @@ export declare class RtcAdapterElectron extends RtcAdapterBase {
     hasScreenSharePermission(): boolean;
     destroy(): number;
     static getRtcVersion(): string;
+    static get logBasePath(): any;
+    static get logFolderPath(): any;
+    static get logPath(): any;
+    private get _region();
     private _addEventListeners;
     private updateRole;
 }
@@ -67,6 +74,7 @@ export declare class RtcChannelAdapterElectron extends RtcChannelAdapterBase {
     private _networkStats;
     private get _channelProfile();
     constructor(channelName: string, configs: RtcAdapterElectronConfig, base: RtcAdapterBase);
+    getSessionId(): string;
     onConnectionStateChanged(cb: (state: RtcState, connectionType: AGRtcConnectionType) => void): number;
     leave(connectionType?: AGRtcConnectionType): Promise<void>;
     setChannelProfile(profile: ChannelProfile): number;
@@ -75,6 +83,7 @@ export declare class RtcChannelAdapterElectron extends RtcChannelAdapterBase {
     onAudioVolumeIndication(cb: (volumes: Map<string, number>) => void): number;
     muteRemoteVideo(streamUuid: string, mute: boolean): number;
     muteRemoteAudio(streamUuid: string, mute: boolean): number;
+    private _startScreenCapture;
     join(token: string, streamUuid: string, connectionType: AGRtcConnectionType): Promise<void>;
     muteLocalVideo(mute: boolean, connectionType: AGRtcConnectionType): number;
     muteLocalAudio(mute: boolean, connectionType: AGRtcConnectionType): number;

package/lib/core/rtc/adapter/electron/stats.d.ts

@@ -1,5 +1,5 @@
 import type { AgoraNetworkQuality } from 'agora-electron-sdk/types/Api/native_type';
-import { AGNetworkQuality, NetworkStats } from '../../type';
+import { NetworkStats } from '../../type';
 export declare class RtcNetworkQualityElectron {
     rtt?: number;
     downlinkNetworkQuality: AgoraNetworkQuality;
@@ -9,6 +9,7 @@ export declare class RtcNetworkQualityElectron {
     rxVideoPacketLoss: number;
     cpu: number;
     cpuTotal: number;
-    toAGQuality(electronQuality?: AgoraNetworkQuality): AGNetworkQuality;
+    private _downlinkNetworkQualityClacInstance;
+    private _uplinkNetworkQualityClacInstance;
     networkStats(): NetworkStats;
 }

package/lib/core/rtc/adapter/web/client.d.ts

@@ -21,11 +21,13 @@ export declare class AgoraRteWebClientBase extends AGEventEmitter {
     constructor(channelName: string, configs: RtcAdapterWebConfig, base: RtcAdapterBase, connectionType: AGRtcConnectionType);
     get ready(): boolean;
     protected setConnectionState(state: RtcState): void;
+    getClientSessionId(): any;
     join(appId: string, token: string, streamUuid: string): Promise<void>;
     leave(): Promise<void>;
     muteLocalVideo(mute: boolean): number;
     muteLocalAudio(mute: boolean): number;
     muteLocalScreenShare(mute: boolean): number;
+    private _rtcRegion;
     private _getRtcState;
     private _getEncryptionMode;
 }

package/lib/core/rtc/adapter/web/index.d.ts

@@ -62,6 +62,7 @@ export declare class RtcChannelAdapterWeb extends RtcChannelAdapterBase {
     readonly sub: AgoraRteWebClientSub;
     channelName: string;
     constructor(channelName: string, configs: RtcAdapterWebConfig, base: RtcAdapterBase);
+    getSessionId(): any;
     private client;
     join(token: string, streamUuid: string, connectionType: AGRtcConnectionType): Promise<void>;
     leave(connectionType?: AGRtcConnectionType): Promise<void>;

package/lib/core/rtc/adapter/web/stats.d.ts

@@ -1,4 +1,4 @@
-import { AGNetworkQuality, NetworkStats } from '../../type';
+import { NetworkStats } from '../../type';
 export declare class RtcNetworkQualityWeb {
     rtt?: number;
     downlinkNetworkQuality: number;
@@ -6,6 +6,7 @@ export declare class RtcNetworkQualityWeb {
     end2EndDelay: number;
     txVideoPacketLoss: number;
     rxVideoPacketLoss: number;
-    toAGQuality(webquality?: number): AGNetworkQuality;
+    private _downlinkNetworkQualityClacInstance;
+    private _uplinkNetworkQualityClacInstance;
     networkStats(): NetworkStats;
 }

package/lib/core/rtc/channel.d.ts

@@ -10,6 +10,7 @@ export declare class AGRtcChannel {
     private _adapter;
     constructor(channelName: string, adapter: RtcChannelAdapterBase);
     private connectionType;
+    getRtcSid(): string;
     join(token: string, streamUuid: string, connectionType?: AGRtcConnectionType): Promise<void>;
     leave(connectionType?: AGRtcConnectionType): Promise<void>;
     setClientRole(role: ClientRole): number;

package/lib/core/rtc/type.d.ts

@@ -3,7 +3,8 @@ export declare enum AGNetworkQuality {
     bad = 1,
     poor = 2,
     good = 3,
-    great = 4
+    great = 4,
+    down = 5
 }
 export declare enum AGRteTrackErrorReason {
     Unknown = 0,
@@ -11,15 +12,28 @@ export declare enum AGRteTrackErrorReason {
 }
 export interface NetworkStats {
     packetLoss?: number;
-    networkQuality?: AGNetworkQuality;
+    downlinkNetworkQuality?: AGNetworkQuality;
+    uplinkNetworkQuality?: AGNetworkQuality;
     cpu?: number;
     cpuTotal?: number;
     delay?: number;
 }
 export declare enum AgoraRteMediaSourceState {
+    /**
+     * 设备停止采集
+     */
     stopped = 0,
+    /**
+     * 设备开启中
+     */
     starting = 2,
+    /**
+     * 设备已开启
+     */
     started = 1,
+    /**
+     * 设备错误
+     */
     error = -1
 }
 export declare enum RtcState {

package/lib/core/rtm/index.d.ts

@@ -26,6 +26,7 @@ export declare class AGRtmManager extends EventEmitter {
         track: boolean;
         debug: boolean;
     };
+    private get _region();
     login(token: string, uid: string, configs: AGRtmManagerInitConfig): Promise<void>;
     createObserverChannel(channelName: string): [RtmChannel, EventEmitter];
     join(channel: RtmChannel, bus: EventEmitter, channelName: string): Promise<void>;

package/lib/core/services/log.d.ts

@@ -1,7 +1,8 @@
 import { ApiBase } from './base';
+import { TagInfo } from './oss';
 export declare class AgoraLogService extends ApiBase {
-    uploadZipLogFile(roomId: string, file: any): Promise<void>;
-    uploadLogFile(roomId: string, file: any): Promise<void>;
-    uploadToOss(roomId: string, file: File, ext: string): Promise<void>;
-    uploadElectronLog(roomId: any): Promise<void>;
+    uploadZipLogFile(tagInfo: TagInfo, file: any): Promise<void>;
+    uploadLogFile(tagInfo: TagInfo, file: any): Promise<void>;
+    uploadToOss(tagInfo: TagInfo, file: File, ext: string): Promise<void>;
+    uploadElectronLog(tagInfo: TagInfo): Promise<void>;
 }

package/lib/core/services/oss.d.ts

@@ -1,7 +1,15 @@
+export declare type TagInfo = {
+    roomUuid: string;
+    roomName: string;
+    roomType: number;
+    userUuid: string;
+    userName: string;
+    role: number;
+};
 export declare class OSSFileUploader {
     private _appId;
-    private _roomId;
+    private _tagInfo;
     private _adapter;
-    constructor(_appId: string, _roomId: string);
+    constructor(_appId: string, _tagInfo: TagInfo);
     upload(file: File, ext: string): Promise<void>;
 }

package/lib/core/utils/error.d.ts

@@ -35,6 +35,9 @@ export declare enum AGRteErrorCode {
     RTE_ERR_SCENE_ALREADY_JOINED = "100012",
     RTE_ERR_ENGINE_NOT_READY = "100013",
     RTE_ERR_CONFIG_NOT_READY = "100014",
+    RTE_ERR_RESTFUL_NETWORK_ERR = "100015",
+    RTE_ERR_RESTFUL_NETWORK_TIMEOUT_ERR = "100016",
+    RTE_ERR_LOCAL_USER_NOT_EXIST = "100017",
     RTM_ERR_LOGGED_IN_ALREADY = "200000",
     RTM_ERR_JOIN_FAILED = "200001",
     RTM_ERR_LEAVE_FAILED = "200002",

package/lib/core/utils/networkutils.d.ts

@@ -0,0 +1,9 @@
+import { AGNetworkQuality } from '../..';
+export declare class QualityCalc {
+    private quality;
+    private qualities;
+    static MAX_QUALITY_NUMBER: number;
+    private _updateQualities;
+    private _resetQualities;
+    toAGQuality(webquality?: number): AGNetworkQuality;
+}

package/lib/index.d.ts

@@ -2,6 +2,7 @@ export { AgoraRteEngine } from './core/engine';
 export { AgoraRteScene } from './scene';
 export type { AgoraRteSceneJoinRTCOptions } from './scene';
 export { AgoraRteEngineConfig, AgoraRteLogLevel, AgoraRteRuntimePlatform, RteLanguage, AgoraRegion, } from './configs';
+export type { AgoraRteOptions } from './configs';
 export type { AgoraComponentRegion } from './configs';
 export type { AgoraRteServiceConfig } from './configs';
 export { AgoraRtcVideoCanvas, AgoraRtcLocalVideoCanvas } from './core/rtc/canvas';
@@ -11,7 +12,7 @@ export type { AgoraRteOperator } from './core/processor/channel-msg/struct';
 export { AGRtcConnectionType } from './core/rtc/channel';
 export { ApiBase } from './core/services/base';
 export { Logger } from './core/logger';
-export { AbstractErrorCenter, AGError, AGErrorWrapper } from './core/utils/error';
+export { AbstractErrorCenter, AGError, AGErrorWrapper, AGRteErrorCode } from './core/utils/error';
 export { retryAttempt } from './core/utils/utils';
 export { Log, Lodash, bound } from './core/decorator';
 export type { Injectable } from './core/decorator';