agora-electron-sdk 4.2.2 → 4.2.3-dev.3

package/ts/Private/IAgoraRtcEngine.ts

@@ -1022,7 +1022,7 @@ export class AdvancedAudioOptions {
  */
 export class ImageTrackOptions {
   /**
-   * The URL of the image that you want to use to replace the video feeds. The image must be in PNG format. This method supports adding an image from the local absolute or relative file path.
+   * The image URL. Supported formats of images include JPEG, JPG, PNG and GIF. This method supports adding an image from the local absolute or relative file path.
    */
   imageUrl?: string;
   /**
@@ -1038,7 +1038,7 @@ export class ImageTrackOptions {
 /**
  * The channel media options.
  *
- * Agora supports publishing multiple audio streams and one video stream at the same time and in the same RtcConnection. For example, publishMicrophoneTrack, publishAudioTrack, publishCustomAudioTrack, and publishMediaPlayerAudioTrack can be set as true at the same time, but only one of publishCameraTrack, publishScreenTrack, publishCustomVideoTrack, or publishEncodedVideoTrack can be set as true. Agora recommends that you set member parameter values yourself according to your business scenario, otherwise the SDK will automatically assign values to member parameters.
+ * Agora supports publishing multiple audio streams and one video stream at the same time and in the same RtcConnection. For example, publishMicrophoneTrack, publishCustomAudioTrack, and publishMediaPlayerAudioTrack can be set as true at the same time, but only one of publishCameraTrack, publishScreenTrack, publishCustomVideoTrack, or publishEncodedVideoTrack can be set as true. Agora recommends that you set member parameter values yourself according to your business scenario, otherwise the SDK will automatically assign values to member parameters.
  */
 export class ChannelMediaOptions {
   /**
@@ -1217,6 +1217,20 @@ export enum ProxyType {
   HttpsProxyType = 6,
 }
 
+/**
+ * @ignore
+ */
+export enum FeatureType {
+  /**
+   * @ignore
+   */
+  VideoVirtualBackground = 1,
+  /**
+   * @ignore
+   */
+  VideoBeautyEffect = 2,
+}
+
 /**
  * The options for leaving a channel.
  */
@@ -1267,7 +1281,7 @@ export interface IRtcEngineEventHandler {
    *
    * @param channel The channel name.
    * @param uid The user ID.
-   * @param proxyType The proxy type connected. See CloudProxyType.
+   * @param proxyType The proxy type connected. See ProxyType.
    * @param localProxyIp Reserved for future use.
    * @param elapsed The time elapsed (ms) from the user calling joinChannel until this callback is triggered.
    */
@@ -1878,7 +1892,7 @@ export interface IRtcEngineEventHandler {
    *
    * When the token expires during a call, the SDK triggers this callback to remind the app to renew the token. When receiving this callback, you need to generate a new token on your token server and you can renew your token through one of the following ways:
    *  Call renewToken to pass in the new token.
-   *  Call to leave the current channel and then pass in the new token when you call joinChannel to join a channel.
+   *  Call leaveChannel to leave the current channel and then pass in the new token when you call joinChannel to join a channel.
    *
    * @param connection The connection information. See RtcConnection.
    */
@@ -2051,7 +2065,7 @@ export interface IRtcEngineEventHandler {
   /**
    * Occurs when the user role switching fails in the interactive live streaming.
    *
-   * In the live broadcasting channel profile, when the local user calls to switch the user role after joining the channel but the switch fails, the SDK triggers this callback to report the reason for the failure and the current user role.
+   * In the live broadcasting channel profile, when the local user calls setClientRole to switch the user role after joining the channel but the switch fails, the SDK triggers this callback to report the reason for the failure and the current user role.
    *
    * @param connection The connection information. See RtcConnection.
    * @param reason The reason for a user role switch failure. See ClientRoleChangeFailedReason.
@@ -2899,7 +2913,7 @@ export abstract class IRtcEngine {
    * @param token The token generated on your server for authentication. When the token for preloading channels expires, you can update the token based on the number of channels you preload.
    *  When preloading one channel, calling this method to pass in the new token.
    *  When preloading more than one channels:
-   *  If you use a wildcard token for all preloaded channels, call updatePreloadChannelToken to update the token.
+   *  If you use a wildcard token for all preloaded channels, call updatePreloadChannelToken to update the token. When generating a wildcard token, ensure the user ID is not set as 0.
    *  If you use different tokens to preload different channels, call this method to pass in your user ID, channel name and the new token.
    * @param channelId The channel name that you want to preload. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters (89 characters in total):
    *  All lowercase English letters: a to z.
@@ -2933,7 +2947,7 @@ export abstract class IRtcEngine {
    * @param token The token generated on your server for authentication. When the token for preloading channels expires, you can update the token based on the number of channels you preload.
    *  When preloading one channel, calling this method to pass in the new token.
    *  When preloading more than one channels:
-   *  If you use a wildcard token for all preloaded channels, call updatePreloadChannelToken to update the token.
+   *  If you use a wildcard token for all preloaded channels, call updatePreloadChannelToken to update the token. When generating a wildcard token, ensure the user ID is not set as 0.
    *  If you use different tokens to preload different channels, call this method to pass in your user ID, channel name and the new token.
    * @param channelId The channel name that you want to preload. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters (89 characters in total):
    *  All lowercase English letters: a to z.
@@ -2985,7 +2999,7 @@ export abstract class IRtcEngine {
    *  This method allows users to join only one channel at a time.
    *  Ensure that the app ID you use to generate the token is the same app ID that you pass in the initialize method; otherwise, you may fail to join the channel by token.
    *
-   * @param token The token generated on your server for authentication.
+   * @param token The token generated on your server for authentication. If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel.
    * @param channelId The channel name. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters:
    *  All lowercase English letters: a to z.
    *  All uppercase English letters: A to Z.
@@ -3060,7 +3074,7 @@ export abstract class IRtcEngine {
   /**
    * Sets the channel profile.
    *
-   * After initializing the SDK, the default channel profile is the live streaming profile. You can call this method to set the usage scenario of the channel. For example, it prioritizes smoothness and low latency for a video call, and prioritizes video quality for the interactive live video streaming.
+   * After initializing the SDK, the default channel profile is the live streaming profile. You can call this method to set the channel profile. The Agora SDK differentiates channel profiles and applies optimization algorithms accordingly. For example, it prioritizes smoothness and low latency for a video call and prioritizes video quality for interactive live video streaming.
    *  To ensure the quality of real-time communication, Agora recommends that all users in a channel use the same channel profile.
    *  This method must be called and set before joinChannel, and cannot be set again after joining the channel.
    *  The default video encoding bitrate are different in different channel profiles. See setVideoEncoderConfiguration.
@@ -3081,7 +3095,7 @@ export abstract class IRtcEngine {
    * In the interactive live streaming profile, the SDK sets the user role as audience by default. You can call this method to set the user role as host. You can call this method either before or after joining a channel. If you call this method to set the user's role as the host before joining the channel and set the local video property through the setupLocalVideo method, the local video preview is automatically enabled when the user joins the channel. If you call this method to switch the user role after joining a channel, the SDK automatically does the following:
    *  Calls muteLocalAudioStream and muteLocalVideoStream to change the publishing state.
    *  Triggers onClientRoleChanged on the local client.
-   *  Triggers onUserJoined or onUserOffline on the remote client. This method applies to the interactive live streaming profile (the profile parameter of setChannelProfile is ChannelProfileLiveBroadcasting) only.
+   *  Triggers onUserJoined or onUserOffline on the remote client. This method applies to the interactive live streaming profile (the profile parameter of setChannelProfile is set as ChannelProfileLiveBroadcasting) only.
    *
    * @param role The user role in the interactive live streaming. See ClientRoleType.
    * @param options The detailed options of a user, including the user level. See ClientRoleOptions.
@@ -3130,13 +3144,13 @@ export abstract class IRtcEngine {
    *
    * In scenarios where there are existing cameras to capture video, Agora recommends that you use the following steps to capture and publish video with multiple cameras:
    *  Call this method to enable multi-channel camera capture.
-   *  Call to start the local video preview.
+   *  Call startPreview to start the local video preview.
    *  Call startCameraCapture, and set sourceType to start video capture with the second camera.
    *  Call joinChannelEx, and set publishSecondaryCameraTrack to true to publish the video stream captured by the second camera in the channel. If you want to disable multi-channel camera capture, use the following steps:
    *  Call stopCameraCapture.
-   *  Call this method with enabled set to false. You can call this method before and after to enable multi-camera capture:
-   *  If it is enabled before, the local video preview shows the image captured by the two cameras at the same time.
-   *  If it is enabled after, the SDK stops the current camera capture first, and then enables the primary camera and the second camera. The local video preview appears black for a short time, and then automatically returns to normal. When using this function, ensure that the system version is 13.0 or later. The minimum iOS device types that support multi-camera capture are as follows:
+   *  Call this method with enabled set to false. You can call this method before and after startPreview to enable multi-camera capture:
+   *  If it is enabled before startPreview, the local video preview shows the image captured by the two cameras at the same time.
+   *  If it is enabled after startPreview, the SDK stops the current camera capture first, and then enables the primary camera and the second camera. The local video preview appears black for a short time, and then automatically returns to normal. When using this function, ensure that the system version is 13.0 or later. The minimum iOS device types that support multi-camera capture are as follows:
    *  iPhone XR
    *  iPhone XS
    *  iPhone XS Max
@@ -3257,12 +3271,14 @@ export abstract class IRtcEngine {
    * Sets the image enhancement options.
    *
    * Enables or disables image enhancement, and sets the options.
-   *  Call this method before calling enableVideo or.
+   *  Call this method before calling enableVideo or startPreview.
    *  This method relies on the video enhancement dynamic library libagora_clear_vision_extension.dll. If the dynamic library is deleted, the function cannot be enabled normally.
    *
    * @param enabled Whether to enable the image enhancement function: true : Enable the image enhancement function. false : (Default) Disable the image enhancement function.
    * @param options The image enhancement options. See BeautyOptions.
-   * @param type The type of the video source, see MediaSourceType.
+   * @param type Type of media source. See MediaSourceType. In this method, this parameter supports only the following two settings:
+   *  The default value is UnknownMediaSource.
+   *  If you want to use the second camera to capture video, set this parameter to SecondaryCameraSource.
    *
    * @returns
    * 0: Success.
@@ -3352,7 +3368,7 @@ export abstract class IRtcEngine {
   /**
    * Enables/Disables the virtual background.
    *
-   * The virtual background feature enables the local user to replace their original background with a static image, dynamic video, blurred background, or portrait-background segmentation to achieve picture-in-picture effect. Once the virtual background feature is enabled, all users in the channel can see the custom background. Call this method before calling enableVideo or.
+   * The virtual background feature enables the local user to replace their original background with a static image, dynamic video, blurred background, or portrait-background segmentation to achieve picture-in-picture effect. Once the virtual background feature is enabled, all users in the channel can see the custom background. Call this method before calling enableVideo or startPreview.
    *  This feature requires high performance devices. Agora recommends that you implement it on devices equipped with the following chips:
    *  Devices with an i5 CPU and better
    *  Agora recommends that you use this feature in scenarios that meet the following conditions:
@@ -4742,7 +4758,7 @@ export abstract class IRtcEngine {
    *
    * The SDK enables the low-quality video stream auto mode on the sender side by default (it does not actively sending low-quality video streams). The host identity receiver can initiate a low-quality video stream application at the receiving end by calling setRemoteVideoStreamType. After receiving the application, the sending end automatically switches to the low-quality video stream mode.
    *  If you want to modify this behavior, you can call this method and modify the mode to DisableSimulcastStream (never send low-quality video streams) or EnableSimulcastStream (always send low-quality video streams).
-   *  If you want to restore the default behavior after making changes, you can call this method again with mode set to AutoSimulcastStream. The difference and connection between this method and is as follows:
+   *  If you want to restore the default behavior after making changes, you can call this method again with mode set to AutoSimulcastStream. The difference and connection between this method and enableDualStreamMode is as follows:
    *  When calling this method and setting mode to DisableSimulcastStream, it has the same effect as calling and setting enabled to false.
    *  When calling this method and setting mode to EnableSimulcastStream, it has the same effect as calling and setting enabled to true.
    *  Both methods can be called before and after joining a channel. If both methods are used, the settings in the method called later takes precedence.
@@ -5170,7 +5186,9 @@ export abstract class IRtcEngine {
    * @param extension The name of the extension.
    * @param key The key of the extension.
    * @param value The value of the extension key.
-   * @param type The type of the video source, see MediaSourceType.
+   * @param type Type of media source. See MediaSourceType. In this method, this parameter supports only the following two settings:
+   *  The default value is UnknownMediaSource.
+   *  If you want to use the second camera to capture video, set this parameter to SecondaryCameraSource.
    *
    * @returns
    * 0: Success.
@@ -5638,8 +5656,7 @@ export abstract class IRtcEngine {
   /**
    * Starts pushing media streams to a CDN without transcoding.
    *
-   * Ensure that you enable the Media Push service before using this function. See Enable Media Push.
-   *  Call this method after joining a channel.
+   * Call this method after joining a channel.
    *  Only hosts in the LIVE_BROADCASTING profile can call this method.
    *  If you want to retry pushing streams after a failed push, make sure to call stopRtmpStream first, then call this method to retry pushing streams; otherwise, the SDK returns the same error code as the last failed push. Agora recommends that you use the server-side Media Push function. You can call this method to push an audio or video stream to the specified CDN address. This method can push media streams to only one CDN address at a time, so if you need to push streams to multiple addresses, call this method multiple times. After you call this method, the SDK triggers the onRtmpStreamingStateChanged callback on the local client to report the state of the streaming.
    *
@@ -5657,8 +5674,7 @@ export abstract class IRtcEngine {
   /**
    * Starts Media Push and sets the transcoding configuration.
    *
-   * Agora recommends that you use the server-side Media Push function. You can call this method to push a live audio-and-video stream to the specified CDN address and set the transcoding configuration. This method can push media streams to only one CDN address at a time, so if you need to push streams to multiple addresses, call this method multiple times. After you call this method, the SDK triggers the onRtmpStreamingStateChanged callback on the local client to report the state of the streaming.
-   *  Ensure that you enable the Media Push service before using this function. See Enable Media Push.
+   * Agora recommends that you use the server-side Media Push function. You can call this method to push a live audio-and-video stream to the specified CDN address and set the transcoding configuration. This method can push media streams to only one CDN address at a time, so if you need to push streams to multiple addresses, call this method multiple times. Under one Agora project, the maximum number of concurrent tasks to push media streams is 200 by default. If you need a higher quota, contact. After you call this method, the SDK triggers the onRtmpStreamingStateChanged callback on the local client to report the state of the streaming.
    *  Call this method after joining a channel.
    *  Only hosts in the LIVE_BROADCASTING profile can call this method.
    *  If you want to retry pushing streams after a failed push, make sure to call stopRtmpStream first, then call this method to retry pushing streams; otherwise, the SDK returns the same error code as the last failed push.
@@ -5780,6 +5796,7 @@ export abstract class IRtcEngine {
    * Sets the rotation angle of the captured video.
    *
    * This method applies to Windows only.
+   *  You must call this method after enableVideo. The setting result will take effect after the camera is successfully turned on, that is, after the SDK triggers the onLocalVideoStateChanged callback and returns the local video state as LocalVideoStreamStateCapturing (1).
    *  When the video capture device does not have the gravity sensing function, you can call this method to manually adjust the rotation angle of the captured video.
    *
    * @param type The video source type. See VideoSourceType.
@@ -6114,7 +6131,7 @@ export abstract class IRtcEngine {
    *  The local client: onLocalUserRegistered, onJoinChannelSuccess and onConnectionStateChanged callbacks.
    *  The remote client: The onUserJoined callback, if the user is in the COMMUNICATION profile, and the onUserInfoUpdated callback if the user is a host in the LIVE_BROADCASTING profile. Once a user joins the channel, the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billing calculation. To stop subscribing to a specified stream or all remote streams, call the corresponding mute methods. To ensure smooth communication, use the same parameter type to identify the user. For example, if a user joins the channel with a user ID, then ensure all the other users use the user ID too. The same applies to the user account. If a user joins the channel with the Agora Web SDK, ensure that the ID of the user is set to the same parameter type.
    *
-   * @param token The token generated on your server for authentication.
+   * @param token The token generated on your server for authentication. If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel.
    * @param channelId The channel name. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters:
    *  All lowercase English letters: a to z.
    *  All uppercase English letters: A to Z.
@@ -6154,7 +6171,7 @@ export abstract class IRtcEngine {
    *  The local client: onLocalUserRegistered, onJoinChannelSuccess and onConnectionStateChanged callbacks.
    *  The remote client: The onUserJoined callback, if the user is in the COMMUNICATION profile, and the onUserInfoUpdated callback if the user is a host in the LIVE_BROADCASTING profile. Once a user joins the channel, the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billing calculation. To stop subscribing to a specified stream or all remote streams, call the corresponding mute methods. To ensure smooth communication, use the same parameter type to identify the user. For example, if a user joins the channel with a user ID, then ensure all the other users use the user ID too. The same applies to the user account. If a user joins the channel with the Agora Web SDK, ensure that the ID of the user is set to the same parameter type.
    *
-   * @param token The token generated on your server for authentication.
+   * @param token The token generated on your server for authentication. If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel.
    * @param channelId The channel name. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters:
    *  All lowercase English letters: a to z.
    *  All uppercase English letters: A to Z.
@@ -6593,6 +6610,11 @@ export abstract class IRtcEngine {
    */
   abstract getNtpWallTimeInMs(): number;
 
+  /**
+   * @ignore
+   */
+  abstract isFeatureAvailableOnDevice(type: FeatureType): boolean;
+
   /**
    * Gets the IAudioDeviceManager object to manage audio devices.
    *

package/ts/Private/IAgoraRtcEngineEx.ts

@@ -16,7 +16,7 @@ import {
   VideoSubscriptionOptions,
   WatermarkOptions,
 } from './AgoraBase';
-import { RenderModeType } from './AgoraMediaBase';
+import { ContentInspectConfig, RenderModeType } from './AgoraMediaBase';
 import {
   ChannelMediaOptions,
   IRtcEngine,
@@ -52,7 +52,7 @@ export abstract class IRtcEngineEx extends IRtcEngine {
    *  If you want to join the same channel from different devices, ensure that the user IDs are different for all devices.
    *  Ensure that the app ID you use to generate the token is the same as the app ID used when creating the IRtcEngine instance.
    *
-   * @param token The token generated on your server for authentication.
+   * @param token The token generated on your server for authentication. If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel.
    * @param connection The connection information. See RtcConnection.
    * @param options The channel media options. See ChannelMediaOptions.
    *
@@ -78,7 +78,7 @@ export abstract class IRtcEngineEx extends IRtcEngine {
    *
    * This method lets the user leave the channel, for example, by hanging up or exiting the call. After calling joinChannelEx to join the channel, this method must be called to end the call before starting the next call. This method can be called whether or not a call is currently in progress. This method releases all resources related to the session. This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel. After you leave the channel, the SDK triggers the onLeaveChannel callback. After actually leaving the channel, the local user triggers the onLeaveChannel callback; after the user in the communication scenario and the host in the live streaming scenario leave the channel, the remote user triggers the onUserOffline callback.
    *  If you call release immediately after calling this method, the SDK does not trigger the onLeaveChannel callback.
-   *  Calling leaveChannel will leave the channels when calling joinChannel and joinChannelEx at the same time.
+   *  If you want to leave the channels that you joined by calling joinChannel and joinChannelEx, call the leaveChannel method.
    *
    * @param connection The connection information. See RtcConnection.
    * @param options The options for leaving the channel. See LeaveChannelOptions. This parameter only supports the stopMicrophoneRecording member in the LeaveChannelOptions settings; setting other members does not take effect.
@@ -522,7 +522,7 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Creates a data stream.
    *
-   * Creates a data stream. Each user can create up to five data streams in a single channel. Compared with createDataStreamEx, this method does not support data reliability. If a data packet is not received five seconds after it was sent, the SDK directly discards the data.
+   * Creates a data stream. Each user can create up to five data streams in a single channel.
    *
    * @param config The configurations for the data stream. See DataStreamConfig.
    * @param connection The connection information. See RtcConnection.
@@ -641,8 +641,7 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Starts pushing media streams to a CDN without transcoding.
    *
-   * Ensure that you enable the Media Push service before using this function. See Enable Media Push.
-   *  Call this method after joining a channel.
+   * Call this method after joining a channel.
    *  Only hosts in the LIVE_BROADCASTING profile can call this method.
    *  If you want to retry pushing streams after a failed push, make sure to call stopRtmpStream first, then call this method to retry pushing streams; otherwise, the SDK returns the same error code as the last failed push. Agora recommends that you use the server-side Media Push function. You can call this method to push an audio or video stream to the specified CDN address. This method can push media streams to only one CDN address at a time, so if you need to push streams to multiple addresses, call this method multiple times. After you call this method, the SDK triggers the onRtmpStreamingStateChanged callback on the local client to report the state of the streaming.
    *
@@ -918,6 +917,15 @@ export abstract class IRtcEngineEx extends IRtcEngine {
     filePath: string
   ): number;
 
+  /**
+   * @ignore
+   */
+  abstract enableContentInspectEx(
+    enabled: boolean,
+    config: ContentInspectConfig,
+    connection: RtcConnection
+  ): number;
+
   /**
    * Enables tracing the video frame rendering process.
    *

package/ts/Private/impl/IAgoraRtcEngineExImpl.ts

@@ -15,7 +15,7 @@ import {
   VideoSubscriptionOptions,
   WatermarkOptions,
 } from '../AgoraBase';
-import { RenderModeType } from '../AgoraMediaBase';
+import { ContentInspectConfig, RenderModeType } from '../AgoraMediaBase';
 import {
   ChannelMediaOptions,
   LeaveChannelOptions,
@@ -1494,6 +1494,40 @@ export class IRtcEngineExImpl extends IRtcEngineImpl implements IRtcEngineEx {
     return 'RtcEngineEx_takeSnapshotEx';
   }
 
+  enableContentInspectEx(
+    enabled: boolean,
+    config: ContentInspectConfig,
+    connection: RtcConnection
+  ): number {
+    const apiType = this.getApiTypeFromEnableContentInspectEx(
+      enabled,
+      config,
+      connection
+    );
+    const jsonParams = {
+      enabled: enabled,
+      config: config,
+      connection: connection,
+      toJSON: () => {
+        return {
+          enabled: enabled,
+          config: config,
+          connection: connection,
+        };
+      },
+    };
+    const jsonResults = callIrisApi.call(this, apiType, jsonParams);
+    return jsonResults.result;
+  }
+
+  protected getApiTypeFromEnableContentInspectEx(
+    enabled: boolean,
+    config: ContentInspectConfig,
+    connection: RtcConnection
+  ): string {
+    return 'RtcEngineEx_enableContentInspectEx';
+  }
+
   startMediaRenderingTracingEx(connection: RtcConnection): number {
     const apiType = this.getApiTypeFromStartMediaRenderingTracingEx(connection);
     const jsonParams = {

package/ts/Private/impl/IAgoraRtcEngineImpl.ts

@@ -74,6 +74,7 @@ import {
   ChannelMediaOptions,
   CloudProxyType,
   DirectCdnStreamingMediaOptions,
+  FeatureType,
   IDirectCdnStreamingEventHandler,
   IMetadataObserver,
   IRtcEngine,
@@ -411,9 +412,7 @@ export function processIRtcEngineEventHandler(
 
     case 'onLocalVideoStats':
       if (handler.onLocalVideoStats !== undefined) {
-        if ('source' in jsonParams) {
-          handler.onLocalVideoStats(jsonParams.source, jsonParams.stats);
-        }
+        handler.onLocalVideoStats(jsonParams.source, jsonParams.stats);
       }
       break;
 
@@ -6709,6 +6708,26 @@ export class IRtcEngineImpl implements IRtcEngine {
     return 'RtcEngine_getNtpWallTimeInMs';
   }
 
+  isFeatureAvailableOnDevice(type: FeatureType): boolean {
+    const apiType = this.getApiTypeFromIsFeatureAvailableOnDevice(type);
+    const jsonParams = {
+      type: type,
+      toJSON: () => {
+        return {
+          type: type,
+        };
+      },
+    };
+    const jsonResults = callIrisApi.call(this, apiType, jsonParams);
+    return jsonResults.result;
+  }
+
+  protected getApiTypeFromIsFeatureAvailableOnDevice(
+    type: FeatureType
+  ): string {
+    return 'RtcEngine_isFeatureAvailableOnDevice';
+  }
+
   getAudioDeviceManager(): IAudioDeviceManager {
     const apiType = this.getApiTypeFromGetAudioDeviceManager();
     const jsonParams = {};

package/ts/Private/internal/IrisApiEngine.ts

@@ -92,7 +92,11 @@ export type EventProcessor<T extends ProcessorType> = {
   type: (data: any) => EVENT_TYPE;
   func: Function[];
   preprocess?: (event: string, data: any, buffers: Uint8Array[]) => void;
-  handlers: (data: any) => (T | undefined)[] | undefined;
+  handlers: (
+    event: string,
+    data: any,
+    buffers: Uint8Array[]
+  ) => (T | undefined)[] | undefined;
 };
 
 export enum EVENT_TYPE {
@@ -151,7 +155,8 @@ export const EVENT_PROCESSORS: EventProcessors = {
         data.audioFrame.buffer = buffers[0];
       }
     },
-    handlers: () => MediaEngineInternal._audio_frame_observers,
+    handlers: (event: string, data: any) =>
+      MediaEngineInternal._audio_frame_observers,
   },
   IVideoFrameObserver: {
     suffix: 'VideoFrameObserver_',
@@ -170,14 +175,15 @@ export const EVENT_PROCESSORS: EventProcessors = {
         data.videoFrame.alphaBuffer = buffers[4];
       }
     },
-    handlers: () => MediaEngineInternal._video_frame_observers,
+    handlers: (event: string, data: any) =>
+      MediaEngineInternal._video_frame_observers,
   },
   IAudioSpectrumObserver: {
     suffix: 'AudioSpectrumObserver_',
     type: (data: any) =>
       data.playerId === 0 ? EVENT_TYPE.IRtcEngine : EVENT_TYPE.IMediaPlayer,
     func: [processIAudioSpectrumObserver],
-    handlers: (data: any) =>
+    handlers: (event: string, data: any) =>
       data.playerId === 0
         ? RtcEngineExInternal._audio_spectrum_observers
         : MediaPlayerInternal._audio_spectrum_observers.get(data.playerId),
@@ -201,7 +207,8 @@ export const EVENT_PROCESSORS: EventProcessors = {
           break;
       }
     },
-    handlers: () => RtcEngineExInternal._audio_encoded_frame_observers,
+    handlers: (event: string, data: any) =>
+      RtcEngineExInternal._audio_encoded_frame_observers,
   },
   IVideoEncodedFrameObserver: {
     suffix: 'VideoEncodedFrameObserver_',
@@ -220,13 +227,14 @@ export const EVENT_PROCESSORS: EventProcessors = {
           break;
       }
     },
-    handlers: () => MediaEngineInternal._video_encoded_frame_observers,
+    handlers: (event: string, data: any) =>
+      MediaEngineInternal._video_encoded_frame_observers,
   },
   IMediaPlayerSourceObserver: {
     suffix: 'MediaPlayerSourceObserver_',
     type: () => EVENT_TYPE.IMediaPlayer,
     func: [processIMediaPlayerSourceObserver],
-    handlers: (data: any) =>
+    handlers: (event: string, data: any) =>
       MediaPlayerInternal._source_observers.get(data.playerId),
   },
   IAudioPcmFrameSink: {
@@ -242,7 +250,7 @@ export const EVENT_PROCESSORS: EventProcessors = {
         data.frame.data_ = Array.from(buffers[0] ?? []);
       }
     },
-    handlers: (data: any) =>
+    handlers: (event: string, data: any) =>
       MediaPlayerInternal._audio_frame_observers.get(data.playerId),
   },
   IMediaPlayerVideoFrameObserver: {
@@ -262,14 +270,14 @@ export const EVENT_PROCESSORS: EventProcessors = {
         data.frame.alphaBuffer = buffers[4];
       }
     },
-    handlers: (data: any) =>
+    handlers: (event: string, data: any) =>
       MediaPlayerInternal._video_frame_observers.get(data.playerId),
   },
   IMediaRecorderObserver: {
     suffix: 'MediaRecorderObserver_',
     type: () => EVENT_TYPE.IMediaRecorder,
     func: [processIMediaRecorderObserver],
-    handlers: (data: any) => [
+    handlers: (event: string, data: any) => [
       MediaRecorderInternal._observers.get(data.nativeHandle),
     ],
   },
@@ -290,13 +298,15 @@ export const EVENT_PROCESSORS: EventProcessors = {
           break;
       }
     },
-    handlers: () => RtcEngineExInternal._metadata_observer,
+    handlers: (event: string, data: any) =>
+      RtcEngineExInternal._metadata_observer,
   },
   IDirectCdnStreamingEventHandler: {
     suffix: 'DirectCdnStreamingEventHandler_',
     type: () => EVENT_TYPE.IRtcEngine,
     func: [processIDirectCdnStreamingEventHandler],
-    handlers: () => RtcEngineExInternal._direct_cdn_streaming_event_handler,
+    handlers: (event: string, data: any) =>
+      RtcEngineExInternal._direct_cdn_streaming_event_handler,
   },
   IRtcEngineEventHandler: {
     suffix: 'RtcEngineEventHandler_',
@@ -314,7 +324,12 @@ export const EVENT_PROCESSORS: EventProcessors = {
           break;
       }
     },
-    handlers: () => RtcEngineExInternal._event_handlers,
+    handlers: (event: string, data: any) => {
+      if (event === 'onLocalVideoStats' && 'connection' in data) {
+        return undefined;
+      }
+      return RtcEngineExInternal._event_handlers;
+    },
   },
   IMusicContentCenterEventHandler: {
     suffix: 'MusicContentCenterEventHandler_',
@@ -333,7 +348,8 @@ export const EVENT_PROCESSORS: EventProcessors = {
         }
       }
     },
-    handlers: () => MusicContentCenterInternal._event_handlers,
+    handlers: (event: string, data: any) =>
+      MusicContentCenterInternal._event_handlers,
   },
 };
 
@@ -342,50 +358,54 @@ function handleEvent(...[event, data, buffers]: any) {
     console.info('onEvent', event, data, buffers);
   }
 
-  let _data: any;
-  try {
-    _data = JSON.parse(data) ?? {};
-  } catch (e) {
-    _data = {};
-  }
-
   let _event: string = event;
-  let processor: EventProcessor<any> = EVENT_PROCESSORS.IRtcEngineEventHandler;
-
-  Object.values(EVENT_PROCESSORS).some((it) => {
-    const p = it as EventProcessor<any>;
-    if (
-      _event.startsWith(p.suffix) &&
-      processor.handlers(_data) !== undefined
-    ) {
-      processor = p;
-      const reg = new RegExp(`^${processor.suffix}`, 'g');
-      _event = _event.replace(reg, '');
-      return true;
-    }
-    return false;
+  let processor: EventProcessor<any> | undefined = Object.values(
+    EVENT_PROCESSORS
+  ).find((it) => {
+    return _event.startsWith(it.suffix);
   });
 
+  if (processor === undefined) {
+    return;
+  }
+
+  // allow replace preprocess to undefined for avoid call more than once
+  processor = { ...processor };
+
+  const reg = new RegExp(`^${processor.suffix}`, 'g');
+  _event = _event.replace(reg, '');
   if (_event.endsWith('Ex')) {
     _event = _event.replace(/Ex$/g, '');
   }
 
-  const _buffers: Uint8Array[] = buffers;
-  if (processor.preprocess) {
-    processor.preprocess(_event, _data, _buffers);
+  let _data: any;
+  try {
+    _data = JSON.parse(data) ?? {};
+  } catch (e) {
+    _data = {};
   }
 
+  const _buffers: Uint8Array[] = buffers;
+
   if (processor.handlers) {
-    processor.handlers(_data)?.map((value) => {
-      if (value) {
-        processor.func.map((it) => {
-          it(value, _event, _data);
-        });
+    const handlers = processor.handlers(_event, _data, _buffers);
+    if (handlers !== undefined) {
+      if (processor.preprocess) {
+        processor.preprocess(_event, _data, _buffers);
+        // call preprocess only once
+        processor.preprocess = undefined;
       }
-    });
+      handlers.map((value) => {
+        if (value) {
+          processor!.func.map((it) => {
+            it(value, _event, _data);
+          });
+        }
+      });
+    }
   }
 
-  emitEvent(_event, processor, _data);
+  emitEvent(_event, processor, _data, _buffers);
 }
 
 /**
@@ -526,7 +546,16 @@ export function callIrisApi(funcName: string, params: any): any {
 export function emitEvent<EventType extends keyof T, T extends ProcessorType>(
   eventType: EventType,
   eventProcessor: EventProcessor<T>,
-  data: any
+  data: any,
+  buffers?: Uint8Array[]
 ): void {
+  if (DeviceEventEmitter.listenerCount(eventType as string) === 0) {
+    return;
+  }
+  if (eventProcessor.preprocess) {
+    eventProcessor.preprocess(eventType as string, data, buffers ?? []);
+    // call preprocess only once
+    eventProcessor.preprocess = undefined;
+  }
   DeviceEventEmitter.emit(eventType as string, eventProcessor, data);
 }

package/ts/Renderer/RendererManager.ts

@@ -376,7 +376,7 @@ export class RendererManager extends IRendererManager {
           break;
       }
       if (finalResult.ret !== 0) {
-        logWarn('GetVideoFrame ret is', finalResult.ret, rendererItem);
+        logDebug('GetVideoFrame ret is', finalResult.ret, rendererItem);
         return;
       }
       if (!finalResult.isNewFrame) {