Skip to content

Commit

Permalink
EN release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
Cilla-luodan committed Sep 28, 2023
1 parent a48f087 commit 8d4912b
Show file tree
Hide file tree
Showing 2 changed files with 113 additions and 0 deletions.
56 changes: 56 additions & 0 deletions markdown/RTC 4.x/release-notes/en-US/native/release_ios_ng.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,59 @@

## v4.2.3

v4.2.3 was released on September 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 `AgoraContentInspectTypeImageModeration` enumeration is added in `AgoraContentInspectType` which means using video moderation extensions from Agora Extensions Marketplace to take video screenshots and upload them.
- An optional parameter `serverConfig` is added in `AgoraContentInspectConfig`, 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. **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 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).

**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 failure of joining a channel when the local system time was not set correctly.
- When calling the `playEffect [3/3]` method to play two audio files using the same `soundId`, the first audio file was somtimes played repeatedly.
- In a chorus scenario, calling the `preloadWithSongCode` method to load music sometimes failed.
- Loading music lists failed when the local system time was not correct.
- Calling `takeSnapshotEx` once receives the `snapshotTaken` callback for multiple times.

#### API changes

**Added**

- `enableContentInspectEx`
- `AgoraContentInspectTypeImageModeration` in `AgoraContentInspectType`.
- `serverConfig` in `AgoraContentInspectConfig`
- `isFeatureAvailableOnDevice`
- `AgoraFeatureType`
## v4.2.2

v4.2.2 was released on July xx, 2023.
Expand Down
57 changes: 57 additions & 0 deletions markdown/RTC 4.x/release-notes/en-US/native/release_mac_ng.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,60 @@
## v4.2.3

v4.2.3 was released on September 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 `AgoraContentInspectTypeImageModeration` enumeration is added in `AgoraContentInspectType` which means using video moderation extensions from Agora Extensions Marketplace to take video screenshots and upload them.
- An optional parameter `serverConfig` is added in `AgoraContentInspectConfig`, 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. **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 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).

**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 when joining a channel.
- Occasional failure of joining a channel when the local system time was not set correctly.
- When calling the `playEffect [3/3]` method to play two audio files using the same `soundId`, the first audio file was somtimes played repeatedly.
- Calling `takeSnapshotEx` once receives the `snapshotTaken` callback for multiple times.

#### API changes

**Added**

- `enableContentInspectEx`
- `AgoraContentInspectTypeImageModeration` in `AgoraContentInspectType`.
- `serverConfig` in `AgoraContentInspectConfig`
- `isFeatureAvailableOnDevice`
- `AgoraFeatureType`

## v4.2.2

v4.2.2 was released on July xx, 2023.
Expand Down

0 comments on commit 8d4912b

Please sign in to comment.