From f584d6b80b78a854a760739aa9028460fba186e1 Mon Sep 17 00:00:00 2001
From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com>
Date: Wed, 10 Jul 2024 15:37:51 +0800
Subject: [PATCH 01/11] add 440 release notes
---
.../dita/RTC-NG/release/release_ng_4.3.2.dita | 101 ++++++++++++
en-US/dita/RTC-NG/release/release_notes.dita | 154 ++++++++++--------
2 files changed, 190 insertions(+), 65 deletions(-)
create mode 100644 en-US/dita/RTC-NG/release/release_ng_4.3.2.dita
diff --git a/en-US/dita/RTC-NG/release/release_ng_4.3.2.dita b/en-US/dita/RTC-NG/release/release_ng_4.3.2.dita
new file mode 100644
index 00000000000..f1653c46be8
--- /dev/null
+++ b/en-US/dita/RTC-NG/release/release_ng_4.3.2.dita
@@ -0,0 +1,101 @@
+
+
+
+ v4.3.2
+
+ This version was released on May x, 20xx.
+
+
+
+
+ Upgrade Notes
+
+
+ - Important Upgrade Information
+
+
+ - Important Upgrade Information
+
+
+
+
+
+
+ New Features
+
+
+ - New Feature Name
+
+
+ - New Feature Name
+
+
+
+
+
+
+ Improvements
+
+
+ - This release enhances the usability of the method by removing the timing requirements for invocation. It can now be called both before and after joining the channel to dynamically switch audio and video stream fallback options in weak network conditions.
+ - The Agora media player supports playing MP4 files with an Alpha channel. (iOS, Android)
+ - The Agora media player fully supports playing music files located in the /assets/ directory or from URI starting with content://. (Android)
+
+
+
+
+ Issues fixed
+ This version fixed the following issues:
+
+ - The remote video froze or became pixelated when the app returned to the foreground after being in the background for a long time. (iOS)
+ - The local preview image rotated by 90° on some iPad devices, which did not meet expectations. (iOS)
+ - Occasional video smoothness issues during audio and video interactions.
+ - The app occasionally crashed when the decoded video resolution on the receiving end was an odd number.
+ - The app crashed when opening the app and starting screen sharing after the first installation or system reboot. (Android)
+ - Local audio capture failed after joining a channel while answering a system phone call and hanging up, causing remote users to not hear any sound. (Android)
+ - During the interaction process on certain devices (for example, Redmi Note8), after answering and hanging up a system call, local media files were played without sound and no sound was heard from the remote end. (Android)
+ - Fixed an occasional crash when remote users left the channel.
+ - The screen occasionally flickered on the receiver's side when sharing a PPT window using and playing PPT animations. (Windows)
+ - The window border did not retain its original size after exiting the presentation and then maximizing the PPT window when sharing a WPS PPT window on Windows 7 using and setting enableHighLight in to . (Windows)
+ - The specified window could not be brought to the foreground if it was covered by other windows when sharing a window using and setting windowFocus and enableHighLight in to . (Windows)
+ - Clicking on the desktop widget caused the outlined part to flicker when sharing and highlighting a window on a Windows 7 device. (Windows)
+ - The values of cameraDirection and focalLengthType in returned by could not be read directly.
+ - When playing an audio file using and the playing finished, the SDK sometimes failed to trigger the (, ) callback which reports that the playing is completed. (iOS)
+ - When calling the method to play sound effect files shorter than 1 second with loopCount set to 0, there was no sound. (iOS)
+ - When using the Agora media player to play a video and stopping it during playing, sometimes there was no sound for a short time after the playing was resumed. (iOS)
+
+
+
+
+ API Changes
+
+ Added
+
+
+ Modified
+
+
+ Deprecated
+
+
+ Removed
+
+
+
+
+
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/release/release_notes.dita b/en-US/dita/RTC-NG/release/release_notes.dita
index f1653c46be8..b47746a6466 100644
--- a/en-US/dita/RTC-NG/release/release_notes.dita
+++ b/en-US/dita/RTC-NG/release/release_notes.dita
@@ -1,40 +1,78 @@
- v4.3.2
+ v4.4.0
- This version was released on May x, 20xx.
+ This version was released on July x, 2024.
-
- Upgrade Notes
+
+ Compatibility changes
+ This version includes optimizations to some features, including changes to SDK behavior, API renaming, or removal. To ensure your project runs smoothly, you need to update the code in your app after upgrading to this version.
+ Starting from v4.4.0, the RTC SDK provides an API deprecation notice, which includes information about deprecated and removed APIs in each version. See API Deprecation NoticeAPI Deprecation NoticeAPI Deprecation NoticeAPI Deprecation Notice.
- - Important Upgrade Information
-
-
- - Important Upgrade Information
-
+
- To distinguish context information in different plugin callbacks, this version removes the original plugin-related callbacks and adds corresponding callbacks that can identify plugin context information (see the table below). You can learn the plugin name, user ID using the plugin, and the service provider name through the in each callback.
+
+
+ Original Callback
+ Current Callback
+
+
+ onExtensionEvent
+
+
+
+ onExtensionStarted
+
+
+
+ onExtensionStopped
+
+
+
+ onExtensionError
+
+
+
+ - Before v4.4.0, when your user role was set to audience, calling to set the audio scenario to chatroom () would trigger a microphone permission request popup. From v4.4.0 onwards, the SDK uses native iOS APIs to control the microphone, so audience users in a chatroom scenario will no longer see the microphone permission request popup.
+ - This version renames the receiveMetadata callback to and removes the data and timeStamp parameters. You can get metadata-related information, including timeStamp (timestamp of the sent data), uid (user ID), and channelId (source channel name) through the new metadata parameter.
+ - This version removes the callback's buffer, uid, and timeStampMs parameters. You can get metadata-related information, including timeStampMs (timestamp of the sent data), uid (user ID), and channelId (source channel name) through the new metadata parameter.
-
+
New Features
- - New Feature Name
+
- Lite SDK
+
Starting from this version, Agora introduces the Lite SDK, which includes only the basic audio and video capabilities and partially cuts high-level audio and video processing features, effectively reducing the app size after integrating the SDK.
+
+ - Lite SDK supports manual integration or third-party repository integration. For details, see and .
+ - For information on dynamic libraries included in the Lite SDK, see .
+ - For the list of APIs supported by the Lite SDK, see Lite SDK API ListLite SDK API List.
+
+
+ - Alpha Transparency Effects
+
This version introduces the Alpha transparency effects feature, supporting the transmission and rendering of Alpha channel data in video frames for SDK capture and custom capture scenarios, enabling transparent gift effects, custom backgrounds on the receiver end, etc.:
-
-
+ - and add the alphaBuffer: Set the Alpha channel data.
+ - adds the fillAlphaBuffer: For BGRA or RGBA formatted video data, set whether to automatically extract the Alpha channel data and fill it into alphaBuffer.
+ - and add the alphaStitchMode: Set the relative position of alphaBuffer and video frame stitching.
+ Additionally, adds a new member encodeAlpha, which is used to set whether to encode and send Alpha information to the remote end. By default, the SDK does not encode and send Alpha information; if you need to encode and send Alpha information to the remote end (e.g., when virtual background is enabled), explicitly call to set the video encoding properties and set encodeAlpha to .
- - New Feature Name
-
+
- AI Voice Tuner
+
This version introduces the AI Voice Tuner feature, which can enhance the sound quality and tone, similar to a physical sound card. You can enable the AI Voice Tuner feature by calling the method and passing in the sound effect types supported in the enum to achieve effects like deep voice, cute voice, husky singing voice, etc.
+
+ - Copyright Music Optimization
+
+ - This version adds the method under the class to set the playback mode of music resources. In online karaoke room scenarios, you can enable accompaniment, original singing, or guide singing mode as needed.
+ - This version adds the method under the class to destroy the music player and release the corresponding resources.
+ - This version deprecates the method under the class. To destroy the music player, use the new method under the class.
+
@@ -43,59 +81,45 @@
Improvements
- - This release enhances the usability of the method by removing the timing requirements for invocation. It can now be called both before and after joining the channel to dynamically switch audio and video stream fallback options in weak network conditions.
- - The Agora media player supports playing MP4 files with an Alpha channel. (iOS, Android)
- - The Agora media player fully supports playing music files located in the /assets/ directory or from URI starting with content://. (Android)
+ - Adaptive Hardware Decoding Support (Android, Windows)
+
This release introduces adaptive hardware decoding support, enhancing rendering smoothness on low-end devices and significantly reducing system load.
+
+ - Rendering Performance Enhancement (Windows)
+
DirectX 11 renderer is now enabled by default on Windows devices, providing high-performance and high-quality graphics rendering capabilities.
+
+ - Facial Region Beautification
+
To avoid losing details in non-facial areas during heavy skin smoothing, this version improves the skin smoothing algorithm. It now recognizes various parts of the face, applying smoothing to facial skin areas excluding the mouth, eyes, and eyebrows, and supports smoothing up to two faces simultaneously.
+
+ - Other Improvements
+
This version also includes the following improvements:
+
+ - Optimized transmission strategy: invoking no longer impacts the security of the transmission link.
+ - callback now includes the enumeration, indicating that the display used for screen capture has been disconnected. (Windows, macOS)
+ - Optimized the video link for window sharing, reducing CPU usage. (macOS)
+ - Improved echo cancellation for screen sharing scenarios.
+ - Added channelId parameter to , enabling retrieval of the source channel name for sent Metadata.
+ - Deprecated redundant enumeration values and in .
+ - Optimized parameter types for the following APIs to enhance code readability, reduce potential errors, and facilitate future maintenance:
+
+ - Deprecated option parameter of type int in , introduced overloaded function with option parameter of type .
+ - Deprecated streamType parameter of type int in , , and , introduced overloaded functions , , and with streamType parameter of type .
+
+
+
Issues fixed
- This version fixed the following issues:
+
+ This release fixed the following issues:
- - The remote video froze or became pixelated when the app returned to the foreground after being in the background for a long time. (iOS)
- - The local preview image rotated by 90° on some iPad devices, which did not meet expectations. (iOS)
- - Occasional video smoothness issues during audio and video interactions.
- - The app occasionally crashed when the decoded video resolution on the receiving end was an odd number.
- - The app crashed when opening the app and starting screen sharing after the first installation or system reboot. (Android)
- - Local audio capture failed after joining a channel while answering a system phone call and hanging up, causing remote users to not hear any sound. (Android)
- - During the interaction process on certain devices (for example, Redmi Note8), after answering and hanging up a system call, local media files were played without sound and no sound was heard from the remote end. (Android)
- - Fixed an occasional crash when remote users left the channel.
- - The screen occasionally flickered on the receiver's side when sharing a PPT window using and playing PPT animations. (Windows)
- - The window border did not retain its original size after exiting the presentation and then maximizing the PPT window when sharing a WPS PPT window on Windows 7 using and setting enableHighLight in to . (Windows)
- - The specified window could not be brought to the foreground if it was covered by other windows when sharing a window using and setting windowFocus and enableHighLight in to . (Windows)
- - Clicking on the desktop widget caused the outlined part to flicker when sharing and highlighting a window on a Windows 7 device. (Windows)
- - The values of cameraDirection and focalLengthType in returned by could not be read directly.
- - When playing an audio file using and the playing finished, the SDK sometimes failed to trigger the (, ) callback which reports that the playing is completed. (iOS)
- - When calling the method to play sound effect files shorter than 1 second with loopCount set to 0, there was no sound. (iOS)
- - When using the Agora media player to play a video and stopping it during playing, sometimes there was no sound for a short time after the playing was resumed. (iOS)
+ - Occasional app crashes occurred when multiple remote users joined the channel simultaneously during real-time interaction. (iOS)
+ - Remote video occasionally froze or displayed corrupted images when the app returned to the foreground after being in the background for a while. (iOS)
+ - After the sender called to start direct CDN streaming, frequent switching or toggling of the network occasionally resulted in a black screen on the receiver's end without a streaming failure callback on the sender's end. (iOS)
+ - Audio playback failed when pushing external audio data using if the external audio rendering sample rate was not the recommended value by the SDK, such as 22050 Hz and 11025 Hz.
-
-
- API Changes
-
- Added
-
-
- Modified
-
-
- Deprecated
-
-
- Removed
-
-
-
-
+
-
\ No newline at end of file
+
From b967d9be29f4d0453a1428f482bd9dd56f0fedeb Mon Sep 17 00:00:00 2001
From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com>
Date: Wed, 10 Jul 2024 16:00:26 +0800
Subject: [PATCH 02/11] add codeph tag
---
dita/RTC-NG/release/release_notes.dita | 46 +++++++++++++-------------
1 file changed, 23 insertions(+), 23 deletions(-)
diff --git a/dita/RTC-NG/release/release_notes.dita b/dita/RTC-NG/release/release_notes.dita
index 7460746fbd7..27e276c1fdd 100644
--- a/dita/RTC-NG/release/release_notes.dita
+++ b/dita/RTC-NG/release/release_notes.dita
@@ -13,7 +13,7 @@
该版本对部分功能的实现方式进行了优化,包括 SDK 的行为变更、API 的改名或删除,为确保项目的正常运行,你需要在升级到该版本后更新 App 中的代码。
自 v4.4.0 起,RTC SDK 提供 API 下架说明,包含各版本废弃及删除的 API 信息。详见 API 下架说明API 下架说明API 下架说明API 下架说明。
- - 为区分不同插件回调中的上下文信息,该版本将原有的插件相关回调删除并新增可标识插件上下文信息的对应回调(见下表),你可以通过各回调中的 了解插件的名称、使用该插件的用户 ID、和提供插件的服务商名等信息。
+
- 为区分不同插件回调中的上下文信息,该版本将原有的插件相关回调删除并新增可标识插件上下文信息的对应回调(见下表),你可以通过各回调中的 了解插件的名称、使用该插件的用户 ID、和提供插件的服务商名等信息。
原有回调
@@ -21,25 +21,25 @@
onExtensionEvent
-
+
onExtensionStarted
-
+
onExtensionStopped
-
+
onExtensionError
-
+
- - 在 v4.4.0 之前,当你的用户角色为观众时,调用 将音频场景设为聊天室场景()会收到申请麦克风权限的弹窗提示。自 v4.4.0 起,SDK 通过 iOS 原生的 API 控制麦克风开关,因此观众角色在聊天室场景下不会再收到申请麦克风权限的弹窗。
- - 改版本将 receiveMetadata 回调改名为 ,并删除了回调中的 data、timeStamp 参数,你可以通过新增的 metadata 参数来获取 Metadata 的相关信息,包括 timeStamp(发送数据的时间戳)、uid(用户 ID)、channelId(源频道名称)等。
- - 改版本删除了 回调中的 buffer、uid、timeStampMs 参数,你可以通过新增的 metadata 参数来获取 Metadata 的相关信息,包括 timeStampMs(发送数据的时间戳)、uid(用户 ID)、channelId(源频道名称)等。
+ - 在 v4.4.0 之前,当你的用户角色为观众时,调用 将音频场景设为聊天室场景()会收到申请麦克风权限的弹窗提示。自 v4.4.0 起,SDK 通过 iOS 原生的 API 控制麦克风开关,因此观众角色在聊天室场景下不会再收到申请麦克风权限的弹窗。
+ - 改版本将 receiveMetadata 回调改名为 ,并删除了回调中的 data、timeStamp 参数,你可以通过新增的 metadata 参数来获取 Metadata 的相关信息,包括 timeStamp(发送数据的时间戳)、uid(用户 ID)、channelId(源频道名称)等。
+ - 改版本删除了 回调中的 buffer、uid、timeStampMs 参数,你可以通过新增的 metadata 参数来获取 Metadata 的相关信息,包括 timeStampMs(发送数据的时间戳)、uid(用户 ID)、channelId(源频道名称)等。
@@ -57,20 +57,20 @@
Alpha 透明特效
该版本新增 Alpha 透明特效功能,支持在 SDK 采集和自定义采集视频的场景下,在发送端发布视频帧的 Alpha 通道、在接收端对 Alpha 通道进行渲染处理,实现透明礼物特效、接收端自定义主播背景等:
- - 和 中新增 alphaBuffer:设置 Alpha 通道数据。
- - 中新增 fillAlphaBuffer:对于 BGRA 或 RGBA 格式的视频数据,设置是否自动提取 Alpha 通道数据并填入到 alphaBuffer 中。
- - 和 中中新增 alphaStitchMode:设置 alphaBuffer 和视频帧拼接的相对位置。
+ - 和 中新增 alphaBuffer:设置 Alpha 通道数据。
+ - 中新增 fillAlphaBuffer:对于 BGRA 或 RGBA 格式的视频数据,设置是否自动提取 Alpha 通道数据并填入到 alphaBuffer 中。
+ - 和 中新增 alphaStitchMode:设置 alphaBuffer 和视频帧拼接的相对位置。
- 另外, 中新增成员 encodeAlpha,用于设置是否将 Alpha 信息编码并发送到远端。SDK 默认不对 Alpha 信息进行编码发送;如果需要对 Alpha 信息编码发送至远端(例如开启了虚拟背景功能),请显式调用 设置视频编码属性,并将 encodeAlpha 设置为 。
+ 另外, 中新增成员 encodeAlpha,用于设置是否将 Alpha 信息编码并发送到远端。SDK 默认不对 Alpha 信息进行编码发送;如果需要对 Alpha 信息编码发送至远端(例如开启了虚拟背景功能),请显式调用 设置视频编码属性,并将 encodeAlpha 设置为 。
AI 调音器
- 该版本新增 AI 调音器功能,可以实现类似物理声卡对音质和音色的提升。你可以通过调用 方法并传入 枚举中支持的音效类型来启用 AI 调音器功能,实现大叔音、萝莉音、烟嗓歌声等声音效果。
+ 该版本新增 AI 调音器功能,可以实现类似物理声卡对音质和音色的提升。你可以通过调用 方法并传入 枚举中支持的音效类型来启用 AI 调音器功能,实现大叔音、萝莉音、烟嗓歌声等声音效果。
版权音乐优化
- - 该版本在 类下新增 方法,用于设置音乐资源的播放模式。在在线 K 歌房等场景下,你可以根据需求启用伴唱、原唱或导唱模式。
- - 该版本在 类下新增 方法,用于销毁音乐播放器并释放相应的资源。
- - 该版本废弃了 类下的 方法。如需销毁音乐播放器,请改用 类下新增 方法。
+ - 该版本在 类下新增 方法,用于设置音乐资源的播放模式。在在线 K 歌房等场景下,你可以根据需求启用伴唱、原唱或导唱模式。
+ - 该版本在 类下新增 方法,用于销毁音乐播放器并释放相应的资源。
+ - 该版本废弃了 类下的 方法。如需销毁音乐播放器,请改用 类下新增 方法。
@@ -92,15 +92,15 @@
其他改进
该版本还进行了如下改进:
- - 优化了传输策略,调用 不再对传输链路的安全性产生影响。
- - 回调中新增 枚举,表示进行屏幕采集的显示器已断开连接。(Windows, macOS)
+ - 优化了传输策略,调用 不再对传输链路的安全性产生影响。
+ - 回调中新增 枚举,表示进行屏幕采集的显示器已断开连接。(Windows, macOS)
- 优化了共享窗口的视频链路,降低了 CPU 占用率。(macOS)
- 优化了屏幕共享场景下的回声消除。
- - 该版本在 中新增 channelId 参数,用于获取发送 Metadata 的源频道名称。
- - 废弃了 中的冗余枚举值 、。
+ - 该版本在 中新增 channelId 参数,用于获取发送 Metadata 的源频道名称。
+ - 废弃了 中的冗余枚举值 、。
- 优化了以下 API 的参数类型。此改进有助于提升代码的可读性,减少潜在的错误,并便于后续维护。
- - 废弃了 option 参数为 int 类型的 ,新增了 option 参数为 类型的重载函数 。
- - 废弃了 streamType 参数为 int 类型的 、、,新增了 streamType 参数为 类型的重载函数 、、。
+ - 废弃了 option 参数为 int 类型的 ,新增了 option 参数为 类型的重载函数 。
+ - 废弃了 streamType 参数为 int 类型的 、、,新增了 streamType 参数为 类型的重载函数 、、。
@@ -113,7 +113,7 @@
- 在实时互动过程中,当多个远端同时加入频道时 App 偶现崩溃。(iOS)
- App 切后台一段时间、然后返回前台时,远端视频画面偶现卡住或花屏。(iOS)
- - 发送端调用 开始直接向 CDN 推流后,频繁开关或切换网络,偶现接收端黑屏但发送端未收到推流失败回调。(iOS)
+ - 发送端调用 开始直接向 CDN 推流后,频繁开关或切换网络,偶现接收端黑屏但发送端未收到推流失败回调。(iOS)
- 调用 推送外部音频数据,外部音频渲染的采样率如果不是 SDK 推荐的值时,比如 22050 Hz 和 11025 Hz,声音播放失败。
This version includes optimizations to some features, including changes to SDK behavior, API renaming, or removal. To ensure your project runs smoothly, you need to update the code in your app after upgrading to this version.
- Starting from v4.4.0, the RTC SDK provides an API deprecation notice, which includes information about deprecated and removed APIs in each version. See API Deprecation NoticeAPI Deprecation NoticeAPI Deprecation NoticeAPI Deprecation Notice.
+ Starting from v4.4.0, the RTC SDK provides an API sunset notice, which includes information about deprecated and removed APIs in each version. See API Sunset NoticeAPI Sunset NoticeAPI Sunset NoticeAPI Sunset Notice.
- To distinguish context information in different plugin callbacks, this version removes the original plugin-related callbacks and adds corresponding callbacks that can identify plugin context information (see the table below). You can learn the plugin name, user ID using the plugin, and the service provider name through the in each callback.
@@ -48,32 +48,24 @@
- Lite SDK
-
Starting from this version, Agora introduces the Lite SDK, which includes only the basic audio and video capabilities and partially cuts high-level audio and video processing features, effectively reducing the app size after integrating the SDK.
+ Starting from this version, Agora introduces the Lite SDK, which includes only the basic audio and video capabilities and partially cuts advanced features, effectively reducing the app size after integrating the SDK.
- - Lite SDK supports manual integration or third-party repository integration. For details, see and .
- - For information on dynamic libraries included in the Lite SDK, see .
- - For the list of APIs supported by the Lite SDK, see Lite SDK API ListLite SDK API List.
-
-
+ - Lite SDK supports manual integration or third-party repository integration. For details, see and .
+ - For information on dynamic libraries included in the Lite SDK, see .
+ - For the list of APIs supported by the Lite SDK, see Lite SDK API ListLite SDK API List.
+
- Alpha Transparency Effects
This version introduces the Alpha transparency effects feature, supporting the transmission and rendering of Alpha channel data in video frames for SDK capture and custom capture scenarios, enabling transparent gift effects, custom backgrounds on the receiver end, etc.:
- - and add the alphaBuffer: Set the Alpha channel data.
- - adds the fillAlphaBuffer: For BGRA or RGBA formatted video data, set whether to automatically extract the Alpha channel data and fill it into alphaBuffer.
- - and add the alphaStitchMode: Set the relative position of alphaBuffer and video frame stitching.
+ - and add the alphaBuffer member: Sets the Alpha channel data.
+ - adds the fillAlphaBuffer member: For BGRA or RGBA formatted video data, sets whether to automatically extract the Alpha channel data and fill it into alphaBuffer.
+ - and add the alphaStitchMode member: Sets the relative position of alphaBuffer and video frame stitching.
- Additionally, adds a new member encodeAlpha, which is used to set whether to encode and send Alpha information to the remote end. By default, the SDK does not encode and send Alpha information; if you need to encode and send Alpha information to the remote end (e.g., when virtual background is enabled), explicitly call to set the video encoding properties and set encodeAlpha to .
+ Additionally, adds a new member encodeAlpha, which is used to set whether to encode and send Alpha information to the remote end. By default, the SDK does not encode and send Alpha information; if you need to encode and send Alpha information to the remote end (for example, when virtual background is enabled), explicitly call to set the video encoding properties and set encodeAlpha to .
- AI Voice Tuner
This version introduces the AI Voice Tuner feature, which can enhance the sound quality and tone, similar to a physical sound card. You can enable the AI Voice Tuner feature by calling the method and passing in the sound effect types supported in the enum to achieve effects like deep voice, cute voice, husky singing voice, etc.
- - Copyright Music Optimization
-
- - This version adds the method under the class to set the playback mode of music resources. In online karaoke room scenarios, you can enable accompaniment, original singing, or guide singing mode as needed.
- - This version adds the method under the class to destroy the music player and release the corresponding resources.
- - This version deprecates the method under the class. To destroy the music player, use the new method under the class.
-
-
@@ -93,17 +85,17 @@
Other Improvements
This version also includes the following improvements:
- - Optimized transmission strategy: invoking no longer impacts the security of the transmission link.
- - callback now includes the enumeration, indicating that the display used for screen capture has been disconnected. (Windows, macOS)
+ - Optimized parameter types for the following APIs to enhance code readability, reduce potential errors, and facilitate future maintenance:
+
+ - Deprecated option parameter of type int in , introduced overloaded function with option parameter of type .
+ - Deprecated streamType parameter of type int in , , and , introduced overloaded functions , , and with streamType parameter of type .
+
+ - Optimized transmission strategy: calling no longer impacts the security of the transmission link.
+ - The enumerator is added in callback , indicating that the display used for screen capture has been disconnected. (Windows, macOS)
- Optimized the video link for window sharing, reducing CPU usage. (macOS)
- Improved echo cancellation for screen sharing scenarios.
- Added channelId parameter to , enabling retrieval of the source channel name for sent Metadata.
- Deprecated redundant enumeration values and in .
- - Optimized parameter types for the following APIs to enhance code readability, reduce potential errors, and facilitate future maintenance:
-
- - Deprecated option parameter of type int in , introduced overloaded function with option parameter of type .
- - Deprecated streamType parameter of type int in , , and , introduced overloaded functions , , and with streamType parameter of type .
-
From e96c48270fdda8c343e9e011545e60955b7da08d Mon Sep 17 00:00:00 2001
From: Cilla-luodan <85477033+Cilla-luodan@users.noreply.github.com>
Date: Wed, 10 Jul 2024 16:36:12 +0800
Subject: [PATCH 04/11] delete redundant proto
---
dita/RTC-NG/API/api_irtcengine_geteffectcurrentposition.dita | 2 --
1 file changed, 2 deletions(-)
diff --git a/dita/RTC-NG/API/api_irtcengine_geteffectcurrentposition.dita b/dita/RTC-NG/API/api_irtcengine_geteffectcurrentposition.dita
index 877441bd013..30b5166df42 100644
--- a/dita/RTC-NG/API/api_irtcengine_geteffectcurrentposition.dita
+++ b/dita/RTC-NG/API/api_irtcengine_geteffectcurrentposition.dita
@@ -16,8 +16,6 @@
public int getEffectCurrentPosition(int soundId);
- (int)getEffectCurrentPosition:(int)soundId NS_SWIFT_NAME(getEffectCurrentPosition(_:));
-
- - (int)getEffectCurrentPosition:(int)soundId;
virtual int getEffectCurrentPosition(int soundId) = 0;
UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")
int GetEffectCurrentPosition(int soundId);
From 8315f494cc553873f11228eee3221c86c8cdeab4 Mon Sep 17 00:00:00 2001
From: Suri539
Date: Wed, 10 Jul 2024 16:44:37 +0800
Subject: [PATCH 05/11] modification
---
en-US/dita/RTC-NG/release/release_notes.dita | 17 +++++++++--------
1 file changed, 9 insertions(+), 8 deletions(-)
diff --git a/en-US/dita/RTC-NG/release/release_notes.dita b/en-US/dita/RTC-NG/release/release_notes.dita
index 4f800acf6e3..2d78a84cc48 100644
--- a/en-US/dita/RTC-NG/release/release_notes.dita
+++ b/en-US/dita/RTC-NG/release/release_notes.dita
@@ -10,7 +10,8 @@
Compatibility changes
- This version includes optimizations to some features, including changes to SDK behavior, API renaming, or removal. To ensure your project runs smoothly, you need to update the code in your app after upgrading to this version.
+
This version includes optimizations to some features, including changes to SDK behavior, API renaming and deletion. To ensure normal operation of the project, update the code in the app after upgrading to this release.
+
Starting from v4.4.0, the RTC SDK provides an API sunset notice, which includes information about deprecated and removed APIs in each version. See API Sunset NoticeAPI Sunset NoticeAPI Sunset NoticeAPI Sunset Notice.
- To distinguish context information in different plugin callbacks, this version removes the original plugin-related callbacks and adds corresponding callbacks that can identify plugin context information (see the table below). You can learn the plugin name, user ID using the plugin, and the service provider name through the in each callback.
@@ -37,9 +38,9 @@
- - Before v4.4.0, when your user role was set to audience, calling to set the audio scenario to chatroom () would trigger a microphone permission request popup. From v4.4.0 onwards, the SDK uses native iOS APIs to control the microphone, so audience users in a chatroom scenario will no longer see the microphone permission request popup.
- - This version renames the receiveMetadata callback to and removes the data and timeStamp parameters. You can get metadata-related information, including timeStamp (timestamp of the sent data), uid (user ID), and channelId (source channel name) through the new metadata parameter.
- - This version removes the callback's buffer, uid, and timeStampMs parameters. You can get metadata-related information, including timeStampMs (timestamp of the sent data), uid (user ID), and channelId (source channel name) through the new metadata parameter.
+ - Before v4.4.0, when a user role was set to audience and called to set the audio scenario to chatroom (), the user would see a microphone permission request popup. As of v4.4.0, the SDK uses native iOS APIs to control the microphone, so audience members in a chatroom scenario will no longer receive the microphone permission request popup.
+ - This version renames the receiveMetadata callback to and removes the data and timeStamp parameters. You can get metadata-related information, including timeStamp (timestamp of the sent data), uid (user ID), and channelId (channel name) through the newly-added metadata parameter.
+ - This version removes the buffer, uid, and timeStampMs parameters of the callback. You can get metadata-related information, including timeStampMs (timestamp of the sent data), uid (user ID), and channelId (channel name) through the newly-added metadata parameter.
@@ -85,7 +86,7 @@
Other Improvements
This version also includes the following improvements:
- - Optimized parameter types for the following APIs to enhance code readability, reduce potential errors, and facilitate future maintenance:
+
- Optimized parameter types for the following APIs to enhance code readability, reduce potential errors, and facilitate future maintenance:
- Deprecated option parameter of type int in , introduced overloaded function with option parameter of type .
- Deprecated streamType parameter of type int in , , and , introduced overloaded functions , , and with streamType parameter of type .
@@ -94,7 +95,7 @@
- The enumerator is added in callback , indicating that the display used for screen capture has been disconnected. (Windows, macOS)
- Optimized the video link for window sharing, reducing CPU usage. (macOS)
- Improved echo cancellation for screen sharing scenarios.
- - Added channelId parameter to , enabling retrieval of the source channel name for sent Metadata.
+ - Added the channelId parameter to , which is used to get the channel name from which the metadata is sent.
- Deprecated redundant enumeration values and in .
@@ -109,9 +110,9 @@
- Occasional app crashes occurred when multiple remote users joined the channel simultaneously during real-time interaction. (iOS)
- Remote video occasionally froze or displayed corrupted images when the app returned to the foreground after being in the background for a while. (iOS)
- After the sender called to start direct CDN streaming, frequent switching or toggling of the network occasionally resulted in a black screen on the receiver's end without a streaming failure callback on the sender's end. (iOS)
- - Audio playback failed when pushing external audio data using if the external audio rendering sample rate was not the recommended value by the SDK, such as 22050 Hz and 11025 Hz.
+ - Audio playback failed when pushing external audio data using and the sample rate was not set as a recommended value, such as 22050 Hz and 11025 Hz.