Skip to content

Commit

Permalink
add codeph tag
Browse files Browse the repository at this point in the history
  • Loading branch information
@Cilla-luodan
Cilla-luodan committed Jul 10, 2024
1 parent f0d7aa4 commit b967d9b
Showing 1 changed file with 23 additions and 23 deletions.
46 changes: 23 additions & 23 deletions dita/RTC-NG/release/release_notes.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,33 +13,33 @@
<p>该版本对部分功能的实现方式进行了优化，包括 SDK 的行为变更、API 的改名或删除，为确保项目的正常运行，你需要在升级到该版本后更新 App 中的代码。
<note type="attention" props="native">自 v4.4.0 起，RTC SDK 提供 API 下架说明，包含各版本废弃及删除的 API 信息。详见 <xref href="https://doc.shengwang.cn/api-ref/rtc/android/API/rtc_api_sunset" props="android">API 下架说明</xref><xref href="https://doc.shengwang.cn/api-ref/rtc/android/API/rtc_api_sunset" props="cpp">API 下架说明</xref><xref href="https://doc.shengwang.cn/api-ref/rtc/ios/API/rtc_api_sunset" props="ios">API 下架说明</xref><xref href="https://doc.shengwang.cn/api-ref/rtc/macos/API/rtc_api_sunset" props="mac">API 下架说明</xref>。</note></p>
<ol>
<li>为区分不同插件回调中的上下文信息，该版本将原有的插件相关回调删除并新增可标识插件上下文信息的对应回调（见下表），你可以通过各回调中的 <apiname keyref="ExtensionContext"/> 了解插件的名称、使用该插件的用户 ID、和提供插件的服务商名等信息。
<li>为区分不同插件回调中的上下文信息，该版本将原有的插件相关回调删除并新增可标识插件上下文信息的对应回调（见下表），你可以通过各回调中的 <codeph><apiname keyref="ExtensionContext"/></codeph> 了解插件的名称、使用该插件的用户 ID、和提供插件的服务商名等信息。
<simpletable frame="all" relcolwidth="1* 1*" id="simpletable_zqj_n1t_xbc">
<sthead>
<stentry>原有回调</stentry>
<stentry>现有回调</stentry>
</sthead>
<strow>
<stentry>onExtensionEvent</stentry>
<stentry><apiname keyref="onExtensionEventWithContext"/></stentry>
<stentry><codeph><apiname keyref="onExtensionEventWithContext"/></codeph></stentry>
</strow>
<strow>
<stentry>onExtensionStarted</stentry>
<stentry><apiname keyref="onExtensionStartedWithContext"/></stentry>
<stentry><codeph><apiname keyref="onExtensionStartedWithContext"/></codeph></stentry>
</strow>
<strow>
<stentry>onExtensionStopped</stentry>
<stentry><apiname keyref="onExtensionStoppedWithContext"/></stentry>
<stentry><codeph><apiname keyref="onExtensionStoppedWithContext"/></codeph></stentry>
</strow>
<strow>
<stentry>onExtensionError</stentry>
<stentry><apiname keyref="onExtensionErrorWithContext"/></stentry>
<stentry><codeph><apiname keyref="onExtensionErrorWithContext"/></codeph></stentry>
</strow>
</simpletable>
</li>
<li props="ios">在 v4.4.0 之前，当你的用户角色为观众时，调用 <apiname keyref="setAudioScenario"/> 将音频场景设为聊天室场景（<apiname keyref="AUDIO_SCENARIO_CHATROOM"/>）会收到申请麦克风权限的弹窗提示。自 v4.4.0 起，SDK 通过 iOS 原生的 API 控制麦克风开关，因此观众角色在聊天室场景下不会再收到申请麦克风权限的弹窗。</li>
<li props="apple">改版本将 <codeph>receiveMetadata</codeph> 回调改名为 <apiname keyref="onMetadataReceived"/>，并删除了回调中的 <codeph>data</codeph>、<codeph>timeStamp</codeph> 参数，你可以通过新增的 <codeph>metadata</codeph> 参数来获取 Metadata 的相关信息，包括 <codeph>timeStamp</codeph>（发送数据的时间戳）、<codeph>uid</codeph>（用户 ID）、<codeph>channelId</codeph>（源频道名称）等。</li>
<li props="android">改版本删除了 <apiname keyref="onMetadataReceived"/> 回调中的 <codeph>buffer</codeph>、<codeph>uid</codeph>、<codeph>timeStampMs</codeph> 参数，你可以通过新增的 <codeph>metadata</codeph> 参数来获取 Metadata 的相关信息，包括 <codeph>timeStampMs</codeph>（发送数据的时间戳）、<codeph>uid</codeph>（用户 ID）、<codeph>channelId</codeph>（源频道名称）等。</li>
<li props="ios">在 v4.4.0 之前，当你的用户角色为观众时，调用 <codeph><apiname keyref="setAudioScenario"/></codeph> 将音频场景设为聊天室场景（<codeph><apiname keyref="AUDIO_SCENARIO_CHATROOM"/></codeph>）会收到申请麦克风权限的弹窗提示。自 v4.4.0 起，SDK 通过 iOS 原生的 API 控制麦克风开关，因此观众角色在聊天室场景下不会再收到申请麦克风权限的弹窗。</li>
<li props="apple">改版本将 <codeph>receiveMetadata</codeph> 回调改名为 <codeph><apiname keyref="onMetadataReceived"/></codeph>，并删除了回调中的 <codeph>data</codeph>、<codeph>timeStamp</codeph> 参数，你可以通过新增的 <codeph>metadata</codeph> 参数来获取 Metadata 的相关信息，包括 <codeph>timeStamp</codeph>（发送数据的时间戳）、<codeph>uid</codeph>（用户 ID）、<codeph>channelId</codeph>（源频道名称）等。</li>
<li props="android">改版本删除了 <codeph><apiname keyref="onMetadataReceived"/></codeph> 回调中的 <codeph>buffer</codeph>、<codeph>uid</codeph>、<codeph>timeStampMs</codeph> 参数，你可以通过新增的 <codeph>metadata</codeph> 参数来获取 Metadata 的相关信息，包括 <codeph>timeStampMs</codeph>（发送数据的时间戳）、<codeph>uid</codeph>（用户 ID）、<codeph>channelId</codeph>（源频道名称）等。</li>
</ol>
</body>
</topic>
Expand All @@ -57,20 +57,20 @@
<li><ph><b>Alpha 透明特效</b></ph>
<p>该版本新增 Alpha 透明特效功能，支持在 SDK 采集和自定义采集视频的场景下，在发送端发布视频帧的 Alpha 通道、在接收端对 Alpha 通道进行渲染处理，实现透明礼物特效、接收端自定义主播背景等：</p>
<ul>
<li><apiname keyref="VideoFrame"/> 和 <apiname keyref="ExternalVideoFrame"/> 中新增 <codeph>alphaBuffer</codeph>：设置 Alpha 通道数据。</li>
<li><apiname keyref="ExternalVideoFrame"/> 中新增 <codeph>fillAlphaBuffer</codeph>：对于 BGRA 或 RGBA 格式的视频数据，设置是否自动提取 Alpha 通道数据并填入到 <codeph>alphaBuffer</codeph> 中。</li>
<li><apiname keyref="VideoFrame"/> 和 <apiname keyref="ExternalVideoFrame"/> 中中新增 <codeph>alphaStitchMode</codeph>：设置 <codeph>alphaBuffer</codeph> 和视频帧拼接的相对位置。</li>
<li><codeph><apiname keyref="VideoFrame"/></codeph> 和 <codeph><apiname keyref="ExternalVideoFrame"/></codeph> 中新增 <codeph>alphaBuffer</codeph>：设置 Alpha 通道数据。</li>
<li><codeph><apiname keyref="ExternalVideoFrame"/></codeph> 中新增 <codeph>fillAlphaBuffer</codeph>：对于 BGRA 或 RGBA 格式的视频数据，设置是否自动提取 Alpha 通道数据并填入到 <codeph>alphaBuffer</codeph> 中。</li>
<li><codeph><apiname keyref="VideoFrame"/></codeph> 和 <codeph><apiname keyref="ExternalVideoFrame"/></codeph> 中新增 <codeph>alphaStitchMode</codeph>：设置 <codeph>alphaBuffer</codeph> 和视频帧拼接的相对位置。</li>
</ul>
<p>另外，<apiname keyref="AdvanceOptions"/> 中新增成员 <codeph>encodeAlpha</codeph>，用于设置是否将 Alpha 信息编码并发送到远端。SDK 默认不对 Alpha 信息进行编码发送；如果需要对 Alpha 信息编码发送至远端（例如开启了虚拟背景功能），请显式调用 <apiname keyref="setVideoEncoderConfiguration"/> 设置视频编码属性，并将 <codeph>encodeAlpha</codeph> 设置为 <codeph><ph keyref="true"/></codeph>。</p>
<p>另外，<codeph><apiname keyref="AdvanceOptions"/></codeph> 中新增成员 <codeph>encodeAlpha</codeph>，用于设置是否将 Alpha 信息编码并发送到远端。SDK 默认不对 Alpha 信息进行编码发送；如果需要对 Alpha 信息编码发送至远端（例如开启了虚拟背景功能），请显式调用 <codeph><apiname keyref="setVideoEncoderConfiguration"/></codeph> 设置视频编码属性，并将 <codeph>encodeAlpha</codeph> 设置为 <codeph><ph keyref="true"/></codeph>。</p>
</li>
<li><ph><b>AI 调音器</b></ph>
<p>该版本新增 AI 调音器功能，可以实现类似物理声卡对音质和音色的提升。你可以通过调用 <apiname keyref="setVoiceAITuner"/> 方法并传入 <apiname keyref="VOICE_AI_TUNER_TYPE"/> 枚举中支持的音效类型来启用 AI 调音器功能，实现大叔音、萝莉音、烟嗓歌声等声音效果。</p>
<p>该版本新增 AI 调音器功能，可以实现类似物理声卡对音质和音色的提升。你可以通过调用 <codeph><apiname keyref="setVoiceAITuner"/></codeph> 方法并传入 <codeph><apiname keyref="VOICE_AI_TUNER_TYPE"/></codeph> 枚举中支持的音效类型来启用 AI 调音器功能，实现大叔音、萝莉音、烟嗓歌声等声音效果。</p>
</li>
<li props="ios android"><ph><b>版权音乐优化</b></ph>
<ul>
<li>该版本在 <apiname keyref="IMusicPlayer"></apiname> 类下新增 <apiname keyref="setPlayMode"/> 方法，用于设置音乐资源的播放模式。在在线 K 歌房等场景下，你可以根据需求启用伴唱、原唱或导唱模式。</li>
<li props="ios">该版本在 <apiname keyref="IMusicContentCenter"/> 类下新增 <apiname keyref="destroyMusicPlayer"/> 方法，用于销毁音乐播放器并释放相应的资源。</li>
<li props="android">该版本废弃了 <apiname keyref="IMusicPlayer"></apiname> 类下的 <apiname keyref="destroy_IMusicPlayer"/> 方法。如需销毁音乐播放器，请改用<apiname keyref="IMusicContentCenter"/> 类下新增 <apiname keyref="destroyMusicPlayer"/> 方法。</li>
<li>该版本在 <apiname keyref="IMusicPlayer"></apiname> 类下新增 <codeph><apiname keyref="setPlayMode"/></codeph> 方法，用于设置音乐资源的播放模式。在在线 K 歌房等场景下，你可以根据需求启用伴唱、原唱或导唱模式。</li>
<li props="ios">该版本在 <codeph><apiname keyref="IMusicContentCenter"/></codeph> 类下新增 <codeph><apiname keyref="destroyMusicPlayer"/></codeph> 方法，用于销毁音乐播放器并释放相应的资源。</li>
<li props="android">该版本废弃了 <apiname keyref="IMusicPlayer"></apiname> 类下的 <codeph><apiname keyref="destroy_IMusicPlayer"/></codeph> 方法。如需销毁音乐播放器，请改用<codeph><apiname keyref="IMusicContentCenter"/></codeph> 类下新增 <codeph><apiname keyref="destroyMusicPlayer"/></codeph> 方法。</li>
</ul>
</li>
</ol>
Expand All @@ -92,15 +92,15 @@
<li><ph><b>其他改进</b></ph>
<p>该版本还进行了如下改进：
<ul>
<li>优化了传输策略，调用 <apiname keyref="enableInstantMediaRendering"/> 不再对传输链路的安全性产生影响。</li>
<li props="cpp mac electron unity flutter unreal bp"><apiname keyref="onLocalVideoStateChanged"/> 回调中新增 <apiname keyref="LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_DISPLAY_DISCONNECTED"/> 枚举，表示进行屏幕采集的显示器已断开连接。(Windows, macOS)</li>
<li>优化了传输策略，调用 <codeph><apiname keyref="enableInstantMediaRendering"/></codeph> 不再对传输链路的安全性产生影响。</li>
<li props="cpp mac electron unity flutter unreal bp"><codeph><apiname keyref="onLocalVideoStateChanged"/></codeph> 回调中新增 <codeph><apiname keyref="LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_DISPLAY_DISCONNECTED"/></codeph> 枚举，表示进行屏幕采集的显示器已断开连接。(Windows, macOS)</li>
<li props="mac electron unity flutter unreal bp">优化了共享窗口的视频链路，降低了 CPU 占用率。(macOS) </li>
<li props="cpp unity flutter electron unreal">优化了屏幕共享场景下的回声消除。</li>
<li props="cpp framework">该版本在 <apiname keyref="Metadata"/> 中新增 <codeph>channelId</codeph> 参数，用于获取发送 Metadata 的源频道名称。</li>
<li>废弃了 <apiname keyref="CLIENT_ROLE_CHANGE_FAILED_REASON"/> 中的冗余枚举值 <apiname keyref="CLIENT_ROLE_CHANGE_FAILED_REQUEST_TIME_OUT"/>、<apiname keyref="CLIENT_ROLE_CHANGE_FAILED_CONNECTION_FAILED"/>。</li>
<li props="cpp framework">该版本在 <codeph><apiname keyref="Metadata"/></codeph> 中新增 <codeph>channelId</codeph> 参数，用于获取发送 Metadata 的源频道名称。</li>
<li>废弃了 <codeph><apiname keyref="CLIENT_ROLE_CHANGE_FAILED_REASON"/></codeph> 中的冗余枚举值 <codeph><apiname keyref="CLIENT_ROLE_CHANGE_FAILED_REQUEST_TIME_OUT"/></codeph>、<codeph><apiname keyref="CLIENT_ROLE_CHANGE_FAILED_CONNECTION_FAILED"/></codeph>。</li>
<li props="android">优化了以下 API 的参数类型。此改进有助于提升代码的可读性，减少潜在的错误，并便于后续维护。<ul>
<li>废弃了 <codeph>option</codeph> 参数为 int 类型的 <apiname keyref="setRemoteSubscribeFallbackOption"/>，新增了 <codeph>option</codeph> 参数为 <apiname keyref="STREAM_FALLBACK_OPTIONS"/> 类型的重载函数 <apiname keyref="setRemoteSbscribeFallbackOption2"/>。</li>
<li>废弃了 <codeph>streamType</codeph> 参数为 int 类型的 <apiname keyref="setRemoteVideoStreamType"/>、<apiname keyref="setRemoteDefaultVideoStreamType"/>、<apiname keyref="setRemoteVideoStreamTypeEx"/>，新增了 <codeph>streamType</codeph> 参数为 <apiname keyref="VIDEO_STREAM_TYPE"/> 类型的重载函数 <apiname keyref="setRemoteVideoStreamType2"/>、<apiname keyref="setRemoteDefaultVideoStreamType2"/>、<apiname keyref="setRemoteVideoStreamTypeEx2"/>。</li></ul></li>
<li>废弃了 <codeph>option</codeph> 参数为 int 类型的 <codeph><apiname keyref="setRemoteSubscribeFallbackOption"/></codeph>，新增了 <codeph>option</codeph> 参数为 <codeph><apiname keyref="STREAM_FALLBACK_OPTIONS"/></codeph> 类型的重载函数 <codeph><apiname keyref="setRemoteSbscribeFallbackOption2"/></codeph>。</li>
<li>废弃了 <codeph>streamType</codeph> 参数为 int 类型的 <codeph><apiname keyref="setRemoteVideoStreamType"/></codeph>、<codeph><apiname keyref="setRemoteDefaultVideoStreamType"/></codeph>、<codeph><apiname keyref="setRemoteVideoStreamTypeEx"/></codeph>，新增了 <codeph>streamType</codeph> 参数为 <codeph><apiname keyref="VIDEO_STREAM_TYPE"/></codeph> 类型的重载函数 <codeph><apiname keyref="setRemoteVideoStreamType2"/></codeph>、<codeph><apiname keyref="setRemoteDefaultVideoStreamType2"/></codeph>、<codeph><apiname keyref="setRemoteVideoStreamTypeEx2"/></codeph>。</li></ul></li>
</ul></p>
</li>
</ol>
Expand All @@ -113,7 +113,7 @@
<ul>
<li props="ios rn unity flutter unreal bp">在实时互动过程中，当多个远端同时加入频道时 App 偶现崩溃。(iOS)</li>
<li props="ios rn unity flutter unreal bp">App 切后台一段时间、然后返回前台时，远端视频画面偶现卡住或花屏。(iOS)</li>
<li props="ios rn unity flutter unreal bp">发送端调用 <apiname keyref="startDirectCdnStreaming"/> 开始直接向 CDN 推流后，频繁开关或切换网络，偶现接收端黑屏但发送端未收到推流失败回调。(iOS)</li>
<li props="ios rn unity flutter unreal bp">发送端调用 <codeph><apiname keyref="startDirectCdnStreaming"/></codeph> 开始直接向 CDN 推流后，频繁开关或切换网络，偶现接收端黑屏但发送端未收到推流失败回调。(iOS)</li>
<li props="android ios unity flutter rn unreal bp">调用 <xref keyref="pushAudioFrame" props="unity flutter rn unreal bp"/><xref keyref="pushAudioFrame2" props="android ios"/> 推送外部音频数据，外部音频渲染的采样率如果不是 SDK 推荐的值时，比如 22050 Hz 和 11025 Hz，声音播放失败。</li>
</ul>
</body>
Expand Down

0 comments on commit b967d9b

Please sign in to comment.