Merge branch 'release/rtc-ng/4.2.3' of https://github.com/AgoraIO/ago…

…ra_doc_source into release/rtc-ng/4.2.3

markdown/RTC 4.x/release-notes/en-US/framework/release_electron_ng.md

@@ -32,7 +32,7 @@ v4.2.3 was released on September xx, 2023.
 
    Before using advanced features, you can check whether the current device supports these features based on the call result. This helps to avoid performance degradation or unavailable features when enabling advanced features on low-end devices. Based on the return value of this method, you can decide whether to display or enable the corresponding feature button, or notify the user when the device's capabilities are insufficient.
 
-   In addition, since this version, calling `enableVirtualBackground` and `setBeautyEffectOptions` automatically triggers a test on the capability of the current device. When the device is considered underperformed, the error code `-4: ErrNotSupported` is returned, indicating the device does not support the feature.  
+   In addition, since this version, calling `enableVirtualBackground` and `setBeautyEffectOptions` automatically triggers a test on the capability of the current device. When the device is considered underperformed, the error code `-4: ErrNotSupported` is returned, indicating the device does not support the feature.
 
 #### Improvements
 
@@ -55,9 +55,9 @@ This release includes the following additional improvements:
 
 This release fixed the following issues:
 
-- Occasional crashes and dropped frames occured in screen sharing scenarios. (macOS)
+- Occasional crashes and dropped frames occurred in screen sharing scenarios. (macOS)
 - Occasional crashes when joining a channel. (macOS)
-- When calling the `playEffect` method to play two audio files using the same `soundId`, the first audio file was somtimes played repeatedly.
+- When calling the `playEffect` method to play two audio files using the same `soundId`, the first audio file was sometimes played repeatedly.
 - Calling `takeSnapshotEx` once receives the `onSnapshotTaken` callback for multiple times.
 
 #### API changes
@@ -66,7 +66,7 @@ This release fixed the following issues:
 
 - `enableContentInspectEx`
 - `contentInspectImageModeration` in `ContentInspectType`
-- `serverConfig` in `ContentInspectConfig` 
+- `serverConfig` in `ContentInspectConfig`
 - `onLocalVideoStateChanged` adds the following enumerations:
 
   - `LocalVideoStreamErrorScreenCapturePaused`
@@ -75,9 +75,9 @@ This release fixed the following issues:
   - `LocalVideoStreamErrorScreenCaptureWindowRecoverFromHidden`
   - `LocalVideoStreamErrorScreenCaptureWindowRecoverFromMinimized`
 
-- `d3d11_texture_2d` and `texture_slice_index` in `ExternalVideoFrame` 
+- `d3d11_texture_2d` and `texture_slice_index` in `ExternalVideoFrame`
 
-- `VideoTextureId3d11texture2d` in `VideoPixelFormat` 
+- `VideoTextureId3d11texture2d` in `VideoPixelFormat`
 - `isFeatureAvailableOnDevice`
 - `FeatureType`
 
@@ -219,7 +219,7 @@ This release optimizes the APIs for camera and screen capture function. As of v4
 - The `VideoInputStreams` in `LocalTranscoderConfiguration` is changed to `videoInputStreams`.
 - The `MediaSourceType` in `TranscodingVideoStream` is changed to `VideoSourceType`.
 
-**5. Virtual sound card (macOS)** 
+**5. Virtual sound card (macOS)**
 
 As of v4.2.0, Agora supports third-party virtual sound cards. You can use a third-party virtual sound card as the audio input or output device for the SDK. You can use the `stateChanged` callback to see whether the current input or output device selected by the SDK is a virtual sound card.
 
@@ -281,7 +281,7 @@ This release adds the `startMediaRenderingTracing` and `startMediaRenderingTraci
 
 Agora recommends that you use this method in conjunction with the UI settings, such as buttons and sliders, in your app. For example, call this method when the user clicks **Join Channel** button and then get the indicators in the video frame rendering process through the `onVideoRenderingTracingResult` callback. This enables developers to optimize the indicators and improve the user experience.
 
-#### Improvements 
+#### Improvements
 
 **1. Voice changer**
 

markdown/RTC 4.x/release-notes/en-US/framework/release_rn_ng.md

@@ -86,10 +86,10 @@ This release includes the following additional improvements:
 This release fixed the following issues:
 
 - Occasional failure of joining a channel when the local system time was not set correctly.
-- When calling the `playEffect` method to play two audio files using the same `soundId`, the first audio file was somtimes played repeatedly.
+- When calling the `playEffect` method to play two audio files using the same `soundId`, the first audio file was sometimes played repeatedly.
 - Calling `takeSnapshotEx` once receives the `onSnapshotTaken` callback for multiple times.
 - When the host called the `startAudioMixing` method to play music, sometimes the host couldn't hear the music while the remote users could hear it. (Android)
-- Occasional crashes occured on certain Android devices. (Android)
+- Occasional crashes occurred on certain Android devices. (Android)
 - In channels joined by calling `joinChannelEx` exclusively, calling `setEnableSpeakerphone` is unable to switch audio route from the speaker to the headphone. (Android)
 - Occasionally, noise occurred when the local user listened to their own and remote audio after joining the channel. (macOS)
 - Slow channel reconnection after the connection was interrupted due to network reasons.

markdown/RTC 4.x/release-notes/en-US/framework/release_unity_ng.md

@@ -1,3 +1,88 @@
+## v4.2.3
+
+v4.2.3 was released on October xx, 2023.
+
+#### New features
+
+1. **Update video screenshot and upload**
+
+   To facilitate the integration of third-party video moderation services from Agora Extensions Marketplace, this version has the following changes:
+
+   - The `CONTENT_INSPECT_IMAGE_MODERATION` enumeration is added in `CONTENT_INSPECT_TYPE` which means using video moderation extensions from Agora Extensions Marketplace to take video screenshots and upload them.
+   - An optional parameter `serverConfig` is added in `ContentInspectConfig`, which is for server-side configuration related to video screenshot and upload via extensions from Agora Extensions Marketplace. By configuring this parameter, you can integrate multiple third-party moderation extensions and achieve flexible control over extension switches and other features. For more details, please contact [technical support](mailto:[email protected]).
+
+   In addition, this version also introduces the `EnableContentInspectEx` method, which supports taking screenshots for multiple video streams and uploading them.
+
+2. **ID3D11Texture2D Rendering** (Windows)
+
+   As of this release, the SDK supports video formats of type ID3D11Texture2D, improving the rendering effect of video frames in game scenarios. You can set `format` to `VIDEO_TEXTURE_ID3D11TEXTURE2D` when pushing external raw video frames to the SDK by calling `PushVideoFrame`. By setting the `d3d11_texture_2d` and `texture_slice_index` properties, you can determine the ID3D11Texture2D texture object to use.
+
+3. **Local video status error code update** (Windows, macOS)
+
+   In order to help users understand the exact reasons for local video errors in screen sharing scenarios, the following sets of enumerations have been added to the `OnLocalVideoStateChanged` callback:
+
+   - `LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_PAUSED`(23): Screen capture has been paused. Common scenarios for reporting this error code: The current screen may have been switched to a secure desktop, such as a UAC dialog box or Winlogon desktop.
+   - `LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_RESUMED`(24): Screen capture has resumed from the paused state.
+   - `LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_HIDDEN`(25): The window being captured on the current screen is in a hidden state and is not visible on the current screen.
+   - `LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_HIDDEN`(26): The window for screen capture has been restored from the hidden state.
+   - `LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_MINIMIZED`(27): The window for screen capture has been restored from the minimized state.
+
+4. **Check device support for advanced features**
+
+   This version adds the `IsFeatureAvailableOnDevice` method to check whether the capability of the current device meets the requirements of the specified advanced feature, such as virtual background and image enhancement.
+
+   Before using advanced features, you can check whether the current device supports these features based on the call result. This helps to avoid performance degradation or unavailable features when enabling advanced features on low-end devices. Based on the return value of this method, you can decide whether to display or enable the corresponding feature button, or notify the user when the device's capabilities are insufficient.
+
+   In addition, since this version, calling `EnableVirtualBackground` and `SetBeautyEffectOptions` automatically triggers a test on the capability of the current device. When the device is considered underperformed, the error code `-4:ERR_NOT_SUPPORTED` is returned, indicating the device does not support the feature.
+
+#### Improvements
+
+1. **Optimize virtual background memory usage**
+
+   This version has upgraded the virtual background algorithm, reducing the memory usage of the virtual background feature. Compared to the previous version, the memory consumption of the app during the use of the virtual background feature on low-end devices has been reduced by approximately 4% to 10% (specific values may vary depending on the device model and platform).
+
+2. **Screen sharing scenario optimization**
+
+   This release optimizes the performance and encoding efficiency in ultra-high-definition (4K, 60 fps) game sharing scenarios, effectively reducing the system resource usage during screen sharing.
+
+**Other Improvements**
+
+This release includes the following additional improvements:
+
+- Optimizes the logic of handling invalid parameters. When you call the `SetPlaybackSpeed` method to set the playback speed of audio files, if you pass an invalid parameter, the SDK returns the error code -2, which means that you need to reset the parameter.
+- Optimizes the logic of Token parsing, in order to prevent an app from crash when an invalid token is passed in.
+
+#### Issues fixed
+
+This release fixed the following issues:
+
+- Occasional crashes and dropped frames occurred in screen sharing scenarios. (Windows)
+- Occasional crashes when joining a channel. (macOS)
+- Occasional failure of joining a channel when the local system time was not set correctly.
+- When calling the `PlayEffect` method to play two audio files using the same `soundId`, the first audio file was sometimes played repeatedly.
+- When the host called the `StartAudioMixing` [2/2] method to play music, sometimes the host couldn't hear the music while the remote users could hear it. (Android)
+- Occasional crashes occurred on certain Android devices. (Android)
+- Calling `TakeSnapshotEx` once receives the `OnSnapshotTaken` callback for multiple times.
+- In channels joined by calling `JoinChannelEx` exclusively, calling `SetEnableSpeakerphone` is unable to switch audio route from the speaker to the headphone. (Android)
+
+#### API changes
+
+**Added**
+
+- The following enumerations in `OnLocalVideoStateChanged`: (Windows, macOS)
+  - `LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_PAUSED`
+  - `LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_RESUMED`
+  - `LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_HIDDEN`
+  - `LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_HIDDEN`
+  - `LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_MINIMIZED`
+- `d3d11_texture_2d` and `texture_slice_index` members in `ExternalVideoFrame` (Windows)
+- `VIDEO_TEXTURE_ID3D11TEXTURE2D` in `VIDEO_PIXEL_FORMAT` (Windows)
+- `EnableContentInspectEx`
+- `CONTENT_INSPECT_IMAGE_MODERATION` in `CONTENT_INSPECT_TYPE`
+- `serverConfig` in `ContentInspectConfig`
+- `IsFeatureAvailableOnDevice`
+- `FeatureType`
+
 ## v4.2.2
 
 This version was released on July, xx, 2023.
@@ -20,7 +105,7 @@ The following methods in the `IAudioFrameObserver` class are deleted:
 
 The following methods in the `IVideoFrameObserver` class are deleted:
 
-- `GetVideoFormatPreference`: Use the newly-added `formatPreference` parameter in  `RegisterVideoFrameObserver`. 
+- `GetVideoFormatPreference`: Use the newly-added `formatPreference` parameter in  `RegisterVideoFrameObserver`.
 - `GetObservedFramePosition`: Use the newly-added `position` parameter in  `RegisterVideoFrameObserver`.
 
 3. **Metadata**
@@ -95,7 +180,7 @@ This release fixed the following issues:
 - Occasionally, noise occurred when the local user listened to their own and remote audio after joining the channel. (macOS)
 - Slow channel reconnection after the connection was interrupted due to network reasons.
 - In screen sharing scenarios, the delay of seeing the shared screen was occasionally higher than expected on some devices.
-- In custom video capturing scenarios, `SetBeautyEffectOptions`, `SetLowlightEnhanceOptions`, `SetVideoDenoiserOptions`, and `SetColorEnhanceOptions` could not load extensions automatically. 
+- In custom video capturing scenarios, `SetBeautyEffectOptions`, `SetLowlightEnhanceOptions`, `SetVideoDenoiserOptions`, and `SetColorEnhanceOptions` could not load extensions automatically.
 - In multi-device audio recording scenarios, after repeatedly plugging and unplugging or enabling/disabling the audio recording device, no sound could be heard occasionally when calling the `StartRecordingDeviceTest` to start an audio capturing device test. (Windows)
 
 #### API changes
@@ -120,7 +205,7 @@ This release fixed the following issues:
 - `REMOTE_VIDEO_STATE_REASON_CODEC_NOT_SUPPORT` in `REMOTE_VIDEO_STATE_REASON`
 - `SetMaxMetadataSize`
 - `SendMetadata`
-- `position` parameter in `RegisterAudioFrameObserver` 
+- `position` parameter in `RegisterAudioFrameObserver`
 - `formatPreference` and `position`  parameters in `RegisterVideoFrameObserver`
 
 **Deleted**
@@ -322,52 +407,52 @@ This release fixed the following issues:
 
 **Windows**
 
-- When using Agora Media Player to play RTSP video streams, the video images sometimes appeared pixelated. 
-- Adding an alpha channel to an image in PNG or GIF format failed when the local client mixed video streams. 
+- When using Agora Media Player to play RTSP video streams, the video images sometimes appeared pixelated.
+- Adding an alpha channel to an image in PNG or GIF format failed when the local client mixed video streams.
 - After joining the channel, remote users saw a watermark even though the watermark was deleted.
 - If a watermark was added after starting screen sharing, the watermark did not display the screen.
 - When joining a channel and accessing an external camera, calling `SetDevice` to specify the video capture device as the external camera did not take effect.
 - When trying to outline the shared window and put it on top, the shared window did not stay on top of other windows.
 
 **Android**
 
-- Occasional crashes occur on Android devices when users joining or leaving a channel. 
-- Occational failure when enabling in-ear monitoring. 
-- Occational echo. 
-- Crashes occurred after users set the video resolution as 3840 × 2160 and started CDN streaming on Xiaomi Redmi 9A devices. 
-- In real-time chorus scenarios, remote users heard noises and echoes when an OPPO R11 device joined the channel in loudspeaker mode. 
-- When the playback of the local music finished, the `OnAudioMixingFinished` callback was not properly triggered. 
-- When using a video frame observer, the first video frame was occasionally missed on the receiver's end. 
-- When sharing screens in scenarios involving multiple channels, remote users occasionally saw black screens. 
-- Switching to the rear camera with the virtual background enabled occasionally caused the background to be inverted. 
-- Abnormal client status caused by an exception in the `OnRemoteAudioStateChanged` callback. 
+- Occasional crashes occur on Android devices when users joining or leaving a channel.
+- Occational failure when enabling in-ear monitoring.
+- Occational echo.
+- Crashes occurred after users set the video resolution as 3840 × 2160 and started CDN streaming on Xiaomi Redmi 9A devices.
+- In real-time chorus scenarios, remote users heard noises and echoes when an OPPO R11 device joined the channel in loudspeaker mode.
+- When the playback of the local music finished, the `OnAudioMixingFinished` callback was not properly triggered.
+- When using a video frame observer, the first video frame was occasionally missed on the receiver's end.
+- When sharing screens in scenarios involving multiple channels, remote users occasionally saw black screens.
+- Switching to the rear camera with the virtual background enabled occasionally caused the background to be inverted.
+- Abnormal client status caused by an exception in the `OnRemoteAudioStateChanged` callback.
 
 **iOS**
 
-- Occasional loss of the `OnFirstRemoteVideoFrame` callback during channel media relay. 
-- The receiver actively subscribed to the high-quality stream but unexpectedly received a low-quality stream. 
+- Occasional loss of the `OnFirstRemoteVideoFrame` callback during channel media relay.
+- The receiver actively subscribed to the high-quality stream but unexpectedly received a low-quality stream.
 - Abnormal client status cased by an exception in the `OnRemoteAudioStateChanged` callback.
 
 **macOS**
 
-- The receiver was receiving the low-quality stream originally, and automatically switched to high-quality stream after a few seconds. 
-- Occasional screen jittering during screen sharing. 
-- The receiver was receiving the low-quality stream originally, and automatically switched to high-quality stream after a few seconds. 
-- Occasional screen jittering during screen sharing. 
+- The receiver was receiving the low-quality stream originally, and automatically switched to high-quality stream after a few seconds.
+- Occasional screen jittering during screen sharing.
+- The receiver was receiving the low-quality stream originally, and automatically switched to high-quality stream after a few seconds.
+- Occasional screen jittering during screen sharing.
 - If the rendering view of the player was set as a UIViewController's view, the video was zoomed from the bottom-left corner to the middle of the screen when entering full-screen mode.
 - When joining a channel and accessing an external camera, calling `SetDevice` to specify the video capture device as the external camera did not take effect.
 
 **All platforms**
 
 - When the host frequently switching the user role between broadcaster and audience in a short period of time, the audience members cannot hear the audio of the host.
 - Playing audio files with a sample rate of 48 kHz failed.
-- When there were multiple video streams in a channel, calling some video enhancement APIs occasionally failed. 
+- When there were multiple video streams in a channel, calling some video enhancement APIs occasionally failed.
 
 #### API changes
 
 **Added**
 
-- `StartCameraCapture` 
+- `StartCameraCapture`
 - `StopCameraCapture`
 - `StartScreenCapture`[2/2]  (Windows,macOS)
 - `StopScreenCapture`[2/2]  (Windows,macOS)
@@ -421,4 +506,4 @@ This release fixed the following issues:
 - `OnApiCallExecuted`
 - `PublishCustomAudioTrackEnableAec ` in` ChannelMediaOptions`
 - `EnableRemoteSuperResolution`
-- `superResolutionType` in `RemoteVideoStats` 
+- `superResolutionType` in `RemoteVideoStats`

markdown/RTC 4.x/release-notes/en-US/native/release_android_ng.md

@@ -167,7 +167,7 @@ If you use the features mentioned in this section, ensure that you modify the im
 **1. Video data acquisition**
 
 - The `onCaptureVideoFrame` and `onPreEncodeVideoFrame` callbacks are added with a new parameter called `sourceType`, which is used to indicate the specific video source type.
-- The following callbacks are deleted. Get the video source type through the `sourceType` parameter in the `onPreEncodeVideoFrame` and `onCaptureVideoFrame` callbacks. 
+- The following callbacks are deleted. Get the video source type through the `sourceType` parameter in the `onPreEncodeVideoFrame` and `onCaptureVideoFrame` callbacks.
 - `onScreenCaptureVideoFrame`
 - `onPreEncodeScreenVideoFrame`