@agora-js/media 4.20.1 → 4.20.2-1

package/media.d.ts

@@ -803,7 +803,7 @@ export declare interface CameraVideoTrackInitConfig {
      */
     cameraId?: string;
     /**
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.0.0*
      *
      * 传输优化模式。设置该值后，SDK 会自动调整码率配置以及使用不同的回退策略。
@@ -818,7 +818,7 @@ export declare interface CameraVideoTrackInitConfig {
      * > 注意事项：该方法只支持 Chrome 浏览器。
      */
     /** @en
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.0.0*
      *
      * Transmission optimization mode. Whether to prioritize video quality or smoothness:
@@ -835,7 +835,7 @@ export declare interface CameraVideoTrackInitConfig {
     optimizationMode?: "motion" | "detail";
     /**
      * @ignore
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.18.0*
      *
      * SVC （可伸缩视频编码）配置。
@@ -845,7 +845,7 @@ export declare interface CameraVideoTrackInitConfig {
     /** @en
      * @ignore
      *
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.18.0*
      *
      * Configurations for Scalable Video Coding (SVC).
@@ -1002,7 +1002,7 @@ export declare interface CustomVideoTrackInitConfig {
      */
     mediaStreamTrack: MediaStreamTrack;
     /**
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.17.1*
      *
      * 视频的分辨率宽。
@@ -1012,7 +1012,7 @@ export declare interface CustomVideoTrackInitConfig {
      * 关于约束对象的详细说明可以参考 [ConstrainLong]{@link ConstrainLong}。
      */
     /** @en
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.17.1*
      *
      * Width of the video.
@@ -1023,7 +1023,7 @@ export declare interface CustomVideoTrackInitConfig {
      */
     width?: number | ConstrainLong;
     /**
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.17.1*
      *
      * 视频的分辨率高。
@@ -1033,7 +1033,7 @@ export declare interface CustomVideoTrackInitConfig {
      * 关于约束对象的详细说明可以参考 [ConstrainLong]{@link ConstrainLong}。
      */
     /** @en
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.17.1*
      *
      * Height of the video.
@@ -1044,7 +1044,7 @@ export declare interface CustomVideoTrackInitConfig {
      */
     height?: number | ConstrainLong;
     /**
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.17.1*
      *
      * 视频帧率，单位为 fps。
@@ -1054,7 +1054,7 @@ export declare interface CustomVideoTrackInitConfig {
      * 关于约束对象的详细说明可以参考 [ConstrainLong]{@link ConstrainLong}。
      */
     /** @en
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.17.1*
      *
      * Frame rate of the video (fps).
@@ -1079,7 +1079,7 @@ export declare interface CustomVideoTrackInitConfig {
      */
     bitrateMax?: number;
     /**
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.0.0*
      *
      * 传输优化模式。设置该值后，SDK 会自动调整码率配置以及使用不同的回退策略。
@@ -1094,7 +1094,7 @@ export declare interface CustomVideoTrackInitConfig {
      * > 注意事项：该方法只支持 Chrome 浏览器。
      */
     /** @en
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.0.0*
      *
      * Transmission optimization mode. Whether to prioritize video quality or smoothness:
@@ -1111,7 +1111,7 @@ export declare interface CustomVideoTrackInitConfig {
     optimizationMode?: "motion" | "detail";
     /**
      * @ignore
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.18.0*
      *
      * SVC （可伸缩视频编码）配置。
@@ -1121,7 +1121,7 @@ export declare interface CustomVideoTrackInitConfig {
     /** @en
      * @ignore
      *
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.18.0*
      *
      * Configurations for Scalable Video Coding (SVC).
@@ -1355,7 +1355,7 @@ declare function event_beauty_effect_overload(): void;
 declare function event_first_frame_decoded(): void;
 
 /**
- * **自从**
+ * @自从
  * <br>&emsp;&emsp;&emsp;*4.20.1*
  *
  * 从 H.264 视频流中解析出 SEI 数据时触发，此事件会返回 SEI 数据。
@@ -1365,7 +1365,7 @@ declare function event_first_frame_decoded(): void;
  * @event
  */
 /** @en
- * **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.
@@ -1500,7 +1500,7 @@ declare function event_user_datachannel_message(data: ArrayBuffer): void;
 declare function event_user_datachannel_open(): void;
 
 /**
- * **自从**
+ * @自从
  * <br>&emsp;&emsp;&emsp;*4.8.0*
  *
  * 提示 HTML `<video>` 标签的可见状态和不可见原因。SDK 每 30 秒触发一次该事件。
@@ -1512,7 +1512,7 @@ declare function event_user_datachannel_open(): void;
  * @event
  */
 /** @en
- * **Since**
+ * @since
  * <br>&emsp;&emsp;&emsp;*4.8.0*
  *
  * Indicates the visibility of the `<video>` HTML tag.
@@ -1528,7 +1528,7 @@ declare function event_user_datachannel_open(): void;
 declare function event_video_element_visible_status(data?: CheckVideoVisibleResult): void;
 
 /**
- * **自从**
+ * @自从
  * <br>&emsp;&emsp;&emsp;*4.8.0*
  *
  * 提示 HTML `<video>` 标签的可见状态和不可见原因。SDK 每 30 秒触发一次该事件。
@@ -1540,7 +1540,7 @@ declare function event_video_element_visible_status(data?: CheckVideoVisibleResu
  * @event
  */
 /** @en
- * **Since**
+ * @since
  * <br>&emsp;&emsp;&emsp;*4.8.0*
  *
  * Indicates the visibility of the `<video>` HTML tag.
@@ -1705,7 +1705,7 @@ export declare interface IBufferSourceAudioTrack extends ILocalAudioTrack {
      */
     duration: number;
     /**
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.18.0*
      *
      * 当前音频文件的播放速度。取值范围为 [50,400]，其中：
@@ -1714,7 +1714,7 @@ export declare interface IBufferSourceAudioTrack extends ILocalAudioTrack {
      * - `400`: 4 倍速。
      */
     /** @en
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.18.0*
      *
      * The playback speed of the current audio file. Valid range is [50, 400], where:
@@ -1805,7 +1805,7 @@ export declare interface IBufferSourceAudioTrack extends ILocalAudioTrack {
      */
     stopProcessAudioBuffer(): void;
     /**
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.18.0*
      *
      * 设置当前音频文件的播放速度。
@@ -1818,7 +1818,7 @@ export declare interface IBufferSourceAudioTrack extends ILocalAudioTrack {
      * - `400`: 4 倍速。
      */
     /** @en
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.18.0*
      *
      * Sets the playback speed for the current audio file.
@@ -1874,7 +1874,7 @@ export declare interface ICameraVideoTrack extends ILocalVideoTrack {
         deviceId: string;
     }>): Promise<void>;
     /**
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.0.0*
      *
      * 启用/禁用该轨道。
@@ -1890,7 +1890,7 @@ export declare interface ICameraVideoTrack extends ILocalVideoTrack {
      * - `false`: 禁用该轨道.
      */
     /** @en
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.0.0*
      *
      * Enables/Disables the track.
@@ -1907,7 +1907,7 @@ export declare interface ICameraVideoTrack extends ILocalVideoTrack {
      */
     setEnabled(enabled: boolean): Promise<void>;
     /**
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.19.0*
      *
      * 复制当前的视频轨道对象，生成一个新的视频轨道。
@@ -1919,7 +1919,7 @@ export declare interface ICameraVideoTrack extends ILocalVideoTrack {
      * @returns 新生成的视频轨道。
      */
     /** @en
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.19.0*
      *
      * Clones the current video track to create a new video track.
@@ -2065,7 +2065,7 @@ export declare interface ILocalAudioTrack extends ILocalTrack {
      */
     play(): void;
     /**
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.1.0*
      *
      * > 注意事项：
@@ -2076,7 +2076,7 @@ export declare interface ILocalAudioTrack extends ILocalTrack {
      * @param deviceId 设备 ID，可以通过 [[getPlaybackDevices]] 方法获取。
      */
     /** @en
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.1.0*
      *
      * > Note:
@@ -2090,17 +2090,17 @@ export declare interface ILocalAudioTrack extends ILocalTrack {
     /**
      * 获取本地音频轨道的质量相关信息。
      *
-     * **DEPRECATED**
+     * @deprecated
      * 自 v4.1.0 起废弃，请使用 [AgoraRTCClient.getLocalVideoStats]{@link IAgoraRTCClient.getLocalVideoStats} 和 [AgoraRTCClient.getLocalAudioStats]{@link IAgoraRTCClient.getLocalAudioStats}。
      */
     /** @en
      * 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;
     /**
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.10.0*
      *
      * 将 `Processor` 注入本地音频轨道。
@@ -2117,26 +2117,26 @@ export declare interface ILocalAudioTrack extends ILocalTrack {
      */
     pipe(processor: IAudioProcessor): IAudioProcessor;
     /**
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.10.0*
      *
      * 取消本地音频轨道上注入的 `Processor`。
      */
     /** @en
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.10.0*
      *
      * Removes the `Processor` inserted to the local audio track.
      */
     unpipe(): void;
     /**
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.10.0*
      *
      * 本地音频轨道上当前媒体处理链路的最终节点。
      */
     /** @en
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.10.0*
      *
      * The destination of the current processing pipeline on the local audio track.
@@ -2187,7 +2187,7 @@ export declare interface ILocalTrack extends ITrack {
      */
     on(event: "transceiver-updated", listener: typeof event_transceiver_updated): void;
     /**
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.0.0*
      *
      * 启用/禁用该轨道。
@@ -2203,7 +2203,7 @@ export declare interface ILocalTrack extends ITrack {
      * - `false`: 禁用该轨道。
      */
     /** @en
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.0.0*
      *
      * Enables/Disables the track.
@@ -2220,7 +2220,7 @@ export declare interface ILocalTrack extends ITrack {
      */
     setEnabled(enabled: boolean): Promise<void>;
     /**
-     * **DEPRECATED**
+     * @deprecated
      * 自 v4.1.0 起废弃，请使用 [AgoraRTCClient.getLocalVideoStats]{@link IAgoraRTCClient.getLocalVideoStats} 和 [AgoraRTCClient.getLocalAudioStats]{@link IAgoraRTCClient.getLocalAudioStats}。
      *
      * 获取本地轨道相关信息。
@@ -2228,7 +2228,7 @@ export declare interface ILocalTrack extends ITrack {
      * > 注意事项：获取本地视频轨道数据时，iOS 上无法获取到 `encodeDelay` 字段。
      */
     /** @en
-     * **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.
      *
@@ -2255,7 +2255,7 @@ export declare interface ILocalTrack extends ITrack {
     /**
      * 发送或暂停发送该轨道的媒体数据。
      *
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.6.0*
      *
      * 如果该轨道已发布，调用 `setMuted(true)` 后，远端会触发 [user-unpublished]{@link IAgoraRTCClient.event_user_unpublished} 事件。再调用 `setMuted(false)` 后，远端会触发 [user-published]{@link IAgoraRTCClient.event_user_published} 事件。
@@ -2270,7 +2270,7 @@ export declare interface ILocalTrack extends ITrack {
     /** @en
      * 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.
@@ -2370,18 +2370,18 @@ export declare interface ILocalVideoTrack extends ILocalTrack {
     /**
      * 获取本地视频轨道的相关信息。
      *
-     * **DEPRECATED**
+     * @deprecated
      * 自 v4.1.0 起废弃，请使用 [AgoraRTCClient.getLocalVideoStats]{@link IAgoraRTCClient.getLocalVideoStats} 和 [AgoraRTCClient.getLocalAudioStats]{@link IAgoraRTCClient.getLocalAudioStats}。
      *
      */
     /** @en
      * 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;
     /**
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.19.0*
      *
      * 复制当前的视频轨道对象，生成一个新的视频轨道。
@@ -2393,7 +2393,7 @@ export declare interface ILocalVideoTrack extends ILocalTrack {
      * @returns 新生成的视频轨道。
      */
     /** @en
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.19.0*
      *
      * Clones the current video track to create a new video track.
@@ -2447,7 +2447,7 @@ export declare interface ILocalVideoTrack extends ILocalTrack {
      */
     setBeautyEffect(enabled: boolean, options?: BeautyEffectOptions): Promise<void>;
     /**
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.1.0*
      *
      * 获取当前渲染的视频帧数据。
@@ -2457,7 +2457,7 @@ export declare interface ILocalVideoTrack extends ILocalTrack {
      * @returns 存储了 RGBA 数据的 `ImageData` 对象。该对象为浏览器原生对象，详见 [ImageData](https://developer.mozilla.org/zh-CN/docs/Web/API/ImageData)。
      */
     /** @en
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.1.0*
      *
      * Gets the data of the video frame being rendered.
@@ -2476,7 +2476,7 @@ export declare interface ILocalVideoTrack extends ILocalTrack {
      */
     getCurrentFrameImage(imageType: string, quality: number): Promise<ImageTypedData>;
     /**
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.2.0*
      *
      * 设置视频传输优化模式。
@@ -2497,7 +2497,7 @@ export declare interface ILocalVideoTrack extends ILocalTrack {
      *   - 大部分情况下，SDK 不会降低帧率，但是可能会降低发送分辨率。
      */
     /** @en
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.2.0*
      *
      * Sets the video transmission optimization mode.
@@ -2519,7 +2519,7 @@ export declare interface ILocalVideoTrack extends ILocalTrack {
      */
     setOptimizationMode(mode: "balanced" | "motion" | "detail"): Promise<void>;
     /**
-     * * **自从**
+     * * @自从
      * <br>&emsp;&emsp;&emsp;*4.8.0*
      *
      * 获取 HTML `<video>` 标签的可见状态和不可见原因。
@@ -2532,7 +2532,7 @@ export declare interface ILocalVideoTrack extends ILocalTrack {
      * - `<video>` 标签不是通过 `play` 方法调用产生的。
      */
     /** @en
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.8.0*
      *
      * Gets the visibility of the `<video>` HTML tag.
@@ -2546,7 +2546,7 @@ export declare interface ILocalVideoTrack extends ILocalTrack {
      */
     getVideoElementVisibleStatus(): CheckVideoVisibleResult | undefined;
     /**
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.10.0*
      *
      * 将 `Processor` 注入本地视频轨道。
@@ -2563,33 +2563,33 @@ export declare interface ILocalVideoTrack extends ILocalTrack {
      */
     pipe(processor: IBaseProcessor): IBaseProcessor;
     /**
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.10.0*
      *
      * 取消本地视频轨道上注入的 `Processor`。
      */
     /** @en
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.10.0*
      *
      * Removes the `Processor` inserted to the local video track.
      */
     unpipe(): void;
     /**
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.10.0*
      *
      * 本地视频轨道上当前媒体处理链路的最终节点。
      */
     /** @en
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.10.0*
      *
      * The destination of the current processing pipeline on the local video track.
      */
     processorDestination: IBaseProcessor;
     /**
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.17.0*
      *
      * 替换本地视频轨道。
@@ -2627,7 +2627,7 @@ export declare interface ILocalVideoTrack extends ILocalTrack {
      * - 保留原有的视频轨道。
      */
     /** @en
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.17.0*
      *
      * Replaces the local video track.
@@ -2721,7 +2721,7 @@ export declare interface IMicrophoneAudioTrack extends ILocalAudioTrack {
      */
     setDevice(deviceId: string): Promise<void>;
     /**
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.0.0*
      *
      * 启用/禁用该轨道。
@@ -2737,7 +2737,7 @@ export declare interface IMicrophoneAudioTrack extends ILocalAudioTrack {
      * - `false`: 禁用该轨道.
      */
     /** @en
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.0.0*
      *
      * Enables/Disables the track.
@@ -2801,7 +2801,7 @@ export declare interface IRemoteAudioTrack extends IRemoteTrack {
      */
     play(): void;
     /**
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.1.0*
      *
      * 设置音频播放设备，比如扬声器。
@@ -2810,7 +2810,7 @@ export declare interface IRemoteAudioTrack extends IRemoteTrack {
      * @param deviceId 设备 ID，可以通过 [[getPlaybackDevices]] 方法获取。
      */
     /** @en
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.1.0*
      *
      * Sets the audio playback device, for example, the speaker.
@@ -2891,7 +2891,7 @@ export declare interface IRemoteAudioTrack extends IRemoteTrack {
      */
     getVolumeLevel(): number;
     /**
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.13.0*
      *
      * 将 `Processor` 注入远端音频轨道。
@@ -2901,7 +2901,7 @@ export declare interface IRemoteAudioTrack extends IRemoteTrack {
      * @returns `Processor` 实例。
      */
     /** @en
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.13.0*
      *
      * Inserts a `Processor` to the remote audio track.
@@ -2912,26 +2912,26 @@ export declare interface IRemoteAudioTrack extends IRemoteTrack {
      */
     pipe(processor: IAudioProcessor): IAudioProcessor;
     /**
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.13.0*
      *
      * 取消远端音频轨道上注入的 `Processor`。
      */
     /** @en
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.13.0*
      *
      * Removes the `Processor` inserted to the remote audio track.
      */
     unpipe(): void;
     /**
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.13.0*
      *
      * 远端音频轨道上当前媒体处理链路的最终节点。
      */
     /** @en
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.13.0*
      *
      * The destination of the current processing pipeline on the remote audio track.
@@ -2995,7 +2995,7 @@ export declare interface IRemoteTrack extends ITrack {
     /**
      * 获取远端轨道相关信息。
      *
-     * **DEPRECATED**
+     * @deprecated
      *
      * 自 v4.1.0 起废弃，请使用 [AgoraRTCClient.getRemoteVideoStats]{@link IAgoraRTCClient.getRemoteVideoStats} 和 [AgoraRTCClient.getRemoteAudioStats]{@link IAgoraRTCClient.getRemoteAudioStats}。
      * @return [[RemoteAudioTrackStats]] 或 [[RemoteVideoTrackStats]] 对象。
@@ -3003,7 +3003,7 @@ export declare interface IRemoteTrack extends ITrack {
     /** @en
      * 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;
@@ -3099,7 +3099,7 @@ export declare interface IRemoteVideoTrack extends IRemoteTrack {
      */
     play(element: string | HTMLElement, config?: VideoPlayerConfig): void;
     /**
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.1.0*
      *
      * 获取当前渲染的视频帧数据。
@@ -3109,7 +3109,7 @@ export declare interface IRemoteVideoTrack extends IRemoteTrack {
      * @returns 存储了 RGBA 数据的 `ImageData` 对象。该对象为浏览器原生对象，详见 [ImageData](https://developer.mozilla.org/zh-CN/docs/Web/API/ImageData)。
      */
     /** @en
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.1.0*
      *
      * Gets the data of the video frame being rendered.
@@ -3120,7 +3120,7 @@ export declare interface IRemoteVideoTrack extends IRemoteTrack {
      */
     getCurrentFrameData(): ImageData;
     /**
-     * * **自从**
+     * * @自从
      * <br>&emsp;&emsp;&emsp;*4.8.0*
      *
      * 获取 HTML `<video>` 标签的可见状态和不可见原因。
@@ -3133,7 +3133,7 @@ export declare interface IRemoteVideoTrack extends IRemoteTrack {
      * - `<video>` 标签不是通过 `play` 方法调用产生的。
      */
     /** @en
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.8.0*
      *
      * Gets the visibility of the `<video>` HTML tag.
@@ -3147,7 +3147,7 @@ export declare interface IRemoteVideoTrack extends IRemoteTrack {
      */
     getVideoElementVisibleStatus(): CheckVideoVisibleResult | undefined;
     /**
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.13.0*
      *
      * 将 `Processor` 注入远端视频轨道。
@@ -3157,7 +3157,7 @@ export declare interface IRemoteVideoTrack extends IRemoteTrack {
      * @returns `Processor` 实例。
      */
     /** @en
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.13.0*
      *
      * Inserts a `Processor` to the remote video track.
@@ -3168,26 +3168,26 @@ export declare interface IRemoteVideoTrack extends IRemoteTrack {
      */
     pipe(processor: IBaseProcessor): IBaseProcessor;
     /**
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.13.0*
      *
      * 取消远端视频轨道上注入的 `Processor`。
      */
     /** @en
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.13.0*
      *
      * Removes the `Processor` inserted to the remote video track.
      */
     unpipe(): void;
     /**
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.13.0*
      *
      * 远端视频轨道上当前媒体处理链路的最终节点。
      */
     /** @en
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.13.0*
      *
      * The destination of the current processing pipeline on the remote video track.
@@ -4581,7 +4581,7 @@ export declare interface ScreenVideoTrackInitConfig {
      */
     extensionId?: string;
     /**
-     * **DEPRECATED**
+     * @deprecated
      *
      * 自 v4.17.1 起废弃，请改用 {@link displaySurface}。
      *
@@ -4589,13 +4589,13 @@ export declare interface ScreenVideoTrackInitConfig {
      */
     /** @en
      *
-     * **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;
     /**
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.0.0*
      *
      * 传输优化模式。设置该值后，SDK 会自动调整码率配置以及使用不同的回退策略。
@@ -4609,7 +4609,7 @@ export declare interface ScreenVideoTrackInitConfig {
      * > 注意事项：该方法只支持 Chrome 浏览器。
      */
     /** @en
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.0.0*
      *
      * Transmission optimization mode. Whether to prioritize video quality or smoothness:
@@ -4626,7 +4626,7 @@ export declare interface ScreenVideoTrackInitConfig {
     /**
      * @ignore
      *
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.18.0*
      *
      * SVC （可伸缩视频编码）配置。
@@ -4636,7 +4636,7 @@ export declare interface ScreenVideoTrackInitConfig {
     /** @en
      * @ignore
      *
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.18.0*
      *
      * Configurations for Scalable Video Coding (SVC).
@@ -4647,7 +4647,7 @@ export declare interface ScreenVideoTrackInitConfig {
      */
     scalabiltyMode?: SVCConfiguration | SVCConfigurationPreset;
     /**
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.17.1*
      *
      * 默认选中的共享内容类型，支持设为标签页、应用窗口（如下图）、或屏幕。详见 [displaySurface](https://developer.chrome.com/docs/web-platform/screen-sharing-controls/#displaySurface)。
@@ -4659,7 +4659,7 @@ export declare interface ScreenVideoTrackInitConfig {
      */
     /** @en
      *
-     * **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.
@@ -4668,7 +4668,7 @@ export declare interface ScreenVideoTrackInitConfig {
      */
     displaySurface?: "browser" | "window" | "monitor";
     /**
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.17.1*
      *
      * 是否允许用户共享当前标签页：
@@ -4683,7 +4683,7 @@ export declare interface ScreenVideoTrackInitConfig {
      */
     /** @en
      *
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.17.1*
      *
      * Whether to allow the user to share the current tab:
@@ -4698,7 +4698,7 @@ export declare interface ScreenVideoTrackInitConfig {
      */
     selfBrowserSurface?: "include" | "exclude";
     /**
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.17.1*
      *
      * 是否允许用户动态切换共享的标签页：
@@ -4711,7 +4711,7 @@ export declare interface ScreenVideoTrackInitConfig {
      */
     /** @en
      *
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.17.1*
      *
      * Whether to allow the user to dynamically switch between shared tabs:
@@ -4724,7 +4724,7 @@ export declare interface ScreenVideoTrackInitConfig {
      */
     surfaceSwitching?: "include" | "exclude";
     /**
-     * **自从**
+     * @自从
      * <br>&emsp;&emsp;&emsp;*4.17.1*
      *
      * 是否允许采集系统音频：
@@ -4737,7 +4737,7 @@ export declare interface ScreenVideoTrackInitConfig {
      */
     /** @en
      *
-     * **Since**
+     * @since
      * <br>&emsp;&emsp;&emsp;*4.17.1*
      *
      * Whether to capture system audio:
@@ -4802,7 +4802,7 @@ export declare const SUPPORT_VIDEO_ENCODER_CONFIG_LIST: Record<string, VideoEnco
 
 /**
  * @ignore
- * **自从**
+ * @自从
  * <br>&emsp;&emsp;&emsp;*4.18.0*
  *
  * 自定义的 SVC 编码配置。
@@ -4814,7 +4814,7 @@ export declare const SUPPORT_VIDEO_ENCODER_CONFIG_LIST: Record<string, VideoEnco
  */
 /** @en
  * @ignore
- * **Since**
+ * @since
  * <br>&emsp;&emsp;&emsp;*4.18.0*
  *
  * Custom SVC encoding configurations.
@@ -4844,7 +4844,7 @@ export declare interface SVCConfiguration {
 /**
  * @ignore
  *
- * **自从**
+ * @自从
  * <br>&emsp;&emsp;&emsp;*4.18.0*
  *
  * SDK 预设的 SVC 编码配置：
@@ -4861,7 +4861,7 @@ export declare interface SVCConfiguration {
 /** @en
  * @ignore
  *
- * **Since**
+ * @since
  * <br>&emsp;&emsp;&emsp;*4.18.0*
  *
  * The preset SVC configurations provided by the SDK.