` tag.
* @asMemberOf IRemoteVideoTrack
* @event
*/
declare function event_video_element_visible_status_2(data?: CheckVideoVisibleResult): void;
/**
* Occurs when the video state changes.
*
* @event
* @asMemberOf IRemoteTrack
*/
declare function event_video_state_changed(videoState: VideoState): void;
/**
* Reports all the speaking local and remote users and their volumes.
*
* It is disabled by default. You can enable this callback by calling {@link enableAudioVolumeIndicator}.
* If enabled, it reports the users' volumes every two seconds regardless of whether there are users speaking.
*
* The volume is an integer ranging from 0 to 100. Usually a user with volume above 60 is a speaking user.
*
* ``` javascript
* client.on("volume-indicator", function(result){
* result.forEach(function(volume, index){
* console.log(`${index} UID ${volume.uid} Level ${volume.level}`);
* });
* });
* ```
*
* @param result An object consisting of the following properties:
* - level: The volume of the speaking user, ranging from 0 to 100.
* - uid: The ID of the speaking user.
*
* @asMemberOf IAgoraRTCClient
* @event
*/
declare function event_volume_indicator(result: {
/**
* The volume of the speaking user, ranging from 0 to 100.
*/
level: number;
/**
* The ID of the speaking user.
*/
uid: UID;
}[]): void;
/**
* Parameters for reporting customized messages. Used when calling [AgoraRTCClient.sendCustomReportMessage]{@link IAgoraRTCClient.sendCustomReportMessage}.
*/
export declare interface EventCustomReportParams {
/**
* The ID of the message.
*/
reportId: string;
/**
* The category of the message.
*/
category: string;
/**
* The event name of the message.
*/
event: string;
/**
* The label of the message.
*/
label: string;
/**
* The value of the message.
*/
value: number;
}
/**
* The `EventEmitter` class provides a way to define, emit, and handle events.
*/
declare class EventEmitter {
private _events;
/**
* Gets all the listeners for a specified event.
*
* @param event The event name.
*/
getListeners(event: string): Function[];
/**
* Listens for a specified event.
*
* When the specified event happens, the SDK triggers the callback that you pass.
* @param event The event name.
* @param listener The callback to trigger.
*/
on(event: string, listener: Function): void;
/**
* Listens for a specified event once.
*
* When the specified event happens, the SDK triggers the callback that you pass and then removes the listener.
* @param event The event name.
* @param listener The callback to trigger.
*/
once(event: string, listener: Function): void;
/**
* Removes the listener for a specified event.
*
* @param event The event name.
* @param listener The callback that corresponds to the event listener.
*/
off(event: string, listener: Function): void;
/**
* Removes all listeners for a specified event.
*
* @param event The event name. If left empty, all listeners for all events are removed.
*/
removeAllListeners(event?: string): void;
private _indexOfListener;
}
/**
* The entry point of the Agora Web SDK.
*/
export declare interface IAgoraRTC extends EventEmitter {
/**
* The version of the Agora Web SDK.
*/
VERSION: string;
/**
* @since
* 32 -1).
* - If you use a string as the user ID, the maximum length is 255 characters.
*
* To ensure a better end-user experience, Agora recommends using a number as the user ID.
*
* > Note:
* > - All users in the same channel should have the same type (number or string) of `uid`.
* > - You can use string UIDs to interoperate with the Native SDK 2.8 or later. Ensure that the Native SDK uses the User Account to join the channel. See [Use String User Accounts](https://docs.agora.io/en/faq/string).
* > - To ensure the data accuracy in Agora Analytics, Agora recommends that you specify `uid` for each user and ensure it is unique.
*/
preload(appid: string, channel: string, token: string | null, uid?: UID | null): Promise;
/**
* Creates a local client object for managing a call.
*
* This is usually the first step of using the Agora Web SDK.
* @param config The configurations for the client object, including channel profile and codec. The default codec is `vp8` and default channel profile is `rtc`. See {@link ClientConfig} for details.
* @category Agora Core
*/
createClient(config: ClientConfig): IAgoraRTCClient;
/**
* Creates a customized audio track.
*
* This method creates a customized audio track from a [MediaStreamTrack](https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrack) object.
*
* @param config Configurations for the customized audio track.
* @category Local Track
*/
createCustomAudioTrack(config: CustomAudioTrackInitConfig): ILocalAudioTrack;
/**
* Creates an audio track from the audio sampled by a microphone.
*
* @param config Configurations for the sampled audio, such as the capture device and the encoder configuration. See {@link MicrophoneAudioTrackInitConfig}.
* @category Local Track
*/
createMicrophoneAudioTrack(config?: MicrophoneAudioTrackInitConfig): Promise;
/**
*
* Creates an audio track from an audio file or [AudioBuffer](https://developer.mozilla.org/en-US/docs/Web/API/AudioBuffer) object.
*
* This method works with both the local and online audio files, supporting the following formats:
* - MP3.
* - AAC.
* - Other audio formats supported by the browser.
* @param config Configurations such as the file path, caching strategies, and encoder configuration.
* @returns Unlike other audio track objects, this audio track object adds the methods for audio playback control, such as playing, pausing, seeking and playback status querying.
* @category Local Track
*/
createBufferSourceAudioTrack(config: BufferSourceAudioTrackInitConfig): Promise;
/**
* Creates a customized video track.
*
* This method creates a customized video track from a [MediaStreamTrack](https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrack) object.
* @param config Configurations for the customized video track. See {@link CustomVideoTrackInitConfig}.
* > As of v4.17.1, you can set the resolution and frame rate (in addition to the sending bitrate) for a customized video track by [config]{@link CustomVideoTrackInitConfig}.
* @category Local Track
*/
createCustomVideoTrack(config: CustomVideoTrackInitConfig): ILocalVideoTrack;
/**
* Creates a video track from the video captured by a camera.
*
* @param config Configurations for the captured video, such as the capture device and the encoder configuration.
* @category Local Track
*/
createCameraVideoTrack(config?: CameraVideoTrackInitConfig): Promise;
/**
* Creates an audio track and a video track.
*
* Creates an audio track from the audio sampled by a microphone and a video track from the video captured by a camera.
*
* > Calling this method differs from calling {@link createMicrophoneAudioTrack} and {@link createCameraVideoTrack} separately:
* > - This method call requires access to the microphone and the camera at the same time. In this case, users only need to do authorization once.
* > - Calling {@link createMicrophoneAudioTrack} and {@link createCameraVideoTrack} requires access to the microphone and the camera separately. In this case, users need to do authorization twice.
* @param audioConfig Configurations for the sampled audio, such as the capture device and the encoder configurations.
* @param videoConfig Configurations for the captured video, such as the capture device and the encoder configurations.
*/
createMicrophoneAndCameraTracks(audioConfig?: MicrophoneAudioTrackInitConfig, videoConfig?: CameraVideoTrackInitConfig): Promise<[IMicrophoneAudioTrack, ICameraVideoTrack]>;
/**
* Creates a video track for screen sharing.
*
* @param config Configurations for the screen-sharing video, such as encoder configuration and capture configuration.
* @param withAudio Whether to share the audio of the **screen sharing input source** when sharing the screen.
* - `enable`: Share the audio.
* - `disable`: (Default) Do not share the audio.
* - `auto`: Share the audio, dependent on whether the browser supports this function.
* > Note:
* > - This function is only available for desktop browsers that support the Web SDK instead of mobile devices. For the specific list of supported browsers, see [Supported platforms](https://docs.agora.io/en/video-calling/overview/supported-platforms?platform=web).
* > - Additional information on browser versions and feature support across different operating systems:
* > - On macOS, Chrome 74 or later supports audio and video sharing, only when sharing Chrome tabs. Firefox and Safari 14 or later support window and screen sharing, but do not support audio sharing.
* > - On Windows, Chrome 74 or later and Edge support audio sharing when sharing the screen and browser tabs, but not when sharing application windows. Firefox supports window and screen sharing, but does not support audio sharing.
* > - On ChromeOS, Chrome supports audio sharing when sharing the screen and browser tabs, but not when sharing application windows.
* > - For the audio sharing to take effect, the end user must check **Share audio** in the pop-up window when sharing the screen.
* @returns
* @returns
* @returns
* - If `withAudio` is `enable`, then this method returns a list containing a video track for screen sharing and an audio track. If the end user does not check **Share audio**, the SDK throws an error.
* - If `withAudio` is `disable`, then this method returns a video track for screen sharing.
* - If `withAudio` is `auto`, then the SDK attempts to share the audio on browsers supporting this function.
* - If the end user checks **Share audio**, then this method returns a list containing a video track for screen sharing and an audio track.
* - If the end user does not check **Share audio**, then this method only returns a video track for screen sharing.
* @category Local Track
*/
createScreenVideoTrack(config: ScreenVideoTrackInitConfig, withAudio: "enable"): Promise<[ILocalVideoTrack, ILocalAudioTrack]>;
/**
* Creates a video track for screen sharing.
*
* @param config Configurations for the screen-sharing video, such as encoder configuration and capture configuration.
* @param withAudio Whether to share the audio of the **screen sharing input source** when sharing the screen.
* - `enable`: Share the audio.
* - `disable`: (Default) Do not share the audio.
* - `auto`: Share the audio, dependent on whether the browser supports this function.
* > Note:
* > - This function is only available for desktop browsers that support the Web SDK instead of mobile devices. For the specific list of supported browsers, see [Supported platforms](https://docs.agora.io/en/video-calling/overview/supported-platforms?platform=web).
* > - Additional information on browser versions and feature support across different operating systems:
* > - On macOS, Chrome 74 or later supports audio and video sharing, only when sharing Chrome tabs. Firefox and Safari 14 or later support window and screen sharing, but do not support audio sharing.
* > - On Windows, Chrome 74 or later and Edge support audio sharing when sharing the screen and browser tabs, but not when sharing application windows. Firefox supports window and screen sharing, but does not support audio sharing.
* > - On ChromeOS, Chrome supports audio sharing when sharing the screen and browser tabs, but not when sharing application windows.
* > - For the audio sharing to take effect, the end user must check **Share audio** in the pop-up window when sharing the screen.
* @returns
* - If `withAudio` is `enable`, then this method returns a list containing a video track for screen sharing and an audio track. If the end user does not check **Share audio**, the SDK throws an error.
* - If `withAudio` is `disable`, then this method returns a video track for screen sharing.
* - If `withAudio` is `auto`, then the SDK attempts to share the audio on browsers supporting this function.
* - If the end user checks **Share audio**, then this method returns a list containing a video track for screen sharing and an audio track.
* - If the end user does not check **Share audio**, then this method only returns a video track for screen sharing.
*/
createScreenVideoTrack(config: ScreenVideoTrackInitConfig, withAudio: "disable"): Promise;
/**
* Creates a video track for screen sharing.
*
* @param config Configurations for the screen-sharing video, such as encoder configuration and capture configuration.
* @param withAudio Whether to share the audio of the **screen sharing input source** when sharing the screen.
* - `enable`: Share the audio.
* - `disable`: (Default) Do not share the audio.
* - `auto`: Share the audio, dependent on whether the browser supports this function.
* > Note:
* > - This function is only available for desktop browsers that support the Web SDK instead of mobile devices. For the specific list of supported browsers, see [Supported platforms](https://docs.agora.io/en/video-calling/overview/supported-platforms?platform=web).
* > - Additional information on browser versions and feature support across different operating systems:
* > - On macOS, Chrome 74 or later supports audio and video sharing, only when sharing Chrome tabs. Firefox and Safari 14 or later support window and screen sharing, but do not support audio sharing.
* > - On Windows, Chrome 74 or later and Edge support audio sharing when sharing the screen and browser tabs, but not when sharing application windows. Firefox supports window and screen sharing, but does not support audio sharing.
* > - On ChromeOS, Chrome supports audio sharing when sharing the screen and browser tabs, but not when sharing application windows.
* > - For the audio sharing to take effect, the end user must check **Share audio** in the pop-up window when sharing the screen.
* @returns
* - If `withAudio` is `enable`, then this method returns a list containing a video track for screen sharing and an audio track. If the end user does not check **Share audio**, the SDK throws an error.
* - If `withAudio` is `disable`, then this method returns a video track for screen sharing.
* - If `withAudio` is `auto`, then the SDK attempts to share the audio on browsers supporting this function.
* - If the end user checks **Share audio**, then this method returns a list containing a video track for screen sharing and an audio track.
* - If the end user does not check **Share audio**, then this method only returns a video track for screen sharing.
*/
createScreenVideoTrack(config: ScreenVideoTrackInitConfig, withAudio?: "enable" | "disable" | "auto"): Promise<[ILocalVideoTrack, ILocalAudioTrack] | ILocalVideoTrack>;
/**
* Enumerates the media input and output devices available, such as microphones, cameras, and headsets.
*
* If this method call succeeds, the SDK returns a list of media devices in an array of [MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo) objects.
*
* > Note:
* > - Calling this method turns on the camera and microphone shortly for the device permission request. On browsers including Chrome 67+, Firefox 70+, and Safari 12+, the SDK cannot get accurate device information without permission for the media device.
* > - The [MediaDeviceInfo.deviceId](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo/deviceId) property of a device may change. For example, it is reset when the user clears cookies. Agora does not recommend using the `deviceId` property to implement your business logic.
*
* ```javascript
* getDevices().then(devices => {
* console.log("first device id", devices[0].deviceId);
* }).catch(e => {
* console.log("get devices error!", e);
* });
* ```
* @param skipPermissionCheck Whether to skip the permission check. If you set this parameter as `true`, the SDK does not trigger the request for media device permission. In this case, the retrieved media device information may be inaccurate.
* - `true`: Skip the permission check.
* - `false`: (Default) Do not skip the permission check.
* @category Media Devices
*/
getDevices(skipPermissionCheck?: boolean): Promise;
/**
* Enumerates the audio sampling devices available, such as microphones.
*
* If this method call succeeds, the SDK returns a list of audio input devices in an array of [MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo) objects.
*
* > Calling this method turns on the microphone shortly for the device permission request. On browsers including Chrome 67+, Firefox 70+, and Safari 12+, the SDK cannot get accurate device information without permission for the media device.
*
* @param skipPermissionCheck Whether to skip the permission check. If you set this parameter as `true`, the SDK does not trigger the request for media device permission. In this case, the retrieved media device information may be inaccurate.
* - `true`: Skip the permission check.
* - `false`: (Default) Do not skip the permission check.
* @category Media Devices
*/
getMicrophones(skipPermissionCheck?: boolean): Promise;
/**
* Enumerates the video capture devices available, such as cameras.
*
* If this method call succeeds, the SDK returns a list of video input devices in an array of [MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo) objects.
*
* > Calling this method turns on the camera shortly for the device permission request. On browsers including Chrome 67+, Firefox 70+, and Safari 12+, the SDK cannot get accurate device information without permission for the media device.
*
* @param skipPermissionCheck Whether to skip the permission check. If you set this parameter as `true`, the SDK does not trigger the request for media device permission. In this case, the retrieved media device information may be inaccurate.
* - `true`: Skip the permission check.
* - `false`: (Default) Do not skip the permission check.
* @category Media Devices
*/
getCameras(skipPermissionCheck?: boolean): Promise;
/**
* @since
* ;
/**
* Gets the sources for screen-sharing through Electron.
*
* > If your electron environment has set `contextIsolation: true`, calling this function will throw an error. You need to get screen source id with `contextBridge.exposeInMainWorld` method by yourself.
* ```
* // preload.js
*
* const {
* contextBridge, desktopCapturer
* } = require("electron");
*
* contextBridge.exposeInMainWorld(
* "electronDesktopCapturer", {
* getSources: async (...args) => {
* const sources = await desktopCapturer.getSources(...args);
* return sources;
* }
* }
* );
*
* // renderer.js
* (async () => {
* sources = await window.electronDesktopCapturer.getSources(["window", "screen"]);
* const source = sources[0]; // just for example ,you shuould make an UI for user to select the exact source.
* const screenVideoTrack = await AgoraRTC.createScreenVideoTrack({ electronScreenSourceId: source.id });
* })()
*
* ```
* If this method call succeeds, the SDK returns a list of screen sources in an array of {@link ElectronDesktopCapturerSource} objects.
* @param type The type of screen sources (window/application/screen) to get. See {@link ScreenSourceType}. If it is left empty, this method gets all the available sources.
* @category Media Devices
*/
getElectronScreenSources(type?: ScreenSourceType): Promise;
/**
* @ignore
*/
setAppType(type: AppType): void;
/**
* Sets the output log level of the SDK.
*
* Choose a level to see the logs preceding that level. The log level follows the sequence of NONE, ERROR, WARNING, INFO, and DEBUG.
*
* For example, if you set the log level as `AgoraRTC.setLogLevel(1);`, then you can see logs in levels INFO, ERROR, and WARNING.
* @param level The output log level.
* - 0: DEBUG. Output all API logs.
* - 1: INFO. Output logs of the INFO, WARNING and ERROR level.
* - 2: WARNING. Output logs of the WARNING and ERROR level.
* - 3: ERROR. Output logs of the ERROR level.
* - 4: NONE. Do not output any log.
* @category Logger
*/
setLogLevel(level: number): void;
/**
* Enables log upload.
*
* Call this method to enable log upload to Agora’s server.
*
* The log-upload function is disabled by default. To enable this function, you must call this method before calling all the other methods.
*
* > If a user fails to join the channel, the log information (for that user) is unavailable on Agora's server.
* @category Logger
*/
enableLogUpload(): void;
/**
* Disables log upload.
*
* The log-upload function is disabled by default. If you have called {@link enableLogUpload}, then call this method when you need to stop uploading the log.
* @category Logger
*/
disableLogUpload(): void;
/**
* Creates an object for configuring the media stream relay.
*/
createChannelMediaRelayConfiguration(): IChannelMediaRelayConfiguration;
/**
* Checks whether a video track is active.
*
* The SDK determines whether a video track is active by checking for image changes during the specified time frame.
*
* Agora recommends calling this method before starting a call to check the availability of the video capture device. You can pass the camera video track as a parameter in this method to check whether the camera works.
*
* > Notes:
* > - If a video track is muted, this method returns `false`.
* > - Do not call this method frequently as the check may affect web performance.
*
* ``` javascript
* const videoTrack = await AgoraRTC.createCameraVideoTrack({ cameraId });
* AgoraRTC.checkVideoTrackIsActive(videoTrack).then(result => {
* console.log(`${ cameraLabel } is ${ result ? "available" : "unavailable" }`);
* }).catch(e => {
* console.log("check video track error!", e);
* });
* ```
*
* @param track The local or remote video track to be checked.
* @param timeout The time frame (ms) for checking. The default value is 5,000 ms.
*
* @returns Whether the image in the specified video track changes during the specified time frame:
* - `true`: The image changes. For the camera video track, it means the video capture device works.
* - `false`: The image does not change. Possible reasons:
* - The video capturing device does not work properly or is blocked.
* - The video track is muted.
*/
checkVideoTrackIsActive(track: ILocalVideoTrack | IRemoteVideoTrack, timeout?: number): Promise;
/**
* Check whether an audio track is active.
*
* The SDK determines whether an audio track is active by checking whether the volume changes during the specified time frame.
*
* Agora recommends calling this method before starting a call to check the availability of the audio sampling device. You can pass the audio track from the audio sampled by a microphone as a parameter in this method to check whether the microphone works.
*
* > Notes:
* > - The check may fail in a quiet environment. Agora suggests you instruct the end user to speak or make some noise when calling this method.
* > - If an audio track is muted, this method returns `false`.
* > - Do not call this method frequently as the check may affect web performance.
*
* ``` javascript
* const audioTrack = await AgoraRTC.createMicrophoneAudioTrack({ microphoneId });
* AgoraRTC.checkAudioTrackIsActive(audioTrack).then(result => {
* console.log(`${ microphoneLabel } is ${ result ? "available" : "unavailable" }`);
* }).catch(e => {
* console.log("check audio track error!", e);
* });
* ```
*
* @param track The local or remote audio track to be checked.
* @param timeout The time frame (ms) for checking. The default value is 5,000 ms.
*
* @returns Whether the volume in the specified audio track changes during the specified time frame:
* - `true`: The volume changes. For the microphone audio track, it means the audio sampling device works.
* - `false`: The volume does not change. Possible reasons:
* - The audio sampling device does not work properly.
* - The volume in the customized audio track does not change.
* - The audio track is muted.
*/
checkAudioTrackIsActive(track: ILocalAudioTrack | IRemoteAudioTrack, timeout?: number): Promise;
/**
* Occurs when a video capture device is added or removed.
*
* ``` javascript
* AgoraRTC.onCameraChanged = (info) => {
* console.log("camera changed!", info.state, info.device);
* };
* ```
* **Parameters**
*
* - **deviceInfo**: The information of the video capture device. See {@link DeviceInfo}.
*
* @category Global Callback
*/
onCameraChanged?: (deviceInfo: DeviceInfo) => void;
/**
* Occurs when an audio sampling device is added or removed.
*
* ``` javascript
* AgoraRTC.onMicrophoneChanged = (info) => {
* console.log("microphone changed!", info.state, info.device);
* };
* ```
* **Parameters**
*
* - **deviceInfo**: The information of the device. See {@link DeviceInfo}.
* @category Global Callback
*/
onMicrophoneChanged?: (deviceInfo: DeviceInfo) => void;
/**
* @since
* []): void;
}
/**
* An interface providing the local client with basic functions for a voice or video call, such as joining a channel, publishing tracks, or subscribing to tracks.
*
* An `AgoraRTCClient` object is created by the [[createClient]] method.
* @public
*/
export declare interface IAgoraRTCClient extends EventEmitter {
/**
* Connection state between the SDK and the Agora server.
*/
readonly connectionState: ConnectionState;
/**
* A list of the remote users in the channel, each of which includes the user ID and the corresponding track information.
*
* The list is empty if the local user has not joined a channel.
*/
readonly remoteUsers: IAgoraRTCRemoteUser[];
/**
* @since
* 32 -1).
* - If you use a string as the user ID, the maximum length is 255 characters.
*
* To ensure a better end-user experience, Agora recommends using a number as the user ID.
*
* > Note:
* > - All users in the same channel should have the same type (number or string) of `uid`.
* > - You can use string UIDs to interoperate with the Native SDK 2.8 or later. Ensure that the Native SDK uses the User Account to join the channel. See [Use String User Accounts](https://docs.agora.io/en/faq/string).
* > - To ensure the data accuracy in Agora Analytics, Agora recommends that you specify `uid` for each user and ensure it is unique.
*
* @returns A Promise object with the user ID.
* - If you pass a number as the user ID, the SDK returns a number `uid`.
* - If you pass a string as the user ID, the SDK returns a string `uid`.
* - If you leave the `uid` parameter empty or set it as `null`, the Agora server assigns a number `uid` and returns it.
* @category Agora Core
*/
join(appid: string, channel: string, token: string | null, uid?: UID | null): Promise;
/**
* Leaves a channel.
*
* When leaving the channel, the [AgoraRTCClient.on("connection-state-change")]{@link IAgoraRTCClient.event_connection_state_change} callback is triggered on the local client.
*
* When a user (in the communication profile) or a host (in the live-broadcast profile) leaves the channel, the [AgoraRTCClient.on("user-left")]{@link IAgoraRTCClient.event_user_left} callback is triggered on each remote client in the channel.
* @category Agora Core
*/
leave(): Promise;
/**
* Publishes local audio and/or video tracks to a channel.
*
* After publishing the local tracks, the [AgoraRTCClient.on("user-published")]{@link event_user_published} callback is triggered on the remote client.
*
* > Note:
* > - In an interactive live streaming, call {@link setClientRole} to set the user role as the host before calling this method.
* > - You can call this method multiple times to add tracks for publishing.
* > - An `AgoraRTCClient` object can publish multiple audio tracks. The SDK automatically mixes the audio tracks into one audio track. Exception: Safari does not support publishing multiple audio tracks on versions earlier than Safari 12.
* > - An `AgoraRTCClient` object can publish **only one video track**. If you want to switch the published video track, for example, from a camera video track to a scree-sharing video track, you must unpublish the published video track.
* @param tracks Local tracks created by [AgoraRTC.createMicrophoneAudioTrack]{@link IAgoraRTC.createMicrophoneAudioTrack} / [AgoraRTC.createCameraVideoTrack]{@link IAgoraRTC.createCameraVideoTrack} or other methods.
* @category Agora Core
*/
publish(tracks: ILocalTrack | ILocalTrack[]): Promise;
/**
* @ignore
*/
publish(config: IDataChannelConfig): Promise;
/**
* @ignore
*/
publish(params: ILocalTrack | ILocalTrack[] | IDataChannelConfig): Promise;
/**
* Unpublishes the local audio and/or video tracks.
*
* After the local client unpublishes, the [AgoraRTCClient.on("user-unpublished")]{@link event_user_unpublished} callback is triggered on each remote client in the channel.
*
* > Note: In an interactive live streaming, after a host unpublishes the local tracks, the SDK does not automatically change the role of this host to the audience. To change the user role, you must call {@link setClientRole}.
*
* @param tracks The tracks to unpublish. If left empty, all the published tracks are unpublished.
* @category Agora Core
*/
unpublish(tracks?: ILocalTrack | ILocalTrack[]): Promise;
/**
* @ignore
*/
unpublish(dataChannel?: ILocalDataChannel): Promise;
/**
* @ignore
*/
unpublish(params?: ILocalTrack | ILocalTrack[] | ILocalDataChannel): Promise;
/**
* Subscribes to the audio and/or video tracks of a remote user.
*
* ```javascript
* await client.subscribe(user，"audio");
* user.audioTrack.play();
* ```
* @param user The remote user.
* @param mediaType The media type of the tracks to subscribe to.
* - `"video"`: Subscribe to the video track only.
* - `"audio"`: Subscribe to the audio track only.
*
* @returns When the subscription succeeds, the SDK adds the subscribed tracks to [user.audioTrack]{@link IAgoraRTCRemoteUser.audioTrack} and [user.videoTrack]{@link IAgoraRTCRemoteUser.videoTrack}. You can go on to call [audioTrack.play]{@link IRemoteAudioTrack.play} or [videoTrack.play]{@link IRemoteVideoTrack.play} to play the tracks.
* > The `Promise` object throws the `TRACK_IS_NOT_PUBLISHED` error if the specified tracks do not exist.
* @category Agora Core
*/
subscribe(user: IAgoraRTCRemoteUser | UID, mediaType: "video"): Promise;
/**
* Subscribes to the audio and/or video tracks of a remote user.
*
* ```javascript
* await client.subscribe(user，"audio");
* user.audioTrack.play();
* ```
* @param user The remote user.
* @param mediaType The media type of the tracks to subscribe to.
* - `"video"`: Subscribe to the video track only.
* - `"audio"`: Subscribe to the audio track only.
*
* @returns When the subscription succeeds, the SDK adds the subscribed tracks to [user.audioTrack]{@link IAgoraRTCRemoteUser.audioTrack} and [user.videoTrack]{@link IAgoraRTCRemoteUser.videoTrack}. You can go on to call [audioTrack.play]{@link IRemoteAudioTrack.play} or [videoTrack.play]{@link IRemoteVideoTrack.play} to play the tracks.
* > The `Promise` object throws the `TRACK_IS_NOT_PUBLISHED` error if the specified tracks do not exist.
* @category Agora Core
*/
subscribe(user: IAgoraRTCRemoteUser | UID, mediaType: "audio"): Promise;
/**
* @ignore
*/
subscribe(user: IAgoraRTCRemoteUser | UID, mediaType: "datachannel", channelId: number): Promise;
/**
* Subscribes to the audio and/or video tracks of a remote user.
*
* ```javascript
* await client.subscribe(user，"audio");
* user.audioTrack.play();
* ```
* @param user The remote user.
* @param mediaType The media type of the tracks to subscribe to.
* - `"video"`: Subscribe to the video track only.
* - `"audio"`: Subscribe to the audio track only.
* - `"datachannel"`: Reserved for future use.
*
* @returns When the subscription succeeds, the SDK adds the subscribed tracks to [user.audioTrack]{@link IAgoraRTCRemoteUser.audioTrack} and [user.videoTrack]{@link IAgoraRTCRemoteUser.videoTrack}. You can go on to call [audioTrack.play]{@link IRemoteAudioTrack.play} or [videoTrack.play]{@link IRemoteVideoTrack.play} to play the tracks.
* > The `Promise` object throws the `TRACK_IS_NOT_PUBLISHED` error if the specified tracks do not exist.
* @category Agora Core
*/
subscribe(user: IAgoraRTCRemoteUser | UID, mediaType: "video" | "audio" | "datachannel", channelId?: number): Promise;
presubscribe(uid: UID, mediaType: "audio"): Promise;
presubscribe(uid: UID, mediaType: "video"): Promise;
presubscribe(uid: UID, mediaType: "video" | "audio"): Promise;
/**
* @since
* ;
/**
* @since
* ;
/**
* Sets the video profile of the low-quality video stream.
*
* If you have enabled the dual-stream mode by calling {@link enableDualStream}, use this method to set the low-quality video stream profile.
*
* If you do not set the low-quality video stream profile, the SDK assigns the default values based on your stream video profile.
*
* > Note:
* > - Due to different device and browser restrictions on video parameter settings, not all video parameters set with `setLowStreamParameter` will take effect:
* > - On Firefox, frame rate settings do not take effect. The browser sets the frame rate at 30 fps. Additionally, on Mac Firefox 73+, the actual active frame rate value that take effects is smaller than the set value and there exist potential inaccuracies with the resolution.
* > - On Safari 14 to 17.2, frame rate settings do not take effect. The browser sets the frame rate at around 15 fps, and the resolution of the low-quality stream must be proportional to the resolution of the high-quality stream. Additionally, setting `LowStreamParameter.bitrate` does not take effect on iOS Safari.
* > - On some devices and browsers, the resolution you set may get adjusted by the browser. In this case, billings are calculated based on the actual resolution.
* @param streamParameter The video profile of the low-quality video stream.
* @category Dual Stream
*/
setLowStreamParameter(streamParameter: LowStreamParameter): void;
/**
* Enables dual-stream mode.
*
* Enables dual-stream mode for the local stream. Dual streams are a hybrid of a high-quality video stream and a low-quality video stream:
* - High-quality video stream: High bitrate, high resolution.
* - Low-quality video stream: Low bitrate, low resolution. The default video profile of the low-quality stream is: A resolution (width × height) of 160 × 120 px, a bitrate of 50 Kbps, and a frame rate of 15 fps. Call {@link setLowStreamParameter} to customize the video profile of the low-quality stream.
*
* > Note:
* > - On some Android devices, the remote user may not be able to switch to the low-quality stream after you call `enableDualStream`.
* > - On Android Chrome, the Web SDK cannot send high-quality and low-quality streams in H.264.
* > - On Safari browsers of some Mac devices using Intel chips, calling `enableDualStream` to enable the dual-stream mode with H.264 encoding may cause system lag if the resolution ratio between the small and large streams is lower than 1/4.
*
* ```javascript
* client.enableDualStream().then(() => {
* console.log("Enable Dual stream success!");
* }).catch(err => {
* console.log(err);
* })
* ```
* @category Dual Stream
*/
enableDualStream(): Promise;
/**
* Disables dual-stream mode.
* @category Dual Stream
*/
disableDualStream(): Promise;
/**
* Sets the user role and level in a live streaming (when [mode]{@link ClientConfig.mode} is `"live"`).
*
* - The user role determines the permissions that the SDK grants to a user, such as permission to publish local streams, subscribe to remote streams, and push streams to a CDN address. You can set the user role as `"host"` or `"audience"`. A host can publish and subscribe to streams, while an audience member can only subscribe to streams. The default role in a live streaming is `"audience"`. Before publishing tracks, you must call this method to set the user role as `"host"`.
* - The detailed options of a user, including the user level. The user level determines the level of services that a user can enjoy within the permissions of the user's role. For example, an audience can choose to receive remote streams with low latency or ultra low latency. Levels affect prices.
*
* > Note:
* > - When [mode]{@link ClientConfig.mode} is `"rtc"`, this method does not take effect and all users are `"host"` by default.
* > - If the local client switches the user role after joining a channel, the SDK triggers the [AgoraRTCClient.on("user-joined")]{@link event_user_joined} or [AgoraRTCClient.on("user-left")]{@link event_user_left} callback on the remote client.
* > - To switch the user role to `"audience"` after calling {@link publish}, call {@link unpublish} first. Otherwise the method call fails and throws an exception.
*
* @param role The role of the user.
* @param options The detailed options of a user, including user level.
*/
setClientRole(role: ClientRole, options?: ClientRoleOptions): Promise;
/**
*
* Deploys your proxy server.
*
* Do not use this method and {@link startProxyServer} together. They have
* the following differences:
* - `setProxyServer`: This method allows you to use a custom proxy server
* for purposes including signaling transmission, log uploading, and event reporting. But it cannot be used for media transmission.
* - `startProxyServer`: This method provides Agora's cloud proxy service,
* which handles media and signaling transmission with simple setup. For more
* information, refer to [Using Cloud Proxy Service](https://docs.agora.io/en/
* video-call-4.x/cloud_proxy_web_ng?platform=Web).
*
* > Note:
* > - Call this method before {@link join}.
* > - Proxy services by different service providers may result in slow performance if you are using the Firefox browser. Therefore, Agora recommends using the same service provider for the proxy services. If you use different service providers, Agora recommends not using the Firefox browser.
* @param proxyServer Your proxy server domain name. ASCII characters only.
* @category Proxy
*/
setProxyServer(proxyServer: string): void;
/**
* @ignore
* Deploys a TURN server.
*
* You can also use cloud proxy by {@link startProxyServer}. See [Use Cloud Proxy](https://docs.agora.io/en/Interactive%20Broadcast/cloud_proxy_web?platform=Web) for details.
*
* > Call this method before {@link join}.
*
* @param turnServer The TURN server settings.
* @category Proxy
*/
setTurnServer(turnServer: TurnServerConfig): void;
/**
* Enables cloud proxy.
*
* You must call this method before joining the channel or after leaving the channel.
*
* For the extra settings required for using the cloud proxy service, see [Use Cloud Proxy](https://docs.agora.io/en/Interactive%20Broadcast/cloud_proxy_web_ng?platform=Web).
*
* @param mode Cloud proxy mode:
* - `3`: The cloud proxy for the UDP protocol, that is, the Force UDP cloud proxy mode. In this mode, the SDK always transmits data over UDP.
* - `5`: The cloud proxy for the TCP (encryption) protocol, that is, the Force TCP cloud proxy mode. In this mode, the SDK always transmits data over TLS 443.
*
* > Note:
* > As of v4.15.0, the default value of `mode` is `3`.
*
* @category Proxy
*/
startProxyServer(mode?: number): void;
/**
* Disables cloud proxy.
*
* You must call this method before joining the channel or after leaving the channel.
* @category Proxy
*/
stopProxyServer(): void;
/**
* Sets which video stream of a remote user to subscribe to.
*
* If a remote user enables dual-stream mode, the user sends a hybrid of a high-quality video stream and a low-quality video stream. Use this method to set which video stream to subscribe to. The local client subscribes to the high-quality video stream by default.
*
* > - This method works only if the remote user has enabled the dual-stream mode ({@link enableDualStream}).
* > - If both this method and {@link setStreamFallbackOption} are called, the actual video stream that the user subscribes to depends on your settings. The following are two cases:
* > - If the parameter of {@link setStreamFallbackOption} is set to `0` (DISABLE), the video stream type that the user subscribes to is determined by the setting of `setRemoteVideoStreamType`.
* > - If the parameter of {@link setStreamFallbackOption} is set to `1` (VIDEO_STREAM_LOW) or `2` (VIDEO_STREAM_HIGH), the video stream type that the user subscribes to is first set according to the `setRemoteVideoStreamType` setting, but is dynamically adjusted according to the network conditions. For example, if you set the `setRemoteVideoStreamType` parameter to `0` (subscribe to a high-quality video stream), but the network condition is poor, the SDK will perform a fallback operation according to the `setStreamFallbackOption` setting.
*
* @param uid The ID of the remote user.
* @param streamType The remote video stream type:
* - 0: High-bitrate, high-resolution video stream.
* - 1: Low-bitrate, low-resolution video stream.
* @category Dual Stream
*/
setRemoteVideoStreamType(uid: UID, streamType: RemoteStreamType): Promise;
/**
* Sets the video type of all of the remote stream.
*
* If a remote user enables dual-stream mode, after using this method, local client will subscribe the specified streamType by default. The local client subscribes to the high-quality video stream by default.
*
* > - Agora suggests calling `setRemoteDefaultVideoStreamType` before joining the channel.
* > - The method call of {@link setRemoteVideoStreamType} to set the video stream type of a specified remote user overrides this method.
*
* @param streamType The remote video stream type:
* - 0: High-bitrate, high-resolution video stream.
* - 1: Low-bitrate, low-resolution video stream.
* @category Dual Stream
*/
setRemoteDefaultVideoStreamType(streamType: RemoteStreamType): Promise;
/**
* @ignore
*/
pickSVCLayer(uid: UID, layerOptions: {
spatialLayer: 0 | 1 | 2 | 3;
temporalLayer: 0 | 1 | 2 | 3;
}): Promise;
/**
* @ignore
*/
setRTMConfig(config: RTMConfiguration): Promise;
/**
* Sets the stream fallback option.
*
* Use this method to set the fallback option for the subscribed video stream.
* Under poor network conditions, the SDK can subscribe to the low-quality video stream or only to the audio stream.
*
* The SDK triggers the [AgoraRTCClient.on("stream-type-changed")]{@link event_stream_type_changed} callback when the remote stream changes from a high-quality video stream to a low-quality video stream or vice versa, and triggers the [AgoraRTCClient.on("stream-fallback")]{@link event_stream_fallback} callback when the remote stream changes from a video stream to an audio stream or vice versa.
*
* > - This method works only if the remote user has enabled the dual-stream mode by {@link enableDualStream}.
* > - When the remote user enables the dual-stream mode, if `setStreamFallbackOption` is not called at the local client, the default stream fallback option is to automatically subscribes to the low-video stream under poor network conditions ({@link RemoteStreamFallbackType} is `1`).
* @param uid The ID of the remote user.
* @param fallbackType The fallback option. See {@link RemoteStreamFallbackType} for details.
* @category Dual Stream
*/
setStreamFallbackOption(uid: UID, fallbackType: RemoteStreamFallbackType): Promise;
/**
* Sets the encryption configurations.
*
* Use this method to enable the built-in encryption before joining a channel.
*
* If the encryption configurations are incorrect, the SDK triggers the [AgoraRTCClient.on("crypt-error")]{@link event_crypt_error} callback when publishing tracks or subscribing to tracks.
*
* > Notes:
* > - All users in a channel must use the same encryption mode, secret, and salt.
* > - You must call this method before joining a channel, otherwise the method call does not take effect and encryption is not enabled.
* > - As of v4.7.0, after a user leaves the channel, the SDK automatically disables the built-in encryption. To re-enable the built-in encryption, call this method before the user joins the channel again.
* > - Do not use this method for CDN live streaming.
*
* @param encryptionMode The encryption mode.
* @param secret The encryption secret. ASCII characters only. When a user uses a weak secret, the SDK outputs a warning message to the Web Console and prompts the users to set a strong secret. A strong secret must contain at least eight characters and be a combination of uppercase and lowercase letters, numbers, and special characters. Due to browser encryption algorithm limitations, the secret length cannot exceed 62 characters. Agora recommends you use OpenSSL to generate the secret on your server. For details, see [Media Stream Encryption](https://docs.agora.io/en/Video/channel_encryption_web_ng?platform=Web).
* @param salt The salt. Only valid when you set the encryption mode as `"aes-128-gcm2"` or `"aes-256-gcm2"`. Agora recommends you use OpenSSL to generate the salt on your server. For details, see [Media Stream Encryption](https://docs.agora.io/en/Video/channel_encryption_web_ng?platform=Web).
* @param encryptDataStream Whether to encrypt the data stream.The encryption mode for the data stream must be consistent with the media stream. Currently, data stream encryption only supports "aes-128-gcm2" and "aes-256-gcm2" modes. Using other encryption modes will result in an error.
* - `true`: Enable data stream encryption.
* - `false`: Disable data stream encryption.
*/
setEncryptionConfig(encryptionMode: EncryptionMode, secret: string, salt?: Uint8Array, encryptDataStream?: boolean): void;
/**
* Renews the token.
*
* The token expires after a set time once token is enabled. When the SDK triggers the [AgoraRTCClient.on("token-privilege-will-expire")]{@link event_token_privilege_will_expire} callback, call this method to pass a new token. Otherwise the SDK disconnects from the server.
* @param token The new token.
*/
renewToken(token: string): Promise;
/**
* Enables the volume indicator.
*
* This method enables the SDK to regularly report the local and remote users who are speaking and their volumes.
*
* After the volume indicator is enabled, the SDK triggers the [AgoraRTCClient.on("volume-indicator")]{@link event_volume_indicator} callback to report the volumes every two seconds, regardless of whether there are active speakers in the channel.
*
* > If the local user leaves the channel and rejoins the channel, you need to call `enableAudioVolumeIndicator` again.
*
* ```javascript
* client.enableAudioVolumeIndicator();
* client.on("volume-indicator", volumes => {
* volumes.forEach((volume, index) => {
* console.log(`${index} UID ${volume.uid} Level ${volume.level}`);
* });
* })
* ```
*/
enableAudioVolumeIndicator(): void;
/**
* Gets the statistics of the call.
*
* @returns The statistics of the call.
*/
getRTCStats(): AgoraRTCStats;
/**
* Sets the video layout and audio for CDN live streaming.
*
* > Ensure that you [enable the RTMP Converter service](https://docs.agora.io/en/Interactive%20Broadcast/cdn_streaming_web?platform=Web#prerequisites) before using this function.
* @param config Configurations for live transcoding. See {@link LiveStreamingTranscodingConfig} for details.
* @category Live Streaming
*/
setLiveTranscoding(config: LiveStreamingTranscodingConfig): Promise;
/**
* Publishes the local stream to the CDN.
*
* See [Push Streams to the CDN](https://docs.agora.io/en/Interactive%20Broadcast/cdn_streaming_web?platform=Web) for details.
*
* > Note:
* > - This method adds only one stream HTTP/HTTPS URL address each time it is called.
*
* @param url The CDN streaming URL in the RTMP format. ASCII characters only.
* @param transcodingEnabled Whether to enable live transcoding.
* Transcoding sets the audio and video profiles and the picture-in-picture layout for the stream to be pushed to the CDN. It is often used to combine the audio and video streams of multiple hosts in a CDN live stream.
* > If set as `true`, {@link setLiveTranscoding} must be called before this method.
* - `true`: Enable transcoding.
* - `false`: (Default) Disable transcoding.
* @category Live Streaming
*/
startLiveStreaming(url: string, transcodingEnabled?: boolean): Promise;
/**
* Removes a URL from CDN live streaming.
*
* This method removes only one URL address each time it is called. To remove multiple URLs, call this method multiple times.
* @param url The URL to be removed.
* @category Live Streaming
*/
stopLiveStreaming(url: string): Promise;
/**
* Starts relaying media streams across channels.
*
* After this method call, the SDK triggers the following callbacks:
*
* - [AgoraRTCClient.on("channel-media-relay-state")]{@link event_channel_media_relay_state}, which reports the state and error code of the media stream relay.
* - If the media stream relay fails, this callback returns `state` 3. Refer to `code` for the error code and call this method again.
* - [AgoraRTCClient.on("channel-media-relay-event")]{@link event_channel_media_relay_event}, which reports the events of the media stream relay.
* - If the media stream relay starts successfully, this callback returns `code` 4, reporting that the SDK starts relaying the media stream to the destination channel.
*
* > Note:
* >
* > - Contact sales-us@agora.io to enable this function.
* > - We do not support string user IDs in this API.
* > - Call this method only after joining a channel.
* > - In a live-broadcast channel, only a host can call this method.
* > - To call this method again after it succeeds, you must call {@link stopChannelMediaRelay} to quit the current relay.
*
* ```javascript
* client.startChannelMediaRelay(config).then(() => {
* console.log("startChannelMediaRelay success");
* }).catch(e => {
* console.log("startChannelMediaRelay failed", e);
* })
* ```
* @param config Configurations of the media stream relay.
* @returns A `Promise` object, which is resolved if the media relay starts successfully.
* @category Channel Media Relay
*/
startChannelMediaRelay(config: IChannelMediaRelayConfiguration): Promise;
/**
* Updates the destination channels for media stream relay.
*
* After the channel media relay starts, if you want to relay the media stream to more channels, or leave the current relay channel, you can call this method.
*
* > Note:
* >
* > - Call this method after {@link startChannelMediaRelay}.
* > - You can add a maximum of four destination channels to a relay.
* @param config Configurations of the media stream relay.
* @returns A Promise object, which is resolved if the update succeeds. If the update fails, the media relay state is reset, and you need to call {@link startChannelMediaRelay} again to restart the relay.
* @category Channel Media Relay
*/
updateChannelMediaRelay(config: IChannelMediaRelayConfiguration): Promise;
/**
* Stops the media stream relay.
*
* Once the relay stops, the user leaves all the destination channels.
*
* @returns A `Promise` object, which is resolved if the relay stops successfully.
* @category Channel Media Relay
*/
stopChannelMediaRelay(): Promise;
/**
* Reports customized messages to Agora's data center.
*
* > Temporarily, Agora supports reporting a maximum of 20 message pieces within 5 seconds.
*
* @param reports Messages. You can report multiple messages one time.
*
* ```js
* client.sendCustomReportMessage({
* reportId: "id1", category: "category1", event: "custom", label: "label1", value: 0,
* }).then(() => {
* console.log("send custom report success");
* }).catch(e => {
* console.error("send custom report error");
* });
* ```
*/
sendCustomReportMessage(reports: EventCustomReportParams[] | EventCustomReportParams): Promise;
/**
* @since
* ;
/**
* @ignore
*/
disableContentInspect(): Promise;
/**
* Disables the third-party video moderation service.
*
* @param enabled Default is `false` and can only be set to `false`.
*/
setImageModeration(enabled: false): Promise;
/**
* Enables and configures the third-party video moderation service.
*
* After calling this method, the SDK triggers the
* [image-moderation-connection-state-change]{@link event_image_moderation_connection_state_change} callback, and captures the
* snapshots of the locally sent video to send to the third-party service
* provider for moderation.
*
* > - Before calling this method, make sure the following requirements are met:
* > - You have activated the third-party video moderation service.
* > - The local user has joined the channel, and the local video track has been published and enabled.
*
* @param enabled Default is `true` and can only be set to `true`.
* @param config Configuration for the video moderation service. See {@link ImageModerationConfiguration}.
*/
setImageModeration(enabled: true, config: ImageModerationConfiguration): Promise;
/**
* @ignore
*/
setLicense(license: string): void;
/**
* @ignore
*
* @param LocalAccessPointConfig
*/
setLocalAccessPointsV2(config: LocalAccessPointConfig): void;
}
/**
* @ignore
*/
export declare interface IAgoraRTCError extends Error {
readonly code: AgoraRTCErrorCode;
readonly message: string;
readonly data?: any;
readonly name: string;
toString(): string;
print(level?: "error" | "warning", logger?: any): IAgoraRTCError;
throw(logger?: any): never;
}
/**
* Information about a remote user. You can get this through [AgoraRTCClient.remoteUsers]{@link IAgoraRTCClient.remoteUsers}.
*/
export declare interface IAgoraRTCRemoteUser {
/**
* The ID of the remote user.
*/
uid: UID;
/**
* The subscribed audio track.
*/
audioTrack?: IRemoteAudioTrack;
/**
* The subscribed video track.
*/
videoTrack?: IRemoteVideoTrack;
/**
* Whether the remote user is sending an audio track.
* - `true`: The remote user is sending an audio track.
* - `false`: The remote user is not sending an audio track.
*/
hasAudio: boolean;
/**
* Whether the remote user is sending a video track.
* - `true`: The remote user is sending an audio track.
* - `false`: The remote user is not sending an audio track.
*/
hasVideo: boolean;
/**
* @ignore
*/
dataChannels?: IRemoteDataChannel[];
}
/**
* Inherited from [LocalAudioTrack]{@link ILocalAudioTrack}, `BufferSourceAudioTrack` is an interface for the audio from a local audio file and adds several functions for controlling the processing of the audio buffer, such as starting processing, stopping processing, and seeking a specified time location.
*
* You can create an audio track from an audio file by calling [AgoraRTC.createBufferSourceAudioTrack]{@link IAgoraRTC.createBufferSourceAudioTrack}.
*/
export declare interface IBufferSourceAudioTrack extends ILocalAudioTrack {
/**
* The [source]{@link BufferSourceAudioTrackInitConfig.source} specified when creating an audio track.
*/
source: string | File | AudioBuffer | null;
/**
* The current state of audio processing, such as start, pause, or stop.
*/
currentState: AudioSourceState;
/**
* The total duration of the audio (seconds).
*/
duration: number;
/**
* @since
* ;
/**
* @since
* ;
/**
* @since
* ;
/**
* Gets the statistics of a local audio track.
*
* @deprecated from v4.1.0. Use [AgoraRTCClient.getLocalVideoStats]{@link IAgoraRTCClient.getLocalVideoStats} and [AgoraRTCClient.getLocalAudioStats]{@link IAgoraRTCClient.getLocalAudioStats} instead.
*/
getStats(): LocalAudioTrackStats;
/**
* Inserts a `Processor` to the local audio track.
*
* @param processor The `Processor` instance. Each extension has a corresponding type of `Processor`.
*
* @returns The `Processor` instance.
*/
pipe(processor: IAudioProcessor): IAudioProcessor;
/**
* @since
* ;
/**
* @deprecated from v4.1.0. Use [AgoraRTCClient.getLocalVideoStats]{@link IAgoraRTCClient.getLocalVideoStats} and [AgoraRTCClient.getLocalAudioStats]{@link IAgoraRTCClient.getLocalAudioStats} instead.
*
* Gets the statistics of a local track.
*
* > Note: When getting the statistics of a local video track, you cannot get the `encodeDelay` property on iOS.
*/
getStats(): LocalVideoTrackStats | LocalAudioTrackStats;
/**
* Gets the label of a local track.
*
* @return The label that the SDK returns may include:
* - The [MediaDeviceInfo.label](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo/label) property, if the track is created by calling `createMicrophoneAudioTrack` or `createCameraVideoTrack`.
* - The `sourceId` property, if the track is created by calling `createScreenVideoTrack`.
* - The [MediaStreamTrack.label](https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrack/label) property, if the track is created by calling `createCustomAudioTrack` or `createCustomVideoTrack`.
*/
getTrackLabel(): string;
/**
* Sends or stops sending the media data of the track.
*
* @since
* ;
/**
* Closes a local track and releases the audio and video resources that it occupies.
*
* Once you close a local track, you can no longer reuse it.
*/
close(): void;
muted: boolean;
enabled: boolean;
}
/**
* `LocalVideoTrack` is the basic interface for local video tracks, providing the main methods for local video tracks.
*
* You can get create a local video track by calling [AgoraRTC.createCustomVideoTrack]{@link IAgoraRTC.createCustomVideoTrack} or [AgoraRTC.createScreenVideoTrack]{@link IAgoraRTC.createScreenVideoTrack} method.
*
* Inherited from `LocalVideoTrack`, [CameraVideoTrack]{@link ICameraVideoTrack} is an interface for the video captured by a local camera and adds several camera-related functions.
*/
export declare interface ILocalVideoTrack extends ILocalTrack {
/**
* @param event The event name.
* @param listener See [track-updated]{@link event_track_updated}.
*/
on(event: "track-updated", listener: typeof event_track_updated): void;
/**
* @param event The event name.
* @param listener See [track-ended]{@link event_track_ended}.
*/
on(event: "track-ended", listener: typeof event_track_ended): void;
/**
* @param event The event name.
* @param listener See [video-element-visible-status]{@link event_video_element_visible_status}.
*/
on(event: "video-element-visible-status", listener: typeof event_video_element_visible_status): void;
/**
* Adds an event listener.
* @param event The event name.
* @param listener See [ILocalTrack.transceiver-updated]{@link event_transceiver_updated}.
*/
on(event: "transceiver-updated", listener: typeof event_transceiver_updated): void;
/**
* Plays a remote video track on the web page.
*
* @param element Specifies a DOM element. The SDK will create a `` element under the specified DOM element to play the video track. You can specify a DOM element in either of the following ways:
* - `string`: Specify the ID of the DOM element.
* - `HTMLElement`: Pass a DOM object.
* @param config Sets the playback configurations, such as display mode and mirror mode. See [[VideoPlayerConfig]]. By default, the SDK enables mirror mode for a local video track.
*/
play(element: string | HTMLElement, config?: VideoPlayerConfig): void;
/**
* Gets the statistics of a local video track.
*
* @deprecated from v4.1.0. Use [AgoraRTCClient.getLocalVideoStats]{@link IAgoraRTCClient.getLocalVideoStats} and [AgoraRTCClient.getLocalAudioStats]{@link IAgoraRTCClient.getLocalAudioStats} instead.
*/
getStats(): LocalVideoTrackStats;
/**
* @since
* ;
/**
* @since
* ;
/**
* @since
* ;
/**
* @since
* ` HTML tag.
*
* After you call `localVideoTrack.play`, the SDK creates an [``](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video) tag for playing video tracks. When `localVideoTrack.isPlaying` is `true` but you cannot see any video, call this method to check whether the `` tag is visible or not and learn the reason when the `` tag is invisible.
*
* @returns The [[CheckVideoVisibleResult]] object. If this method returns `undefined`, it may be due to the following reasons:
* - `localVideoTrack.isPlaying` is `false`.
* - The `` tag does not exist.
* - The `` tag is not created by calling the `play` method.
*/
getVideoElementVisibleStatus(): CheckVideoVisibleResult | undefined;
/**
* Inserts a `Processor` to the local video track.
*
* @param processor The `Processor` instance. Each extension has a corresponding type of `Processor`.
*
* @returns The `Processor` instance.
*/
pipe(processor: IBaseProcessor): IBaseProcessor;
/**
* @since
* ;
/**
* Sets the video encoder configurations, such as resolution, frame rate, and bitrate.
*
* @param config The video encoder configurations. You can pass either [[VideoEncoderConfigurationPreset]] or a customized [[VideoEncoderConfiguration]] object.
*/
setEncoderConfiguration(config: VideoEncoderConfiguration | VideoEncoderConfigurationPreset): Promise;
/**
* Add the SEI data to the H.264 video stream.
*
* @param config SEI data.
*/
sendSeiData(sei: Uint8Array): void;
}
/**
* Configuration for the video moderation service. Used in the {@link setImageModeration} method.
*/
declare interface ImageModerationConfiguration {
/**
* Interval for taking video screenshots (ms), with a minimum value of `1000`.
*/
interval: number;
/**
* Additional information, with a maximum length of 1024 bytes.
*
* The SDK sends the screenshots and additional information on the video content to the Agora server. Once the video screenshot and upload process is completed, the Agora server sends the additional information and the callback notification to your server.
*/
extraInfo?: string;
/**
* @ignore
*/
vendor?: string;
}
/**
* Connection state between the SDK and the third-party video moderation service.
*/
declare enum ImageModerationConnectionState {
/**
* The SDK is connecting to the third-party service.
*/
CONNECTING = "CONNECTING",
/**
* The SDK is reconnecting to the third-party service.
*/
RECONNECTING = "RECONNECTING",
/**
* The SDK is connected to the third-party service.
*/
CONNECTED = "CONNECTED",
/**
* The SDK has disconnected from the third-party service.
*/
CLOSED = "CLOSED"
}
export declare interface ImageTypedData {
buffer: Uint8Array;
width: number;
height: number;
}
/**
* Inherited from [LocalAudioTrack]{@link ILocalAudioTrack}, `MicrophoneAudioTrack` is an interface for the audio sampled by a local microphone and adds several functions such as switching devices.
*
* You can create a local microphone audio track by calling [AgoraRTC.createMicrophoneAudioTrack]{@link IAgoraRTC.createMicrophoneAudioTrack}.
*/
export declare interface IMicrophoneAudioTrack extends ILocalAudioTrack {
/**
* Sets the device for sampling audio.
*
* > You can call the method either before or after publishing an audio track.
*
* @param deviceId The ID of the specified device. You can get the `deviceId` by calling [AgoraRTC.getMicrophones]{@link IAgoraRTC.getMicrophones}.
*/
setDevice(deviceId: string): Promise;
/**
* @since
* ;
}
/**
* @ignore
*/
export declare interface InspectConfiguration {
interval: number;
ossFilePrefix?: string;
extraInfo?: string;
inspectType?: ("supervise" | "moderation")[];
}
/**
* @ignore
*/
declare enum InspectState {
CONNECTING = "CONNECTING",
RECONNECTING = "RECONNECTING",
CONNECTED = "CONNECTED",
CLOSED = "CLOSED"
}
/**
* `RemoteAudioTrack` is the basic interface for the remote audio track.
*
* You can get create a remote audio track by the [AgoraRTCRemoteUser.audioTrack]{@link IAgoraRTCRemoteUser.audioTrack} object after calling [subscribe]{@link IAgoraRTCClient.subscribe}.
*/
export declare interface IRemoteAudioTrack extends IRemoteTrack {
/**
* Gets the statistics of a remote audio track.
*
* @return An [[RemoteAudioTrackStats]] object.
*/
getStats(): RemoteAudioTrackStats;
/**
* Plays a remote audio track.
*
* > When playing the audio track, you do not need to pass any DOM element.
*/
play(): void;
/**
* @since
* ;
/**
* Sets the callback for getting raw audio data in PCM format.
*
* After you successfully set the callback, the SDK constantly returns the audio frames of a remote audio track in this callback by using [AudioBuffer](https://developer.mozilla.org/en-US/docs/Web/API/AudioBuffer).
*
* > You can set the `frameSize` parameter to determine the frame size in each callback, which affects the interval between the callbacks. The larger the frame size, the longer the interval between them.
*
* ```js
* track.setAudioFrameCallback((buffer) => {
* for (let channel = 0; channel < buffer.numberOfChannels; channel += 1) {
* // Float32Array with PCM data
* const currentChannelData = buffer.getChannelData(channel);
* console.log("PCM data in channel", channel, currentChannelData);
* }
* }, 2048);
*
* // ....
* // Stop getting the raw audio data
* track.setAudioFrameCallback(null);
* ```
*
* @param audioFrameCallback The callback function for receiving the [AudioBuffer](https://developer.mozilla.org/en-US/docs/Web/API/AudioBuffer) object. If you set `audioBufferCallback` as `null`, the SDK stops getting raw audio data.
* @param frameSize The number of samples of each audio channel that an `AudioBuffer` object contains. You can set `frameSize` as 256, 512, 1024, 2048, 4096, 8192, or 16384. The default value is 4096.
*/
setAudioFrameCallback(audioFrameCallback: null | ((buffer: AudioBuffer) => void), frameSize?: number): void;
/**
* Sets the volume of a remote audio track.
*
* @param volume The volume. The value ranges from 0 (mute) to 100 (maximum). A value of 100 is the current volume.
*/
setVolume(volume: number): void;
/**
* Gets the audio level of a remote audio track.
*
* @returns The audio level. The value range is [0,1]. 1 is the highest audio level.
* Usually a user with audio level above 0.6 is a speaking user.
*/
getVolumeLevel(): number;
/**
* @since
* ` element under the specified DOM element to play the video track. You can specify a DOM element in either of following ways:
* - `string`: Specify the ID of the DOM element.
* - `HTMLElement`: Pass a DOM object.
* @param config Sets the playback configurations, such as display mode and mirror mode. See [[VideoPlayerConfig]]. By default, the SDK enables mirror mode for a local video track.
*/
play(element: string | HTMLElement, config?: VideoPlayerConfig): void;
/**
* @since
* ` HTML tag.
*
* After you call `remoteVideoTrack.play`, the SDK creates an [``](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video) tag for playing video tracks. When `remoteVideoTrack.isPlaying` is `true` but you cannot see any video, call this method to check whether the `` tag is visible or not and learn the reason when the `` tag is invisible.
*
* @returns The [[CheckVideoVisibleResult]] object. If this method returns `undefined`, it may be due to the following reasons:
* - `remoteVideoTrack.isPlaying` is `false`.
* - The `` tag does not exist.
* - The `` tag is not created by calling the `play` method.
*/
getVideoElementVisibleStatus(): CheckVideoVisibleResult | undefined;
/**
* @since
* ` element under the specified DOM element to play the video track. You can specify a DOM element in either of following ways:
* - `string`: Specify the ID of the DOM element.
* - `HTMLElement`: Pass a DOM object.
*/
play(element?: string | HTMLElement): void;
/**
* Stops playing the media track.
*/
stop(): void;
}
/**
* The configurations for CDN live stream transcoding. To be used when you call [setLiveTranscoding]{@link IAgoraRTCClient.setLiveTranscoding}.
*/
export declare interface LiveStreamingTranscodingConfig {
/**
* The audio bitrate (Kbps) of the CDN live stream.
*
* A positive integer. The default value is 48, and the highest value is 128.
*/
audioBitrate?: number;
/**
* The number of audio channels for the CDN live stream.
*
* Agora recommends choosing 1 (mono), or 2 (stereo) audio channels. Special players are required if you choose 3, 4, or 5.
*
* - 1: (Default) Mono
* - 2: Stereo
* - 3: Three audio channels
* - 4: Four audio channels
* - 5: Five audio channels
*/
audioChannels?: 1 | 2 | 3 | 4 | 5;
/**
* The audio sampling rate:
*
* - 32000: 32 kHz
* - 44100: 44.1 kHz
* - 48000: (Default) 48 kHz
*/
audioSampleRate?: 32000 | 44100 | 48000;
/**
* The background color in RGB hex.
*
* Value only. Do not include a preceding #. The default value is 0x000000.
*/
backgroundColor?: number;
/**
* The height of the video in pixels.
*
* A positive integer, the default value is 360.
*
* - When pushing video streams to the CDN, ensure that `height` is at least 64; otherwise, the Agora server adjusts the value to 64.
* - When pushing audio streams to the CDN, set `width` and `height` as 0.
*/
height?: number;
/**
* The width of the video in pixels.
*
* A positive integer, the default value is 640.
*
* - When pushing video streams to the CDN, ensure that `width` is at least 64; otherwise, the Agora server adjusts the value to 64.
* - When pushing audio streams to the CDN, set `width` and `height` as 0.
*/
width?: number;
/**
* @ignore
*/
lowLatency?: boolean;
/**
* The bitrate (Kbps) of the output video stream.
*
* The default value is 400.
*/
videoBitrate?: number;
/**
* The video codec profile type.
*
* Set it as `66`, `77`, or `100` (default). If you set this parameter to any other value, the Agora server adjusts it to the default value `100`.
*
* - `66`: Baseline video codec profile. Generally used for video calls on mobile phones.
* - `77`: Main video codec profile. Generally used for mainstream electronic devices, such as MP4 players, portable video players, PSP, and iPads.
* - `100`: (Default) High video codec profile. Generally used for high-resolution broadcasts or television.
*/
videoCodecProfile?: 66 | 77 | 100;
/**
* The video frame rate (fps) of the CDN live stream.
*
* The default value is 15. The Agora server adjusts any value over 30 to 30.
*/
videoFrameRate?: number;
/**
* The video GOP in frames.
*
* The default value is 30.
*/
videoGop?: number;
/**
* @deprecated
*
* Watermark images for the CDN live stream.
*/
images?: LiveStreamingTranscodingImage[];
/**
* Watermark image for the CDN live stream.
*/
watermark?: LiveStreamingTranscodingImage;
/**
* Background image for the CDN live stream.
*/
backgroundImage?: LiveStreamingTranscodingImage;
/**
* Manages the user layout configuration in the CDN live streaming.
*
* Agora supports a maximum of 17 transcoding users in a CDN streaming channel.
*/
transcodingUsers?: LiveStreamingTranscodingUser[];
userConfigExtraInfo?: string;
}
/**
* Configurations for the watermark and background images to put on top of the video in [LiveStreamingTranscodingConfig]{@link LiveStreamingTranscodingConfig}.
*/
export declare interface LiveStreamingTranscodingImage {
/**
* The HTTP/HTTPS URL address of the image on the video.
*
* Supports online PNG only.
*/
url: string;
/**
* The horizontal distance (pixel) between the image's top-left corner and the video's top-left corner.
*
* The default value is `0`.
*/
x?: number;
/**
* The vertical distance (pixel) between the image's top-left corner and the video's top-left corner.
*
* The default value is `0`.
*/
y?: number;
/**
* The width (pixel) of the image.
*
* The default value is `160`.
*/
width?: number;
/**
* The height (pixel) of the image.
*
* The default value is `160`.
*/
height?: number;
/**
* The transparency level of the image.
*
* The value range is [0.0,1.0]:
* - 0.0: Completely transparent.
* - 1.0: (Default) Opaque.
*/
alpha?: number;
}
/**
* Manages the user layout configuration in [LiveStreamingTranscodingConfig]{@link LiveStreamingTranscodingConfig}.
*/
export declare interface LiveStreamingTranscodingUser {
/**
* The transparency level of the user's video.
*
* The value ranges between 0.0 and 1.0:
*
* - 0.0: Completely transparent.
* - 1.0: (Default) Opaque.
*/
alpha?: number;
/**
* The height of the video.
*
* The default value is 640.
*/
height?: number;
/**
* The user ID of the CDN live host.
*/
uid: UID;
/**
* The width of the video.
*
* The default value is 360.
*/
width?: number;
/**
* The position of the top-left corner of the video on the horizontal axis.
*
* The default value is 0.
*/
x?: number;
/**
* The position of the top-left corner of the video on the vertical axis.
*
* The default value is 0.
*/
y?: number;
/**
* The layer index of the video frame.
*
* An integer. The value range is [0,100].
*
* - 0: (Default) Bottom layer.
* - 100: Top layer.
*/
zOrder?: number;
/**
* The audio channel ranging between 0 and 5. The default value is 0.
* - 0: (default) Supports dual channels. Depends on the upstream of the broadcaster.
* - 1: The audio stream of the broadcaster uses the FL audio channel. If the broadcaster’s upstream uses multiple audio channels, these channels are mixed into mono first.
* - 2: The audio stream of the broadcaster uses the FC audio channel. If the broadcaster’s upstream uses multiple audio channels, these channels are mixed into mono first.
* - 3: The audio stream of the broadcaster uses the FR audio channel. If the broadcaster’s upstream uses multiple audio channels, these channels are mixed into mono first.
* - 4: The audio stream of the broadcaster uses the BL audio channel. If the broadcaster’s upstream uses multiple audio channels, these channels are mixed into mono first.
* - 5: The audio stream of the broadcaster uses the BR audio channel. If the broadcaster’s upstream uses multiple audio channels, these channels are mixed into mono first.
*/
audioChannel?: number;
}
/**
* @ignore
*
* -----暂不对外的备用内容-----
* - `cds`：（可选）配置下发服务。默认关闭。包含可选属性 `hostname` 和 `port`。
*
* 默认值
* |`cds.hostname`| `accessPoints` 所包含的 hostname 列表|
* |`cds.port`|443|
*/
export declare type LocalAccessPointConfig = {
[serve in "log" | "report" | "cds"]?: {
hostname?: string[];
port?: number;
};
} & {
accessPoints: {
serverList: string[];
domain: string;
port?: number;
};
};
/**
* Information of the local audio track, which can be retrieved by calling [AgoraRTCClient.getLocalAudioStats]{@link IAgoraRTCClient.getLocalAudioStats}.
*/
export declare interface LocalAudioTrackStats {
/**
* The audio codec.
*
* - `"opus"`: The audio codec is OPUS。
* - `"aac"`: The audio codec is AAC。
* - `"pcmu"`: Reserved for future use.
* - `"pcma"`: Reserved for future use.
* - `"g722"`: Reserved for future use.
*
* > Firefox does not support this property.
*/
codecType?: "opus" | "aac" | "PCMU" | "PCMA" | "G722";
/**
* The energy level of the sent audio.
*
* The value range is [0,32767].
*
* > This value is retrieved by calling WebRTC-Stats and may not be up-to-date. To get the real-time sound volume, call [LocalAudioTrack.getVolumeLevel]{@link ILocalAudioTrack.getVolumeLevel}.
*/
sendVolumeLevel: number;
/**
* The bitrate (bps) of the sent audio.
*/
sendBitrate: number;
/**
* The total bytes of the sent audio.
*/
sendBytes: number;
/**
* The total packets of the sent audio.
*/
sendPackets: number;
/**
* The total number of lost audio packets that were sent.
*
* > You can not get this property on Safari.
*/
sendPacketsLost: number;
/**
* Jitter (ms) of the audio packets that were sent.
*/
sendJitterMs: number;
/**
* Round-trip time delay (ms) of the audio packets that were sent.
*/
sendRttMs: number;
/**
* The packet loss rate of the sent audio in 400ms.
*/
currentPacketLossRate: number;
}
/**
* Information of the local video track, which can be retrieved by calling [AgoraRTCClient.getLocalVideoStats]{@link IAgoraRTCClient.getLocalVideoStats}.
*/
export declare interface LocalVideoTrackStats {
/**
* The video codec.
*
* - `"H264"`: The video codec is H.264.
* - `"VP8"`: The video codec is VP8.
* - `"VP9"`: The video codec is VP9.
* - `"AV1X"`: Reserved for future use.
* - `"AV1"`: The video codec is AV1.
*
* > You can not get this property on Firefox.
*/
codecType?: "H264" | "H265" | "VP8" | "VP9" | "AV1X" | "AV1";
/**
* The total bytes of the sent video.
*/
sendBytes: number;
/**
* The frame rate (fps) of the sent video.
*
* > You can not get this property on Firefox.
*/
sendFrameRate?: number;
/**
* The frame rate (fps) of the captured video.
*
* > You can not get this property on Safari and Firefox.
*/
captureFrameRate?: number;
/**
* The total packets of the sent video.
*/
sendPackets: number;
/**
* The total number of lost video packets that were sent.
*
* > - You can not get this property on Safari.
* > - This property is inaccurate on Firefox.
*/
sendPacketsLost: number;
/**
* Jitter (ms) of the video packets that were sent.
*/
sendJitterMs: number;
/**
* Round-trip time delay (ms) of the video packets that were sent.
*/
sendRttMs: number;
/**
* The resolution height (pixel) of the sent video.
*/
sendResolutionHeight: number;
/**
* The resolution width (pixel) of the sent video.
*/
sendResolutionWidth: number;
/**
* The resolution height (pixel) of the captured video.
*/
captureResolutionHeight: number;
/**
* The resolution width (pixel) of the captured video.
*/
captureResolutionWidth: number;
/**
* The time (ms) required for encoding the captured video.
*/
encodeDelay?: number;
/**
* The bitrate (bps) of the sent video.
*/
sendBitrate: number;
/**
* The target bitrate (bps) of the sent video, namely the bitrate set in {@link VideoEncoderConfiguration}.
*/
targetSendBitrate: number;
/**
* The total duration of the sent video in seconds.
*/
totalDuration: number;
/**
* The total freeze time of the encoded video in seconds.
*/
totalFreezeTime: number;
/**
* The packet loss rate of the sent video in 400ms.
*/
currentPacketLossRate: number;
}
/**
* The video profile of the low-quality video stream. Set the the video profile of the low-quality video stream when calling [setLowStreamParameter]{@link IAgoraRTCClient.setLowStreamParameter}.
*/
export declare interface LowStreamParameter {
/**
* Width of the video.
*
* You can pass a `number`, or a constraint such as `{ max: 1280, min: 720 }`.
*
* For more details about the constraint, see [ConstrainLong]{@link ConstrainLong}.
*/
width: ConstrainULong;
/**
* Height of the video.
*
* You can pass a `number`, or a constraint such as `{ max: 1280, min: 720 }`.
*
* For more details about the constraint, see [ConstrainLong]{@link ConstrainLong}.
*/
height: ConstrainULong;
/**
* Frame rate of the video (fps).
*
* You can pass a `number`, or a constraint such as `{ max: 30, min: 5 }`.
*
* For details about the constraint, see [ConstrainLong]{@link ConstrainLong}.
*/
framerate?: ConstrainULong;
/**
* Bitrate of the video (Kbps).
*/
bitrate?: number;
}
/**
* Configurations for the audio track from the audio captured by a microphone. Set these configurations when calling [AgoraRTC.createMicrophoneAudioTrack]{@link IAgoraRTC.createMicrophoneAudioTrack}.
*/
export declare interface MicrophoneAudioTrackInitConfig {
/**
* The audio encoder configurations.
*
* You can set the audio encoder configurations in either of the following ways:
* - Pass the preset audio encoder configurations by using [[AudioEncoderConfigurationPreset]].
* - Pass your customized audio encoder configurations by using [[AudioEncoderConfiguration]].
*
* > Firefox does not support setting the audio encoding rate.
*/
encoderConfig?: AudioEncoderConfiguration | AudioEncoderConfigurationPreset;
/**
* Whether to enable acoustic echo cancellation:
* - `true`: Enable acoustic echo cancellation.
* - `false`: Do not enable acoustic echo cancellation.
*/
AEC?: boolean;
/**
* Whether to enable audio gain control:
* - `true`: Enable audio gain control.
* - `false`: Do not enable audio gain control.
*/
AGC?: boolean;
/**
* Whether to enable automatic noise suppression:
* - `true`: Enable automatic noise suppression.
* - `false`: Do not automatic noise suppression.
*/
ANS?: boolean;
/**
* @ignore
*/
DTX?: boolean;
/**
* Specifies the microphone ID.
*
* You can get a list of the available microphones by calling [AgoraRTC.getMicrophones]{@link IAgoraRTC.getMicrophones}.
*/
microphoneId?: string;
/**
* @ignore
* Specifies whether or not audio track pass through WebAudio.
*/
bypassWebAudio?: boolean;
}
/**
* The last-mile network quality.
*
* Last mile refers to the connection between the local device and Agora edge server.
*
* - After the local user joins the channel, the SDK triggers the [AgoraRTCClient.on("network-quality")]{@link IAgoraRTCClient.event_network_quality} callback once every two seconds and provides the uplink and downlink last-mile network conditions of the user through this interface.
* - You can call [AgoraRTCClient.getRemoteNetworkQuality]{@link IAgoraRTCClient.getRemoteNetworkQuality} to get the network quality of all remote users to whom the local user subscribes.
*
* > The returned network quality is a relative value and is for reference only.
*/
export declare interface NetworkQuality {
/**
* The uplink network quality.
*
* It is calculated based on the uplink transmission bitrate, uplink packet loss rate, RTT (round-trip time) and jitter.
*
* - 0: The quality is unknown.
* - 1: The quality is excellent.
* - 2: The quality is good, but the bitrate is less than optimal.
* - 3: Users experience slightly impaired communication.
* - 4: Users can communicate with each other, but not very smoothly.
* - 5: The quality is so poor that users can barely communicate.
* - 6: The network is disconnected and users cannot communicate.
*/
uplinkNetworkQuality: 0 | 1 | 2 | 3 | 4 | 5 | 6;
/**
* The downlink network quality.
*
* It is calculated based on the uplink transmission bitrate, uplink packet loss rate, RTT (round-trip time) and jitter.
*
* - 0: The quality is unknown.
* - 1: The quality is excellent.
* - 2: The quality is good, but the bitrate is less than optimal.
* - 3: Users experience slightly impaired communication.
* - 4: Users can communicate with each other, but not very smoothly.
* - 5: The quality is so poor that users can barely communicate.
* - 6: The network is disconnected and users cannot communicate.
*/
downlinkNetworkQuality: 0 | 1 | 2 | 3 | 4 | 5 | 6;
}
declare type OptimizationMode = "motion" | "detail";
/**
* Statistics of the remote audio track, such as connection and transmission statistics, which can be retrieved by calling [AgoraRTCClient.getRemoteAudioStats]{@link IAgoraRTCClient.getRemoteAudioStats}.
*/
export declare interface RemoteAudioTrackStats {
/**
* Transmission delay (ms).
*
* The delay (ms) between a remote client sending the audio and the local client receiving the audio.
*/
transportDelay: number;
/**
* The audio codec.
*
* - `"opus"`: The audio codec is OPUS。
* - `"aac"`: The audio codec is AAC。
* - `"pcmu"`: Reserved for future use.
* - `"pcma"`: Reserved for future use.
* - `"g722"`: Reserved for future use.
*
* > Firefox does not support this property.
*/
codecType?: "opus" | "aac" | "PCMU" | "PCMA" | "G722";
/**
* End-to-end delay (ms).
*
* The delay (ms) between a remote client sampling the audio and the local client playing the audio.
* This delay does not include the time spent in encoding at the remote client and the time spent in decoding at the local client.
*/
end2EndDelay: number;
/**
* The bitrate (bps) of the received audio.
*/
receiveBitrate: number;
/**
* The energy level of the received audio.
*
* The value range is [0,32767].
*
* > This value is retrieved by calling WebRTC-Stats and may not be up-to-date. To get the real-time sound volume, call [RemoteAudioTrack.getVolumeLevel]{@link IRemoteAudioTrack.getVolumeLevel}.
*/
receiveLevel: number;
/**
* The total bytes of the received audio.
*/
receiveBytes: number;
/**
* The delay (ms) between a remote client sending the audio and the local client playing the audio.
*
* > This property is inaccurate on Safari and Firefox.
*/
receiveDelay: number;
/**
* The total packets of the received audio.
*/
receivePackets: number;
/**
* The total number of lost audio packets that should be received.
*/
receivePacketsLost: number;
/**
* The number of packets discarded by the jitter buffer due to early or late arrival.
*/
receivePacketsDiscarded: number;
/**
* The packet loss rate of the received audio.
*/
packetLossRate: number;
/**
* The packet loss rate of the received audio.
*/
currentPacketLossRate: number;
/**
* The total duration of the received audio in seconds.
*/
totalDuration: number;
/**
* The total freeze time of the received audio in seconds.
*/
totalFreezeTime: number;
/**
* The freeze rate of the received audio.
*/
freezeRate: number;
publishDuration: number;
}
/**
* The stream fallback option. Set the stream fallback option when calling [setStreamFallbackOption]{@link IAgoraRTCClient.setStreamFallbackOption}.
*
*/
export declare enum RemoteStreamFallbackType {
/**
* 0: Disable the fallback.
*/
DISABLE = 0,
/**
* 1: Automatically subscribe to the low-video stream under poor network conditions. */
LOW_STREAM = 1,
/**
* 2: Subscribe to the low-quality video stream when the network conditions worsen, and subscribe to audio only when the conditions become too poor to support video transmission.
*/
AUDIO_ONLY = 2,
HIGH_STREAM_LAYER1 = 3,
HIGH_STREAM_LAYER2 = 4,
HIGH_STREAM_LAYER3 = 5,
HIGH_STREAM_LAYER4 = 6,
HIGH_STREAM_LAYER5 = 7,
HIGH_STREAM_LAYER6 = 8
}
/**
* The video type of the remote stream. Set the video type of the remote stream when calling [setRemoteVideoStreamType]{@link IAgoraRTCClient.setRemoteVideoStreamType}.
*/
export declare enum RemoteStreamType {
/**
* 0: High-quality video stream (high-bitrate, high-resolution).
*/
HIGH_STREAM = 0,
/**
* 1: Low-quality video stream (low-bitrate, low-resolution).
*/
LOW_STREAM = 1,
HIGH_STREAM_LAYER1 = 4,
HIGH_STREAM_LAYER2 = 5,
HIGH_STREAM_LAYER3 = 6,
HIGH_STREAM_LAYER4 = 7,
HIGH_STREAM_LAYER5 = 8,
HIGH_STREAM_LAYER6 = 9
}
/**
* Statistics of the remote video track, such as connection and transmission statistics, which can be retrieved by calling [AgoraRTCClient.getRemoteVideoStats]{@link IAgoraRTCClient.getRemoteVideoStats}.
*/
export declare interface RemoteVideoTrackStats {
/**
* Transmission delay (ms).
*
* The delay (ms) between a remote client sending the video and the local client receiving the video.
*/
transportDelay: number;
/**
* The video codec.
*
* - `"H264"`: The video codec is H.264.
* - `"VP8"`: The video codec is VP8.
* - `"VP9"`: The video codec is VP9.
* - `"AV1X"`: Reserved for future use.
* - `"AV1"`: The video codec is AV1.
*
* > You can not get this property on Firefox.
*/
codecType?: "H264" | "H265" | "VP8" | "VP9" | "AV1X" | "AV1";
/**
* End-to-end delay (ms).
*
* The delay (ms) a remote client capturing the video and the local client playing the video.
* This delay does not include the time spent in encoding at the remote client and the time spent in decoding at the local client.
*/
end2EndDelay: number;
/**
* The bitrate (bps) of the received video.
*/
receiveBitrate: number;
/**
* The delay (ms) between a remote client sending the video and the local client playing the video.
*
* > This property is inaccurate on Safari and Firefox.
*/
receiveDelay: number;
/**
* The total byes of the received video.
*/
receiveBytes: number;
/**
* The frame rate (fps) of the decoded video.
*/
decodeFrameRate?: number;
/**
* The frame rate (fps) of the received video.
*/
receiveFrameRate?: number;
/**
* The rendering frame rate (fps) of the decoded video.
*/
renderFrameRate?: number;
/**
* The total bytes of the received video.
*/
receivePackets: number;
/**
* The total number of lost video packets that should be received.
*/
receivePacketsLost: number;
/**
* The packet loss rate of the received video.
*/
packetLossRate: number;
/**
* The packet loss rate of the received video.
*/
currentPacketLossRate: number;
/**
* The resolution height (pixel) of the received video.
*/
receiveResolutionHeight: number;
/**
* The resolution width (pixel) of the received video.
*/
receiveResolutionWidth: number;
/**
* The total duration of the received video in seconds.
*/
totalDuration: number;
/**
* The total freeze time of the received video in seconds.
*/
totalFreezeTime: number;
/**
* The freeze rate of the received video.
*/
freezeRate: number;
publishDuration: number;
}
declare type RequiredOnlyOneOf = {
[P in K]: {
[S in P]: T[S];
} & {
[U in keyof Omit]?: never;
};
}[K] extends infer O ? {
[K in keyof O]: O[K];
} : never;
/**
* @ignore
*/
declare interface RetryConfiguration {
timeout: number;
timeoutFactor: number;
maxRetryCount: number;
maxRetryTimeout: number;
}
declare interface RTMConfiguration {
apRTM: boolean;
rtmFlag: number;
}
/**
* The preset video encoder configurations for screen sharing.
*
* You can pass the preset video encoder configurations when calling [AgoraRTC.createScreenVideoTrack]{@link IAgoraRTC.createScreenVideoTrack}.
*
* The following table lists all the preset video profiles for screen sharing.
*
* | Video Profile | Resolution (Width×Height) | Frame Rate (fps) |
* | -------- | --------------- | ----------- |
* | "480p" | 640 × 480 | 5 |
* | "480p_1" | 640 × 480 | 5 |
* | "480p_2" | 640 × 480 | 30 |
* | "480p_3" | 640 × 480 | 15 |
* | "720p" | 1280 × 720 | 5 |
* | "720p_1" | 1280 × 720 | 5 |
* | "720p_2" | 1280 × 720 | 30 |
* | "720p_3" | 1280 × 720 | 15 |
* | "720p_auto" ① | 1280 × 720 | 30 |
* | "1080p" | 1920 × 1080 | 5 |
* | "1080p_1" | 1920 × 1080 | 5 |
* | "1080p_2" | 1920 × 1080 | 30 |
* | "1080p_3" | 1920 × 1080 | 15 |
*
* > ① `"720p_auto"` is only recommended to be set on Safari to ensure dynamic adjustment of the encoding resolution. For details, see the release notes.
*/
export declare type ScreenEncoderConfigurationPreset = keyof typeof SUPPORT_SCREEN_ENCODER_CONFIG_LIST;
/**
* The type of the source for screen sharing.
* - `"screen"`: Sharing the whole screen.
* - `"application"`: Sharing all windows of an app.
* - `"window"`: Sharing a window of an app.
*/
export declare type ScreenSourceType = "screen" | "window" | "application";
/**
* Configurations for the video track for screen sharing. Set these configurations when calling [AgoraRTC.createScreenVideoTrack]{@link IAgoraRTC.createScreenVideoTrack}.
*/
export declare interface ScreenVideoTrackInitConfig {
/**
* The video encoder configurations for screen sharing.
*
* You can set the video encoder configurations in either of the following ways:
* - Pass the preset video encoder configurations by using [[ScreenEncoderConfigurationPreset]].
* - Pass your customized video encoder configurations by using [[VideoEncoderConfiguration]].
* - Leave this property empty to use the SDK's default value, `"1080p_2"` (resolution: 1920 × 1080, frame rate: 30 fps, bitrate: 3000 Kbps).
*/
encoderConfig?: VideoEncoderConfiguration | ScreenEncoderConfigurationPreset;
/**
* The `sourceId` when you share the screen through Electron.
*/
electronScreenSourceId?: string;
/**
* The `extensionId` when you share the screen with a Chrome extension.
*/
extensionId?: string;
/**
*
* @deprecated from v4.17.1. Use {@link displaySurface} instead.
*
* The type of the source for screen sharing.
*/
screenSourceType?: ScreenSourceType;
/**
* @since
* ;
/**
* @ignore
*/
declare const SUPPORT_SVC_CONFIG_LIST: Record;
/**
* @ignore
*/
declare const SUPPORT_VIDEO_ENCODER_CONFIG_LIST: Record;
/**
* @ignore
* @since
* ① | 1280 × 720 | 30 | ✓ | ✓ | ✓ |
* | 720p_5 | 960 × 720 | 15 | ✓ | ✓ | ✓ |
* | 720p_6 | 960 × 720 | 30 | ✓ | ✓ | ✓ |
* | 1080p | 1920 × 1080 | 15 | ✓ | | ✓ |
* | 1080p_1 | 1920 × 1080 | 15 | ✓ | | ✓ |
* | 1080p_2 | 1920 × 1080 | 30 | ✓ | | ✓ |
* | 1080p_3 | 1920 × 1080 | 30 | ✓ | | ✓ |
* | 1080p_5 | 1920 × 1080 | 60 | ✓ | | ✓ |
*
* > ① `"720p_auto"` is only recommended to be set on Safari to ensure dynamic adjustment of the encoding resolution. For details, see the release notes.
*/
export declare type VideoEncoderConfigurationPreset = keyof typeof SUPPORT_VIDEO_ENCODER_CONFIG_LIST;
/**
* Playback configurations for a video track. Set the playback configurations for a video track when calling [ILocalVideoTrack.play]{@link ILocalVideoTrack.play}.
*/
export declare interface VideoPlayerConfig {
/**
* Sets whether to enable mirror mode:
* - `true`: Enable mirror mode.
* - `false`: Disable mirror mode.
*
* > Notes:
* > - The SDK enables mirror mode for the local video track by default.
* > - The SDK disables mirror mode for the remote video track by default.
*/
mirror?: boolean;
/**
* Sets video display mode:
* - `"cover"`: The image files the height and width of the box, while maintaining its aspect ratio but often cropping the image in the process. For more information, see the `cover` option of `object-fit` in CSS.
* - `"contain"`: The size of the image increases or decreases to fill the box while preserving its aspect-ratio. Areas that are not filled due to the disparity in the aspect ratio are filled with black. For more information, see the `contain` option of `object-fit` in CSS.
* - `"fill"`: The image stretches to fit the box, regardless of its aspect-ratio. For more information, see the `fill` option of `object-fit` in CSS.
*
* > Notes:
* > - When playing the local camera video track, the SDK uses cover mode by default; when playing the local video track of screen sharing, the SDK uses contain mode by default.
* > - When playing the remote video track, the SDK uses cover mode by default.
*/
fit?: "cover" | "contain" | "fill";
}
/**
* The state of the video stream.
*/
export declare enum VideoState {
/**
* 0: The initial state of the video.
*/
VideoStateStopped = 0,
/**
* 1: The local user has received the first video packet.
*/
VideoStateStarting = 1,
/**
* 2: The video stream is being decoded and played normally.
*/
VideoStateDecoding = 2,
/**
* 3: The video stream is frozen.
*/
VideoStateFrozen = 3
}
/**
* @ignore
*/
declare enum VisibleHiddenReason {
COVERED = "COVERED",
POSITION = "POSITION",
SIZE = "SIZE",
STYLE = "STYLE"
}
declare interface VisibleHiddenResult {
visible: false;
reason: keyof typeof VisibleHiddenReason;
}
/**
* @ignore
*/
declare interface VisibleResultInner {
visible: true;
}
export { }