@agora-js/media 4.20.1 → 4.20.2-1

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@agora-js/media",
-	"version": "4.20.1",
+	"version": "4.20.2-1",
 	"description": "media module across @agora-js packages",
 	"main": "AgoraRTC_N-media.js",
 	"module": "AgoraRTC_N-media.esm.mjs",
@@ -23,9 +23,9 @@
 	"homepage": "https://api-ref.agora.io/en/voice-sdk/web/4.x/index.html",
 	"peerDependencies": {},
 	"dependencies": {
-		"@agora-js/shared": "4.20.1",
-		"@agora-js/report": "4.20.1",
-		"axios": "^0.27.2",
+		"@agora-js/shared": "4.20.2-1",
+		"@agora-js/report": "4.20.2-1",
+		"axios": "^1.6.7",
 		"agora-rte-extension": "^1.2.4",
 		"webrtc-adapter": "8.2.0",
 		"pako": "^2.1.0"

package/rtc-sdk-media_en.d.ts

@@ -533,7 +533,7 @@ export declare interface CameraVideoTrackInitConfig {
      */
     cameraId?: string;
     /**
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.0.0*
      *
      * Transmission optimization mode. Whether to prioritize video quality or smoothness:
@@ -551,7 +551,7 @@ export declare interface CameraVideoTrackInitConfig {
     /**
      * @ignore
      *
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.18.0*
      *
      * Configurations for Scalable Video Coding (SVC).
@@ -657,7 +657,7 @@ export declare interface CustomVideoTrackInitConfig {
      */
     mediaStreamTrack: MediaStreamTrack;
     /**
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.17.1*
      *
      * Width of the video.
@@ -668,7 +668,7 @@ export declare interface CustomVideoTrackInitConfig {
      */
     width?: number | ConstrainLong;
     /**
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.17.1*
      *
      * Height of the video.
@@ -679,7 +679,7 @@ export declare interface CustomVideoTrackInitConfig {
      */
     height?: number | ConstrainLong;
     /**
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.17.1*
      *
      * Frame rate of the video (fps).
@@ -698,7 +698,7 @@ export declare interface CustomVideoTrackInitConfig {
      */
     bitrateMax?: number;
     /**
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.0.0*
      *
      * Transmission optimization mode. Whether to prioritize video quality or smoothness:
@@ -716,7 +716,7 @@ export declare interface CustomVideoTrackInitConfig {
     /**
      * @ignore
      *
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.18.0*
      *
      * Configurations for Scalable Video Coding (SVC).
@@ -897,7 +897,7 @@ declare function event_beauty_effect_overload(): void;
 declare function event_first_frame_decoded(): void;
 
 /**
- * **Since**
+ * @since
  * <br>&emsp;&emsp;&emsp;*4.20.1*
  *
  * Parsing SEI data from the H.264 video stream triggers this event, which returns the SEI data.
@@ -980,7 +980,7 @@ declare function event_user_datachannel_message(data: ArrayBuffer): void;
 declare function event_user_datachannel_open(): void;
 
 /**
- * **Since**
+ * @since
  * <br>&emsp;&emsp;&emsp;*4.8.0*
  *
  * Indicates the visibility of the `<video>` HTML tag.
@@ -996,7 +996,7 @@ declare function event_user_datachannel_open(): void;
 declare function event_video_element_visible_status(data?: CheckVideoVisibleResult): void;
 
 /**
- * **Since**
+ * @since
  * <br>&emsp;&emsp;&emsp;*4.8.0*
  *
  * Indicates the visibility of the `<video>` HTML tag.
@@ -1128,7 +1128,7 @@ export declare interface IBufferSourceAudioTrack extends ILocalAudioTrack {
      */
     duration: number;
     /**
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.18.0*
      *
      * The playback speed of the current audio file. Valid range is [50, 400], where:
@@ -1183,7 +1183,7 @@ export declare interface IBufferSourceAudioTrack extends ILocalAudioTrack {
      */
     stopProcessAudioBuffer(): void;
     /**
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.18.0*
      *
      * Sets the playback speed for the current audio file.
@@ -1223,7 +1223,7 @@ export declare interface ICameraVideoTrack extends ILocalVideoTrack {
         deviceId: string;
     }>): Promise<void>;
     /**
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.0.0*
      *
      * Enables/Disables the track.
@@ -1240,7 +1240,7 @@ export declare interface ICameraVideoTrack extends ILocalVideoTrack {
      */
     setEnabled(enabled: boolean): Promise<void>;
     /**
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.19.0*
      *
      * Clones the current video track to create a new video track.
@@ -1332,7 +1332,7 @@ export declare interface ILocalAudioTrack extends ILocalTrack {
      */
     play(): void;
     /**
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.1.0*
      *
      * > Note:
@@ -1346,7 +1346,7 @@ export declare interface ILocalAudioTrack extends ILocalTrack {
     /**
      * 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.
+     * @deprecated from v4.1.0. Use [AgoraRTCClient.getLocalVideoStats]{@link IAgoraRTCClient.getLocalVideoStats} and [AgoraRTCClient.getLocalAudioStats]{@link IAgoraRTCClient.getLocalAudioStats} instead.
      */
     getStats(): LocalAudioTrackStats;
     /**
@@ -1358,14 +1358,14 @@ export declare interface ILocalAudioTrack extends ILocalTrack {
      */
     pipe(processor: IAudioProcessor): IAudioProcessor;
     /**
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.10.0*
      *
      * Removes the `Processor` inserted to the local audio track.
      */
     unpipe(): void;
     /**
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.10.0*
      *
      * The destination of the current processing pipeline on the local audio track.
@@ -1402,7 +1402,7 @@ export declare interface ILocalTrack extends ITrack {
      */
     on(event: "transceiver-updated", listener: typeof event_transceiver_updated): void;
     /**
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.0.0*
      *
      * Enables/Disables the track.
@@ -1419,7 +1419,7 @@ export declare interface ILocalTrack extends ITrack {
      */
     setEnabled(enabled: boolean): Promise<void>;
     /**
-     * **DEPRECATED** from v4.1.0. Use [AgoraRTCClient.getLocalVideoStats]{@link IAgoraRTCClient.getLocalVideoStats} and [AgoraRTCClient.getLocalAudioStats]{@link IAgoraRTCClient.getLocalAudioStats} instead.
+     * @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.
      *
@@ -1438,7 +1438,7 @@ export declare interface ILocalTrack extends ITrack {
     /**
      * Sends or stops sending the media data of the track.
      *
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.6.0*
      *
      * If the track is published, a successful call of `setMuted(true)` triggers the [user-unpublished]{@link IAgoraRTCClient.event_user_unpublished} event on the remote client, and a successful call of `setMuted(false)` triggers the [user-published]{@link IAgoraRTCClient.event_user_published} event.
@@ -1499,11 +1499,11 @@ export declare interface ILocalVideoTrack extends ILocalTrack {
     /**
      * 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.
+     * @deprecated from v4.1.0. Use [AgoraRTCClient.getLocalVideoStats]{@link IAgoraRTCClient.getLocalVideoStats} and [AgoraRTCClient.getLocalAudioStats]{@link IAgoraRTCClient.getLocalAudioStats} instead.
      */
     getStats(): LocalVideoTrackStats;
     /**
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.19.0*
      *
      * Clones the current video track to create a new video track.
@@ -1538,7 +1538,7 @@ export declare interface ILocalVideoTrack extends ILocalTrack {
      */
     setBeautyEffect(enabled: boolean, options?: BeautyEffectOptions): Promise<void>;
     /**
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.1.0*
      *
      * Gets the data of the video frame being rendered.
@@ -1554,7 +1554,7 @@ export declare interface ILocalVideoTrack extends ILocalTrack {
      */
     getCurrentFrameImage(imageType: string, quality: number): Promise<ImageTypedData>;
     /**
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.2.0*
      *
      * Sets the video transmission optimization mode.
@@ -1576,7 +1576,7 @@ export declare interface ILocalVideoTrack extends ILocalTrack {
      */
     setOptimizationMode(mode: "balanced" | "motion" | "detail"): Promise<void>;
     /**
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.8.0*
      *
      * Gets the visibility of the `<video>` HTML tag.
@@ -1598,21 +1598,21 @@ export declare interface ILocalVideoTrack extends ILocalTrack {
      */
     pipe(processor: IBaseProcessor): IBaseProcessor;
     /**
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.10.0*
      *
      * Removes the `Processor` inserted to the local video track.
      */
     unpipe(): void;
     /**
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.10.0*
      *
      * The destination of the current processing pipeline on the local video track.
      */
     processorDestination: IBaseProcessor;
     /**
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.17.0*
      *
      * Replaces the local video track.
@@ -1684,7 +1684,7 @@ export declare interface IMicrophoneAudioTrack extends ILocalAudioTrack {
      */
     setDevice(deviceId: string): Promise<void>;
     /**
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.0.0*
      *
      * Enables/Disables the track.
@@ -1733,7 +1733,7 @@ export declare interface IRemoteAudioTrack extends IRemoteTrack {
      */
     play(): void;
     /**
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.1.0*
      *
      * Sets the audio playback device, for example, the speaker.
@@ -1781,7 +1781,7 @@ export declare interface IRemoteAudioTrack extends IRemoteTrack {
      */
     getVolumeLevel(): number;
     /**
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.13.0*
      *
      * Inserts a `Processor` to the remote audio track.
@@ -1792,14 +1792,14 @@ export declare interface IRemoteAudioTrack extends IRemoteTrack {
      */
     pipe(processor: IAudioProcessor): IAudioProcessor;
     /**
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.13.0*
      *
      * Removes the `Processor` inserted to the remote audio track.
      */
     unpipe(): void;
     /**
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.13.0*
      *
      * The destination of the current processing pipeline on the remote audio track.
@@ -1845,7 +1845,7 @@ export declare interface IRemoteTrack extends ITrack {
     /**
      * Gets the statistics of a remote track.
      *
-     * **DEPRECATED** from v4.1.0. Use [AgoraRTCClient.getRemoteVideoStats]{@link IAgoraRTCClient.getRemoteVideoStats} and [AgoraRTCClient.getRemoteAudioStats]{@link IAgoraRTCClient.getRemoteAudioStats} instead.
+     * @deprecated from v4.1.0. Use [AgoraRTCClient.getRemoteVideoStats]{@link IAgoraRTCClient.getRemoteVideoStats} and [AgoraRTCClient.getRemoteAudioStats]{@link IAgoraRTCClient.getRemoteAudioStats} instead.
      * @return An [[RemoteAudioTrackStats]] or [[RemoteVideoTrackStats]] object.
      */
     getStats(): RemoteAudioTrackStats | RemoteVideoTrackStats;
@@ -1900,7 +1900,7 @@ export declare interface IRemoteVideoTrack extends IRemoteTrack {
      */
     play(element: string | HTMLElement, config?: VideoPlayerConfig): void;
     /**
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.1.0*
      *
      * Gets the data of the video frame being rendered.
@@ -1911,7 +1911,7 @@ export declare interface IRemoteVideoTrack extends IRemoteTrack {
      */
     getCurrentFrameData(): ImageData;
     /**
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.8.0*
      *
      * Gets the visibility of the `<video>` HTML tag.
@@ -1925,7 +1925,7 @@ export declare interface IRemoteVideoTrack extends IRemoteTrack {
      */
     getVideoElementVisibleStatus(): CheckVideoVisibleResult | undefined;
     /**
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.13.0*
      *
      * Inserts a `Processor` to the remote video track.
@@ -1936,14 +1936,14 @@ export declare interface IRemoteVideoTrack extends IRemoteTrack {
      */
     pipe(processor: IBaseProcessor): IBaseProcessor;
     /**
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.13.0*
      *
      * Removes the `Processor` inserted to the remote video track.
      */
     unpipe(): void;
     /**
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.13.0*
      *
      * The destination of the current processing pipeline on the remote video track.
@@ -2852,13 +2852,13 @@ export declare interface ScreenVideoTrackInitConfig {
     extensionId?: string;
     /**
      *
-     * **DEPRECATED** from v4.17.1. Use {@link displaySurface} instead.
+     * @deprecated from v4.17.1. Use {@link displaySurface} instead.
      *
      * The type of the source for screen sharing.
      */
     screenSourceType?: ScreenSourceType;
     /**
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.0.0*
      *
      * Transmission optimization mode. Whether to prioritize video quality or smoothness:
@@ -2875,7 +2875,7 @@ export declare interface ScreenVideoTrackInitConfig {
     /**
      * @ignore
      *
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.18.0*
      *
      * Configurations for Scalable Video Coding (SVC).
@@ -2887,7 +2887,7 @@ export declare interface ScreenVideoTrackInitConfig {
     scalabiltyMode?: SVCConfiguration | SVCConfigurationPreset;
     /**
      *
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.17.1*
      *
      * The pre-selected pane in the media picker. See [displaySurface](https://developer.chrome.com/docs/web-platform/screen-sharing-controls/#displaySurface) for details.
@@ -2897,7 +2897,7 @@ export declare interface ScreenVideoTrackInitConfig {
     displaySurface?: "browser" | "window" | "monitor";
     /**
      *
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.17.1*
      *
      * Whether to allow the user to share the current tab:
@@ -2913,7 +2913,7 @@ export declare interface ScreenVideoTrackInitConfig {
     selfBrowserSurface?: "include" | "exclude";
     /**
      *
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.17.1*
      *
      * Whether to allow the user to dynamically switch between shared tabs:
@@ -2927,7 +2927,7 @@ export declare interface ScreenVideoTrackInitConfig {
     surfaceSwitching?: "include" | "exclude";
     /**
      *
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.17.1*
      *
      * Whether to capture system audio:
@@ -2987,7 +2987,7 @@ export declare const SUPPORT_VIDEO_ENCODER_CONFIG_LIST: Record<string, VideoEnco
 
 /**
  * @ignore
- * **Since**
+ * @since
  * <br>&emsp;&emsp;&emsp;*4.18.0*
  *
  * Custom SVC encoding configurations.
@@ -3011,7 +3011,7 @@ export declare interface SVCConfiguration {
 /**
  * @ignore
  *
- * **Since**
+ * @since
  * <br>&emsp;&emsp;&emsp;*4.18.0*
  *
  * The preset SVC configurations provided by the SDK.