agora-rte-sdk 2.0.0-beta → 2.0.1-beta

package/lib/core/index.d.ts

@@ -0,0 +1 @@
+export * as RTM from './rtm';

package/lib/core/logger/edu-sdk-logger.d.ts

@@ -0,0 +1,15 @@
+import Dexie, { Table } from 'dexie';
+declare type Timestamp = number;
+declare type LogSchema = {
+    content: string;
+    created_at: Timestamp;
+    timestamp: string;
+};
+export declare class EduSDKLogger extends Dexie {
+    logs: Table<LogSchema, number>;
+    constructor();
+    openDatabase(): void;
+    readAndDeleteBy(time: number): Promise<string[][]>;
+    resetByKeys(time: number): Promise<string[][]>;
+}
+export {};

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

@@ -0,0 +1,4 @@
+export declare enum EduLogLevel {
+    Debug = "Debug",
+    None = "None"
+}

package/lib/core/media-service/electron/index.d.ts

@@ -0,0 +1,239 @@
+/// <reference types="node" />
+import { EventEmitter } from 'events';
+import { StartScreenShareParams, ElectronWrapperInitOption, IElectronRTCWrapper, PrepareScreenShareParams } from '../interfaces/index';
+import IAgoraRtcEngine from 'agora-electron-sdk';
+export declare class CEFVideoEncoderConfiguration {
+    /**
+     * The video frame dimensions (px) used to specify the video quality and measured by the total number of pixels along a
+     * frame's width and height: [VideoDimensions]{@link AgoraRtcEngine.VideoDimensions}. The default value is 640 x 360.
+     */
+    dimensions: CEFVideoDimensions;
+    /**
+     * The frame rate of the video: [FRAME_RATE]{@link AgoraRtcEngine.FRAME_RATE}. The default value is 15.
+     *
+     * Note that we do not recommend setting this to a value greater than 30.
+     */
+    frameRate: number;
+    /**
+     * The minimum frame rate of the video. The default value is -1.
+     */
+    minFrameRate: number;
+    /**
+     The video encoding bitrate (Kbps).
+  
+     Choose one of the following options:
+  
+     - [STANDARD_BITRATE]{@link AgoraRtcEngine.STANDARD_BITRATE}: (Recommended) The standard bitrate.
+     - The `COMMUNICATION` profile: the encoding bitrate equals the base bitrate.
+     - The `LIVE_BROADCASTING` profile: the encoding bitrate is twice the base bitrate.
+     - [COMPATIBLE_BITRATE]{@link AgoraRtcEngine.COMPATIBLE_BITRATE}: The compatible bitrate: the bitrate stays the same regardless of the
+     profile.
+  
+     The `COMMUNICATION` profile prioritizes smoothness, while the `LIVE_BROADCASTING` profile prioritizes video quality (requiring
+     a higher bitrate). We recommend setting the bitrate mode as `STANDARD_BITRATE` to address this difference.
+  
+     The following table lists the recommended video encoder configurations, where the base bitrate applies to the `COMMUNICATION`
+     profile. Set your bitrate based on this table. If you set a bitrate beyond the proper range, the SDK automatically sets it
+     to within the range.
+  
+     @note In the following table, **Base Bitrate** applies to the `COMMUNICATION` profile, and **Live Bitrate** applies to the
+     `LIVE_BROADCASTING` profile.
+  
+     | Resolution             | Frame Rate (fps) | Base Bitrate (Kbps)                    | Live Bitrate (Kbps)                    |
+     |------------------------|------------------|----------------------------------------|----------------------------------------|
+     | 160 * 120              | 15               | 65                                     | 130                                    |
+     | 120 * 120              | 15               | 50                                     | 100                                    |
+     | 320 * 180              | 15               | 140                                    | 280                                    |
+     | 180 * 180              | 15               | 100                                    | 200                                    |
+     | 240 * 180              | 15               | 120                                    | 240                                    |
+     | 320 * 240              | 15               | 200                                    | 400                                    |
+     | 240 * 240              | 15               | 140                                    | 280                                    |
+     | 424 * 240              | 15               | 220                                    | 440                                    |
+     | 640 * 360              | 15               | 400                                    | 800                                    |
+     | 360 * 360              | 15               | 260                                    | 520                                    |
+     | 640 * 360              | 30               | 600                                    | 1200                                   |
+     | 360 * 360              | 30               | 400                                    | 800                                    |
+     | 480 * 360              | 15               | 320                                    | 640                                    |
+     | 480 * 360              | 30               | 490                                    | 980                                    |
+     | 640 * 480              | 15               | 500                                    | 1000                                   |
+     | 480 * 480              | 15               | 400                                    | 800                                    |
+     | 640 * 480              | 30               | 750                                    | 1500                                   |
+     | 480 * 480              | 30               | 600                                    | 1200                                   |
+     | 848 * 480              | 15               | 610                                    | 1220                                   |
+     | 848 * 480              | 30               | 930                                    | 1860                                   |
+     | 640 * 480              | 10               | 400                                    | 800                                    |
+     | 1280 * 720             | 15               | 1130                                   | 2260                                   |
+     | 1280 * 720             | 30               | 1710                                   | 3420                                   |
+     | 960 * 720              | 15               | 910                                    | 1820                                   |
+     | 960 * 720              | 30               | 1380                                   | 2760                                   |
+     | 1920 * 1080            | 15               | 2080                                   | 4160                                   |
+     | 1920 * 1080            | 30               | 3150                                   | 6300                                   |
+     | 1920 * 1080            | 60               | 4780                                   | 6500                                   |
+     | 2560 * 1440            | 30               | 4850                                   | 6500                                   |
+     | 2560 * 1440            | 60               | 6500                                   | 6500                                   |
+     | 3840 * 2160            | 30               | 6500                                   | 6500                                   |
+     | 3840 * 2160            | 60               | 6500                                   | 6500                                   |
+     */
+    bitrate: number;
+    /**
+     * The minimum encoding bitrate (Kbps).
+     *
+     * The SDK automatically adjusts the encoding bitrate to adapt to the network conditions. Using a value greater than the default
+     * value forces the video encoder to output high-quality images but may cause more packet loss and hence sacrifice the smoothness
+     * of the video transmission. That said, unless you have special requirements for image quality, Agora does not recommend
+     * changing this value.
+     *
+     * @note This parameter applies only to the `LIVE_BROADCASTING` profile.
+     */
+    minBitrate: number;
+    /**
+     * The video orientation mode of the video: [ORIENTATION_MODE]{@link AgoraRtcEngine.ORIENTATION_MODE}.
+     */
+    orientationMode: number;
+    /**
+     * The video encoding degradation preference under limited bandwidth:
+     * [DEGRADATION_PREFERENCE]{@link AgoraRtcEngine.DEGRADATION_PREFERENCE}.
+     */
+    degradationPreference: number;
+    /**
+     * Sets the mirror mode of the published local video stream. It only affects the video that the remote user sees. See
+     * [VIDEO_MIRROR_MODE_TYPE]{@link AgoraRtcEngine.VIDEO_MIRROR_MODE_TYPE}.
+     *
+     * @note The SDK disables the mirror mode by default.
+     */
+    mirrorMode: number;
+    constructor(dimensions?: CEFVideoDimensions, frameRate?: any, minFrameRate?: number, bitrate?: number, minBitrate?: number, orientationMode?: number, degradationPreference?: number, mirrorMode?: number);
+}
+export declare class CEFVideoDimensions {
+    /**
+     * Width (pixels) of the video.
+     */
+    width: number;
+    /**
+     * Height (pixels) of the video.
+     */
+    height: number;
+    constructor(width?: number, height?: number);
+}
+export declare function CustomBtoa(input: any): string;
+export declare class AgoraElectronRTCWrapper extends EventEmitter implements IElectronRTCWrapper {
+    client: IAgoraRtcEngine;
+    logPath: string;
+    videoSourceLogPath: string;
+    role: number;
+    joined: boolean;
+    videoMuted: boolean;
+    audioMuted: boolean;
+    localUid?: number;
+    channel?: number;
+    appId: string;
+    subscribedList: number[];
+    superChannel: any;
+    userJoinedEvent: any;
+    userOfflineEvent: any;
+    cameraList: any[];
+    microphoneList: any[];
+    _subClient: Record<string, any>;
+    _localAudioStats: {
+        audioLossRate: number;
+    };
+    _localVideoStats: {
+        videoLossRate: number;
+    };
+    _remoteVideoStats: Record<number, any>;
+    _remoteAudioStats: Record<number, any>;
+    _cefClient: any;
+    get deviceList(): any[];
+    cpuUsage: number;
+    gatewayRtt: number;
+    lastMileDelay: number;
+    published: boolean;
+    nativeAreaCode?: number;
+    enableEncryption?: boolean;
+    configEncryption?: any;
+    constructor(options: ElectronWrapperInitOption);
+    muteRemoteVideoByClient(client: any, uid: string, val: boolean): Promise<any>;
+    muteRemoteAudioByClient(client: any, uid: string, val: boolean): Promise<any>;
+    setAddonLogPath(payload: {
+        logPath: string;
+        videoSourceLogPath: string;
+    }): void;
+    enableLogPersist(): void;
+    changePlaybackVolume(volume: number): void;
+    muteRemoteVideo(uid: any, val: boolean): Promise<any>;
+    muteRemoteAudio(uid: any, val: boolean): Promise<any>;
+    releaseAllClient(): void;
+    releaseSubChannels(): void;
+    resetState(): void;
+    reset(): void;
+    private fire;
+    init(): void;
+    joinSubChannel(option: any): Promise<any>;
+    prepare(): IAgoraRtcEngine;
+    join(option: any): Promise<any>;
+    leaveSubChannel(channelName: string): Promise<any>;
+    leave(): Promise<any>;
+    release(): void;
+    getMicrophones(): Promise<any[]>;
+    getCameras(): Promise<any[]>;
+    changeResolution(config: any): Promise<any>;
+    prepareScreenShare(params?: PrepareScreenShareParams): Promise<any>;
+    startScreenShare(options: StartScreenShareParams): Promise<any>;
+    stopScreenShare(): Promise<any>;
+    publish(): Promise<any>;
+    unpublish(): Promise<any>;
+    muteLocalAudioStream(v: boolean): Promise<void>;
+    muteLocalVideoStream(v: boolean): Promise<void>;
+    /**
+     * 开启音频采集
+     * @param v
+     */
+    enableLocalVideo(v: boolean): Promise<number>;
+    /**
+     * 设置摄像头设备
+     * @param deviceId
+     * @returns
+     */
+    enableLocalAudio(v: boolean): Promise<number>;
+    /**
+     * 关闭音频发流
+     * @param v
+     * @returns
+     */
+    muteLocalAudio(v: boolean, deviceId?: string): Promise<number>;
+    /**
+     * 关闭视频发流
+     * @param v
+     * @returns
+     */
+    muteLocalVideo(v: boolean, deviceId?: string): Promise<number>;
+    disableLocalVideo(): void;
+    disableLocalAudio(): void;
+    /**
+     * 设置摄像头设备
+     * @param deviceId
+     * @returns
+     */
+    setCameraDevice(deviceId: string): Promise<number>;
+    /**
+     * 设置麦克风设备
+     * @param deviceId
+     * @returns
+     */
+    setMicrophoneDevice(deviceId: string): Promise<number>;
+    enableMediaEncryptionConfig(enabled: boolean, config: any): number;
+    /**
+     * 设置美颜效果
+     * lighteningLevel 美白
+     * rednessLevel 红润
+     * smoothnessLevel 磨皮
+     * @param param0
+     * @returns
+     */
+    setBeautyEffectOptions({ lighteningLevel, rednessLevel, smoothnessLevel, isBeauty, }: {
+        lighteningLevel: number;
+        rednessLevel: number;
+        smoothnessLevel: number;
+        isBeauty?: boolean;
+    }): number;
+}

package/lib/core/media-service/index.d.ts

@@ -0,0 +1,75 @@
+/// <reference types="node" />
+import { LocalUserRenderer, VideoRenderState, RemoteUserRenderer } from './renderer/index';
+import { EventEmitter } from 'events';
+import { IMediaService, RTCWrapperProvider, RTCProviderInitParams, PrepareScreenShareParams, StartScreenShareParams, JoinOption, MediaEncryptionConfig } from './interfaces';
+import { AgoraElectronRTCWrapper } from './electron';
+import { AgoraWebRtcWrapper } from './web';
+import { ILocalTrack } from 'agora-rtc-sdk-ng';
+export declare class MediaService extends EventEmitter implements IMediaService {
+    sdkWrapper: RTCWrapperProvider;
+    cameraTestRenderer?: LocalUserRenderer;
+    cameraRenderer?: LocalUserRenderer;
+    microphoneTrack?: ILocalTrack;
+    screenRenderer?: LocalUserRenderer;
+    remoteUsersRenderer: RemoteUserRenderer[];
+    screenShareIds: any[];
+    readonly _id: string;
+    private eduManager;
+    encoderConfig: any;
+    rtcProvider: RTCProviderInitParams;
+    constructor(rtcProvider: RTCProviderInitParams);
+    setRtcRole(roleType: string): Promise<void>;
+    muteLocalVideo(val: boolean, deviceId?: string): Promise<any>;
+    muteLocalAudio(val: boolean, deviceId?: string): Promise<any>;
+    disableLocalAudio(): void;
+    disableLocalVideo(): void;
+    enableLocalVideo(val: boolean): Promise<any>;
+    enableLocalAudio(val: boolean): Promise<any>;
+    setCameraDevice(deviceId: string): Promise<any>;
+    setMicrophoneDevice(deviceId: string): Promise<any>;
+    private fire;
+    fireLocalVideoStateUpdated(state: VideoRenderState): void;
+    fireRemoteVideoStateUpdated(state: VideoRenderState, uid: string): void;
+    get isWeb(): boolean;
+    get isElectron(): boolean;
+    get sessionId(): string;
+    private getNativeCurrentVideoDevice;
+    private getNativeVideoDevices;
+    private getNativeCurrentAudioDevice;
+    private getNativeAudioDevices;
+    getTestCameraLabel(): string;
+    getTestMicrophoneLabel(): string;
+    getCameraLabel(): string;
+    private getNativeSpeakerLabel;
+    getSpeakerLabel(): string;
+    getMicrophoneLabel(): string;
+    changePlaybackVolume(volume: number): void;
+    muteRemoteVideo(uid: any, val: boolean): Promise<any>;
+    muteRemoteAudio(uid: any, val: boolean): Promise<any>;
+    get web(): AgoraWebRtcWrapper;
+    get electron(): AgoraElectronRTCWrapper;
+    init(): void;
+    release(): void;
+    prepare(): import("agora-electron-sdk/types/Api").default | import("agora-rtc-sdk-ng").IAgoraRTCClient;
+    join(option: JoinOption): Promise<any>;
+    _join(option: JoinOption): Promise<any>;
+    private destroyAllRenderers;
+    leave(): Promise<any>;
+    joinSubChannel(option: JoinOption): Promise<any>;
+    leaveSubChannel(channelName: string): Promise<any>;
+    getCameras(): Promise<any>;
+    getMicrophones(): Promise<any>;
+    prepareScreenShare(params?: PrepareScreenShareParams): Promise<any>;
+    startScreenShare(option: StartScreenShareParams): Promise<any>;
+    stopScreenShare(): Promise<any>;
+    changeResolution(config: any): Promise<void>;
+    getPlaybackVolume(): number;
+    enableMediaEncryptionConfig(enabled: boolean, config: MediaEncryptionConfig): number;
+    reset(): void;
+    setBeautyEffectOptions({ lighteningLevel, rednessLevel, smoothnessLevel, isBeauty, }: {
+        lighteningLevel: number;
+        rednessLevel: number;
+        smoothnessLevel: number;
+        isBeauty?: boolean;
+    }): number | undefined;
+}

package/lib/core/media-service/interfaces/index.d.ts

@@ -0,0 +1,318 @@
+import { IAgoraRTC, IAgoraRTCClient, ICameraVideoTrack, ILocalAudioTrack, ILocalTrack, ILocalVideoTrack, IMicrophoneAudioTrack } from 'agora-rtc-sdk-ng';
+import { AgoraElectronRTCWrapper } from '../electron';
+import IAgoraRtcEngine from 'agora-electron-sdk';
+import { LocalUserRenderer, RemoteUserRenderer } from '../renderer';
+import { AgoraWebRtcWrapper } from '../web';
+import { EduRoleTypeEnum, EduRoomTypeEnum, EduVideoEncoderConfiguration } from '../../../interfaces';
+export declare function event_device_changed(evt: any): void;
+export declare type Option = any;
+export declare interface WebRtcWrapperInitOption {
+    appId: string;
+    uploadLog: boolean;
+    agoraWebSdk: IAgoraRTC;
+    webConfig: {
+        mode: string;
+        codec: string;
+        role: string;
+        clientRoleOptions: ClientRoleOptions;
+    };
+}
+export declare type RTCWrapperProvider = AgoraWebRtcWrapper | AgoraElectronRTCWrapper;
+/**
+ * IElectronRTCWrapper
+ * 主要集成agora-electron-sdk，为media-service提供web端内部实现
+ */
+export declare interface IElectronRTCWrapper extends IAgoraRTCModule {
+    client: IAgoraRtcEngine;
+}
+/**
+ * ElectronWrapperInitOption
+ * 主要用于初始化构造electron rtc wrapper
+ */
+export declare interface ElectronWrapperInitOption {
+    logPath: string;
+    videoSourceLogPath: string;
+    AgoraRtcEngine: any;
+    appId: string;
+    cefClient: any;
+    area: AREA_CODE;
+    cameraEncoderConfiguration?: EduVideoEncoderConfiguration;
+}
+export declare const convertNativeAreaCode: (codeName: string) => number;
+/**
+ * IWebRTCWrapper
+ * 主要集成web ng sdk，为media-service提供web端内部实现
+ */
+export declare interface IWebRTCWrapper extends IAgoraRTCModule {
+    cameraTrack?: ICameraVideoTrack;
+    audioTrack?: IMicrophoneAudioTrack;
+    screenVideoTrack?: ILocalVideoTrack;
+    screenAudioTrack?: ILocalAudioTrack;
+    screenClient?: IAgoraRTCClient;
+    client: IAgoraRTCClient;
+}
+export declare type AREA_CODE = 'CHINA' | 'ASIA' | 'NORTH_AMERICA' | 'EUROPE' | 'JAPAN' | 'INDIA' | 'OVERSEA' | 'GLOBAL' | 'SOUTH_AMERICA' | 'AFRICA' | string;
+/**
+ * WebRtcWrapperInitOption
+ * 主要用于初始化构造agora-web-sdk-ng rtc wrapper
+ */
+export declare interface WebRtcWrapperInitOption {
+    appId: string;
+    uploadLog: boolean;
+    agoraWebSdk: IAgoraRTC;
+    area: AREA_CODE;
+    cameraEncoderConfiguration: EduVideoEncoderConfiguration;
+    webConfig: {
+        mode: string;
+        codec: string;
+        role: string;
+        clientRoleOptions: ClientRoleOptions;
+    };
+}
+export declare type ClientRoleOptions = {
+    level: 1 | 2;
+};
+export declare enum ScreenShareType {
+    Window = 0,
+    Screen = 1
+}
+export declare interface PrepareScreenShareParams {
+    dom?: HTMLElement;
+    type?: ScreenShareType;
+    shareAudio?: 'enable' | 'auto' | 'disable';
+    encoderConfig?: any;
+}
+export declare interface CameraOption {
+    deviceId: string;
+    encoderConfig?: {
+        width: number;
+        height: number;
+        frameRate: number;
+    };
+}
+export declare interface MicrophoneOption {
+    deviceId: string;
+}
+export declare enum MediaEncryptionMode {
+    /** 1: (Default) 128-bit AES encryption, XTS mode.
+     */
+    AES_128_XTS = 1,
+    /** 2: 128-bit AES encryption, ECB mode.
+     */
+    AES_128_ECB = 2,
+    /** 3: 256-bit AES encryption, XTS mode.
+     */
+    AES_256_XTS = 3,
+    /** 4: Reserved property.
+     */
+    SM4_128_ECB = 4,
+    /** 5: 128-bit AES encryption, GCM mode.
+     *
+     * @since v3.3.1
+     */
+    AES_128_GCM = 5,
+    /** 6: 256-bit AES encryption, GCM mode.
+     *
+     * @since v3.3.1
+     */
+    AES_256_GCM = 6
+}
+export declare interface MediaEncryptionConfig {
+    mode: MediaEncryptionMode;
+    key: string;
+}
+/**
+ *
+ */
+export declare interface IAgoraRTCModule {
+    init(): void;
+    release(): void;
+    prepare(): any;
+    join(option: Option): Promise<any>;
+    leave(): Promise<any>;
+    enableLocalVideo(v: boolean): Promise<any>;
+    enableLocalAudio(v: boolean): Promise<any>;
+    disableLocalAudio(): void;
+    disableLocalVideo(): void;
+    setCameraDevice(deviceId: string): Promise<any>;
+    setMicrophoneDevice(deviceId: string): Promise<any>;
+    muteLocalVideo(val: boolean, deviceId?: string): Promise<any>;
+    muteLocalAudio(val: boolean, deviceId?: string): Promise<any>;
+    muteRemoteVideo(uid: any, val: boolean): Promise<any>;
+    muteRemoteAudio(uid: any, val: boolean): Promise<any>;
+    getCameras(): Promise<any[]>;
+    getMicrophones(): Promise<any[]>;
+    prepareScreenShare(params?: PrepareScreenShareParams): Promise<any>;
+    startScreenShare(params: StartScreenShareParams): Promise<any>;
+    stopScreenShare(): Promise<any>;
+    changePlaybackVolume(volume: number): void;
+    enableMediaEncryptionConfig(enabled: boolean, config: MediaEncryptionConfig): void;
+    on(event: 'error', listener: (err: any) => void): void;
+    on(event: 'audio-device-changed', listener: typeof event_device_changed): void;
+    on(event: 'video-device-changed', listener: typeof event_device_changed): void;
+    on(event: 'user-joined', listener: (evt: any) => void): void;
+    on(event: 'user-left', listener: (evt: any) => void): void;
+    on(event: 'user-info-updated', listener: (evt: any) => void): void;
+    on(event: 'token-privilege-will-expire', listener: (evt: any) => void): void;
+    on(event: 'token-privilege-did-expire', listener: (evt: any) => void): void;
+    on(event: 'connection-state-change', listener: (state: any, reason: any) => void): void;
+    on(event: 'stream-fallback', listener: (state: any, reason: any) => void): void;
+    on(event: 'network-quality', listener: (stats: any) => void): void;
+    on(event: 'volume-indicator', listener: (result: any[]) => void): void;
+}
+export declare interface RTCProviderInitParams {
+    eduManager?: any;
+    cefClient: any;
+    agoraSdk: any;
+    platform: string;
+    codec: string;
+    appId: string;
+    rtcArea: AREA_CODE;
+    rtmArea: AREA_CODE;
+    cameraEncoderConfiguration: EduVideoEncoderConfiguration;
+    scenarioType?: EduRoomTypeEnum;
+    userRole?: EduRoleTypeEnum;
+    electronLogPath?: {
+        logPath: string;
+        videoSourceLogPath: string;
+    };
+    latencyLevel?: 1 | 2;
+}
+export declare interface StartScreenShareParams {
+    shareId?: any;
+    config?: {
+        profile: number;
+        rect: any;
+        param: any;
+    };
+    type?: ScreenShareType;
+    params: {
+        uid: any;
+        channel: string;
+        token: string;
+        joinInfo?: string;
+    };
+    encoderConfig?: any;
+}
+export declare type JoinOption = {
+    channel: string;
+    token?: string | null;
+    uid: number;
+    info?: string;
+    data: any;
+};
+/**
+ * IMediaService
+ * 媒体提供层入口
+ */
+export declare interface IMediaService extends IAgoraRTCModule {
+    /**
+     * sdk包装器用于提供agora-rtc-sdk-ng/agora-electron-sdk实例能力
+     */
+    sdkWrapper: RTCWrapperProvider;
+    web: AgoraWebRtcWrapper;
+    electron: AgoraElectronRTCWrapper;
+    /**
+     * 本地预览摄像头渲染器，用于绘制本地摄像头捕捉到的画面
+     */
+    cameraTestRenderer?: LocalUserRenderer;
+    /**
+     * 本地摄像头渲染器，当加入频道时会自动推入频道里。
+     */
+    cameraRenderer?: LocalUserRenderer;
+    /**
+     * 本地麦克风音频轨道
+     */
+    microphoneTrack?: ILocalTrack;
+    /**
+     * 屏幕共享渲染器，当加入频道时会自动推入频道内。
+     */
+    screenRenderer?: LocalUserRenderer;
+    /**
+     * 远端用户渲染器，在加入频道以后通过 user-published/user-unpublished 获取
+     */
+    remoteUsersRenderer: RemoteUserRenderer[];
+    /**
+     * 获取测试摄像头标签
+     */
+    getTestCameraLabel(): string;
+    /**
+     * 获取测试麦克风标签
+     */
+    getTestMicrophoneLabel(): string;
+    /**
+     * 获取摄像头标签
+     */
+    getCameraLabel(): string;
+    /**
+     * 获取扬声器标签
+     */
+    getSpeakerLabel(): string;
+    /**
+     * 获取麦克风标签
+     */
+    getMicrophoneLabel(): string;
+    /**
+     * 修改扬声器设备音量
+     */
+    changePlaybackVolume(volume: number): void;
+    /**
+     * 初始化
+     */
+    init(): void;
+    /**
+     * 释放媒体
+     */
+    release(): void;
+    /**
+     * 加入频道
+     * option: JoinOption
+     */
+    join(option: JoinOption): Promise<any>;
+    /**
+     * 离开频道
+     */
+    leave(): Promise<any>;
+    /**
+     * 加入子频道
+     * option: JoinOption
+     */
+    joinSubChannel(option: JoinOption): Promise<any>;
+    /**
+     * 离开子频道
+     * option: SubChannel
+     */
+    leaveSubChannel(channelName: string): Promise<any>;
+    /**
+     * 获取摄像头
+     */
+    getCameras(): Promise<any>;
+    /**
+     * 获取麦克风
+     */
+    getMicrophones(): Promise<any>;
+    /**
+     * 准备屏幕共享
+     */
+    prepareScreenShare(params: PrepareScreenShareParams): Promise<any>;
+    /**
+     * 开启屏幕共享
+     */
+    startScreenShare(option: StartScreenShareParams): Promise<any>;
+    /**
+     * 停止屏幕共享
+     */
+    stopScreenShare(): Promise<any>;
+    /**
+     * 获取扬声器音量，仅适用于electron
+     */
+    getPlaybackVolume(): number;
+    /**
+     * 重置
+     */
+    reset(): void;
+}
+export declare type MediaVolume = {
+    uid: number;
+    volume: number;
+};