Skip to content

Commit

Permalink
tiny fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
@Cilla-luodan
Cilla-luodan committed Jul 10, 2024
1 parent b967d9b commit c394b85
Showing 1 changed file with 17 additions and 25 deletions.
42 changes: 17 additions & 25 deletions en-US/dita/RTC-NG/release/release_notes.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<title>Compatibility changes</title>
<body>
<p>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.
<note type="attention" props="native">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 <xref href="https://doc.shengwang.cn/api-ref/rtc/android/API/rtc_api_sunset" props="android">API Deprecation Notice</xref><xref href="https://doc.shengwang.cn/api-ref/rtc/android/API/rtc_api_sunset" props="cpp">API Deprecation Notice</xref><xref href="https://doc.shengwang.cn/api-ref/rtc/ios/API/rtc_api_sunset" props="ios">API Deprecation Notice</xref><xref href="https://doc.shengwang.cn/api-ref/rtc/macos/API/rtc_api_sunset" props="mac">API Deprecation Notice</xref>.</note></p>
<note type="attention" props="native">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 <xref href="https://doc.shengwang.cn/api-ref/rtc/android/API/rtc_api_sunset" props="android">API Sunset Notice</xref><xref href="https://doc.shengwang.cn/api-ref/rtc/android/API/rtc_api_sunset" props="cpp">API Sunset Notice</xref><xref href="https://doc.shengwang.cn/api-ref/rtc/ios/API/rtc_api_sunset" props="ios">API Sunset Notice</xref><xref href="https://doc.shengwang.cn/api-ref/rtc/macos/API/rtc_api_sunset" props="mac">API Sunset Notice</xref>.</note></p>
<ol>
<li>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 <apiname keyref="ExtensionContext"/> in each callback.
<simpletable frame="all" relcolwidth="1* 1*" id="simpletable_zqj_n1t_xbc">
Expand Down Expand Up @@ -48,32 +48,24 @@
<body>
<ol>
<li props="android ios"><ph><b>Lite SDK</b></ph>
<p>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.</p>
<p>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.</p>
<ul>
<li>Lite SDK supports manual integration or third-party repository integration. For details, see <xref keyref="resource"/> and <xref keyref="quick-start"/>.</li>
<li>For information on dynamic libraries included in the Lite SDK, see <xref keyref="reduce-app-size"/>.</li>
<li>For the list of APIs supported by the Lite SDK, see <xref href="https://doc.shengwang.cn/api-ref/rtc/android/API/rtc_lite_api" props="android">Lite SDK API List</xref><xref href="https://doc.shengwang.cn/api-ref/rtc/ios/API/rtc_lite_api" props="ios">Lite SDK API List</xref>.</li>
</ul>
</li>
<li>Lite SDK supports manual integration or third-party repository integration. For details, see <xref keyref="resource"/> and <xref keyref="quick-start"/>.</li>
<li>For information on dynamic libraries included in the Lite SDK, see <xref keyref="reduce-app-size"/>.</li>
<li>For the list of APIs supported by the Lite SDK, see <xref href="https://doc.shengwang.cn/api-ref/rtc/android/API/rtc_lite_api" props="android">Lite SDK API List</xref><xref href="https://doc.shengwang.cn/api-ref/rtc/ios/API/rtc_lite_api" props="ios">Lite SDK API List</xref>.</li>
</ul> </li>
<li><ph><b>Alpha Transparency Effects</b></ph>
<p>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.:</p>
<ul>
<li><apiname keyref="VideoFrame"/> and <apiname keyref="ExternalVideoFrame"/> add the <codeph>alphaBuffer</codeph>: Set the Alpha channel data.</li>
<li><apiname keyref="ExternalVideoFrame"/> adds the <codeph>fillAlphaBuffer</codeph>: For BGRA or RGBA formatted video data, set whether to automatically extract the Alpha channel data and fill it into <codeph>alphaBuffer</codeph>.</li>
<li><apiname keyref="VideoFrame"/> and <apiname keyref="ExternalVideoFrame"/> add the <codeph>alphaStitchMode</codeph>: Set the relative position of <codeph>alphaBuffer</codeph> and video frame stitching.</li>
<li><apiname keyref="VideoFrame"/> and <apiname keyref="ExternalVideoFrame"/> add the <codeph>alphaBuffer</codeph> member: Sets the Alpha channel data.</li>
<li><apiname keyref="ExternalVideoFrame"/> adds the <codeph>fillAlphaBuffer</codeph> member: For BGRA or RGBA formatted video data, sets whether to automatically extract the Alpha channel data and fill it into <codeph>alphaBuffer</codeph>.</li>
<li><apiname keyref="VideoFrame"/> and <apiname keyref="ExternalVideoFrame"/> add the <codeph>alphaStitchMode</codeph> member: Sets the relative position of <codeph>alphaBuffer</codeph> and video frame stitching.</li>
</ul>
<p>Additionally, <apiname keyref="AdvanceOptions"/> adds a new member <codeph>encodeAlpha</codeph>, 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 <apiname keyref="setVideoEncoderConfiguration"/> to set the video encoding properties and set <codeph>encodeAlpha</codeph> to <codeph><ph keyref="true"/></codeph>.</p>
<p>Additionally, <apiname keyref="AdvanceOptions"/> adds a new member <codeph>encodeAlpha</codeph>, 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 <apiname keyref="setVideoEncoderConfiguration"/> to set the video encoding properties and set <codeph>encodeAlpha</codeph> to <codeph><ph keyref="true"/></codeph>.</p>
</li>
<li><ph><b>AI Voice Tuner</b></ph>
<p>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 <apiname keyref="setVoiceAITuner"/> method and passing in the sound effect types supported in the <apiname keyref="VOICE_AI_TUNER_TYPE"/> enum to achieve effects like deep voice, cute voice, husky singing voice, etc.</p>
</li>
<li props="ios android"><ph><b>Copyright Music Optimization</b></ph>
<ul>
<li>This version adds the <apiname keyref="setPlayMode"/> method under the <apiname keyref="IMusicPlayer"/> 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.</li>
<li props="ios">This version adds the <apiname keyref="destroyMusicPlayer"/> method under the <apiname keyref="IMusicContentCenter"/> class to destroy the music player and release the corresponding resources.</li>
<li props="android">This version deprecates the <apiname keyref="destroy_IMusicPlayer"/> method under the <apiname keyref="IMusicPlayer"/> class. To destroy the music player, use the new <apiname keyref="destroyMusicPlayer"/> method under the <apiname keyref="IMusicContentCenter"/> class.</li>
</ul>
</li>
</ol>
</body>
</topic>
Expand All @@ -93,17 +85,17 @@
<li><ph><b>Other Improvements</b></ph>
<p>This version also includes the following improvements:
<ul>
<li>Optimized transmission strategy: invoking <apiname keyref="enableInstantMediaRendering"/> no longer impacts the security of the transmission link.</li>
<li props="cpp mac electron unity flutter unreal bp"><apiname keyref="onLocalVideoStateChanged"/> callback now includes the <apiname keyref="LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_DISPLAY_DISCONNECTED"/> enumeration, indicating that the display used for screen capture has been disconnected. (Windows, macOS)</li>
<li props="android">Optimized parameter types for the following APIs to enhance code readability, reduce potential errors, and facilitate future maintenance:
<ul>
<li>Deprecated <codeph>option</codeph> parameter of type int in <apiname keyref="setRemoteSubscribeFallbackOption"/>, introduced overloaded function <apiname keyref="setRemoteSbscribeFallbackOption2"/> with <codeph>option</codeph> parameter of type <apiname keyref="STREAM_FALLBACK_OPTIONS"/>.</li>
<li>Deprecated <codeph>streamType</codeph> parameter of type int in <apiname keyref="setRemoteVideoStreamType"/>, <apiname keyref="setRemoteDefaultVideoStreamType"/>, and <apiname keyref="setRemoteVideoStreamTypeEx"/>, introduced overloaded functions <apiname keyref="setRemoteVideoStreamType2"/>, <apiname keyref="setRemoteDefaultVideoStreamType2"/>, and <apiname keyref="setRemoteVideoStreamTypeEx2"/> with <codeph>streamType</codeph> parameter of type <apiname keyref="VIDEO_STREAM_TYPE"/>.</li>
</ul></li>
<li>Optimized transmission strategy: calling <apiname keyref="enableInstantMediaRendering"/> no longer impacts the security of the transmission link.</li>
<li props="cpp mac electron unity flutter unreal bp">The <apiname keyref="LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_DISPLAY_DISCONNECTED"/> enumerator is added in <apiname keyref="onLocalVideoStateChanged"/> callback , indicating that the display used for screen capture has been disconnected. (Windows, macOS)</li>
<li props="mac electron unity flutter unreal bp">Optimized the video link for window sharing, reducing CPU usage. (macOS)</li>
<li props="cpp unity flutter electron unreal">Improved echo cancellation for screen sharing scenarios.</li>
<li props="cpp framework">Added <codeph>channelId</codeph> parameter to <apiname keyref="Metadata"/>, enabling retrieval of the source channel name for sent Metadata.</li>
<li>Deprecated redundant enumeration values <apiname keyref="CLIENT_ROLE_CHANGE_FAILED_REQUEST_TIME_OUT"/> and <apiname keyref="CLIENT_ROLE_CHANGE_FAILED_CONNECTION_FAILED"/> in <apiname keyref="CLIENT_ROLE_CHANGE_FAILED_REASON"/>.</li>
<li props="android">Optimized parameter types for the following APIs to enhance code readability, reduce potential errors, and facilitate future maintenance:
<ul>
<li>Deprecated <codeph>option</codeph> parameter of type int in <apiname keyref="setRemoteSubscribeFallbackOption"/>, introduced overloaded function <apiname keyref="setRemoteSbscribeFallbackOption2"/> with <codeph>option</codeph> parameter of type <apiname keyref="STREAM_FALLBACK_OPTIONS"/>.</li>
<li>Deprecated <codeph>streamType</codeph> parameter of type int in <apiname keyref="setRemoteVideoStreamType"/>, <apiname keyref="setRemoteDefaultVideoStreamType"/>, and <apiname keyref="setRemoteVideoStreamTypeEx"/>, introduced overloaded functions <apiname keyref="setRemoteVideoStreamType2"/>, <apiname keyref="setRemoteDefaultVideoStreamType2"/>, and <apiname keyref="setRemoteVideoStreamTypeEx2"/> with <codeph>streamType</codeph> parameter of type <apiname keyref="VIDEO_STREAM_TYPE"/>.</li>
</ul></li>
</ul></p>
</li>
</ol>
Expand Down

0 comments on commit c394b85

Please sign in to comment.