[beauty] update after review

AgoraIO · Sep 25, 2023 · 9a57bd6 · 9a57bd6
1 parent a0469c7
commit 9a57bd6
Show file tree

Hide file tree

Showing 11 changed files with 30 additions and 30 deletions.
diff --git a/markdown/beauty/商汤/1.0.1.1/beauty_integration_sensetime_android.md b/markdown/beauty/商汤/1.0.1.1/beauty_integration_sensetime_android.md
@@ -60,7 +60,7 @@
    ...
     dependencies {
         ...
-        // x.y.z，请填写具体的 SDK 版本号，如：4.0.0 或 4.1.0-1。
+        // x.y.z，请填写具体的 RTC SDK 版本号，如：4.0.0 或 4.1.0-1。
         // 通过互动直播产品发版说明获取最新版本号。
         implementation 'io.agora.rtc:full-sdk:x.y.z'
      }
@@ -149,7 +149,7 @@ private val mSTRenderKit by lazy {
 
 ### 3. 初始化 Beauty API
 
-调用 `createSenseTimeBeautyAPI` 创建 Beauty API 对象。Beauty API 对象是声网基于 `STRenderKit` 对象封装。
+调用 `createSenseTimeBeautyAPI` 创建 Beauty API 对象。Beauty API 对象基于 `STRenderKit` 对象封装。
 
 ```kotlin
 // 创建 Beauty API 对象
@@ -275,7 +275,7 @@ mRtcEngine.registerVideoFrameObserver(object : IVideoFrameObserver {
 
 调用 `RtcEngine` 类的 `joinChannel` 加入频道，同时传入如下参数：
 
-- `token`：用于鉴权的动态密钥。如果在[创建声网项目](#创建声网项目)时启用**调试模式**，那么 将 `token` 参数传空。如果启用**安全模式**，那么你先参考[使用 Token 鉴权](https://docportal.shengwang.cn/cn/live-streaming-premium-4.x/token_server_android_ng?platform=Android)在你的业务服务端生成 Token，然后将生成的 Token 传入该参数。
+- `token`：用于鉴权的动态密钥。如果在[创建声网项目](#创建声网项目)时启用**调试模式**，那么将 `token` 参数传空。如果启用**安全模式**，那么你先参考[使用 Token 鉴权](https://docportal.shengwang.cn/cn/live-streaming-premium-4.x/token_server_android_ng?platform=Android)在你的业务服务端生成 Token，然后将生成的 Token 传入该参数。
 - `channelId`：频道名。
 - `options`：频道媒体设置选项。
 

diff --git a/markdown/beauty/商汤/1.0.1.1/beauty_integration_sensetime_ios.md b/markdown/beauty/商汤/1.0.1.1/beauty_integration_sensetime_ios.md
@@ -73,7 +73,7 @@
     platform :ios, '9.0'
     # 替换成你的 target 名称
     target 'Your App' do
-    # x.y.z 请填写具体的 SDK 版本号，如 4.0.1 或 4.0.0.4
+    # x.y.z 请填写具体的 RTC SDK 版本号，如 4.0.1 或 4.0.0.4
     # 可通过互动直播发版说明获取最新版本号
     pod 'AgoraRtcEngine_iOS', 'x.y.z'
     # 配置商汤美颜的依赖库
@@ -92,7 +92,7 @@
 
 ### 1. 初始化 AgoraRtcEngineKit
 
-调用声网 RTC SDK 中的 `sharedEngineWithConfig` 创建并初始化 `AgoraRtcEngineKit` 对象。同时调用 `enableVideo` 开启声网 SDK 的视频模块。
+调用声网 RTC SDK 中的 `sharedEngineWithConfig` 创建并初始化 `AgoraRtcEngineKit` 对象。调用 `enableVideo` 开启声网 SDK 的视频模块。
 
 ```swift
 // 初始化 AgoraRtcEngineKit
@@ -116,7 +116,7 @@ private lazy var rtcEngine: AgoraRtcEngineKit = {
 
 ### 2. 初始化美颜和 Beauty API
 
-创建 SenseBeautyRender 和 Beauty API 对象。Beauty API 对象是声网基于 `SenseBeautyRender` 对象封装。
+创建 SenseBeautyRender 和 Beauty API 对象。Beauty API 对象基于 `SenseBeautyRender` 对象封装。
 
 
 ```swift
@@ -234,7 +234,7 @@ extension BeautyViewController: AgoraVideoFrameDelegate {
 
 调用 `AgoraRtcEngineKit` 类的 `joinChannelByToken` 加入频道，同时传入如下参数：
 
-- `token`：用于鉴权的动态密钥。如果在[创建声网项目](#创建声网项目)时启用**调试模式**，那么 将 `token` 参数传空。如果启用**安全模式**，那么你先参考[使用 Token 鉴权](https://docportal.shengwang.cn/cn/live-streaming-premium-4.x/token_server_android_ng?platform=Android)在你的业务服务端生成 Token，然后将生成的 Token 传入该参数。
+- `token`：用于鉴权的动态密钥。如果在[创建声网项目](#创建声网项目)时启用**调试模式**，那么将 `token` 参数传空。如果启用**安全模式**，那么你先参考[使用 Token 鉴权](https://docportal.shengwang.cn/cn/live-streaming-premium-4.x/token_server_ios_ng?platform=iOS)在你的业务服务端生成 Token，然后将生成的 Token 传入该参数。
 - `channelId`：频道名。
 - `mediaOptions`：频道媒体设置选项。
 

diff --git a/markdown/beauty/商汤/1.0.1.1/beauty_run_github_project_sensetime_ios.md b/markdown/beauty/商汤/1.0.1.1/beauty_run_github_project_sensetime_ios.md
@@ -21,7 +21,7 @@
 运行以下命令克隆仓库到本地：
 
 ```shell
-git clone [email protected]:AgoraIO-Usecase/agora-ent-scenarios.git
+git clone [email protected]:AgoraIO-Community/BeautyAPI.git
 ```
 
 ## 集成第三方美颜 SDK

diff --git a/markdown/beauty/商汤/1.0.2/beauty_integration_sensetime_android.md b/markdown/beauty/商汤/1.0.2/beauty_integration_sensetime_android.md
@@ -60,7 +60,7 @@
    ...
     dependencies {
         ...
-        // x.y.z，请填写具体的 SDK 版本号，如：4.0.0 或 4.1.0-1。
+        // x.y.z，请填写具体的 RTC SDK 版本号，如：4.0.0 或 4.1.0-1。
         // 通过互动直播产品发版说明获取最新版本号。
         implementation 'io.agora.rtc:full-sdk:x.y.z'
      }
@@ -219,7 +219,7 @@ fun initMobileEffect(context: Context){
 
 ### 3. 初始化 Beauty API
 
-调用 `createSenseTimeBeautyAPI` 创建 Beauty API 对象。Beauty API 对象是声网基于 `STMobileHumanActionNative` 和 `STMobileEffectNative` 对象封装。
+调用 `createSenseTimeBeautyAPI` 创建 Beauty API 对象。Beauty API 对象基于 `STMobileHumanActionNative` 和 `STMobileEffectNative` 对象封装。
 
 ```kotlin
 // 创建 Beauty API 对象
@@ -337,7 +337,7 @@ mRtcEngine.registerVideoFrameObserver(object : IVideoFrameObserver {
 
 调用 `RtcEngine` 类的 `joinChannel` 加入频道，同时传入如下参数：
 
-- `token`：用于鉴权的动态密钥。如果在[创建声网项目](#创建声网项目)时启用**调试模式**，那么 将 `token` 参数传空。如果启用**安全模式**，那么你先参考[使用 Token 鉴权](https://docportal.shengwang.cn/cn/live-streaming-premium-4.x/token_server_android_ng?platform=Android)在你的业务服务端生成 Token，然后将生成的 Token 传入该参数。
+- `token`：用于鉴权的动态密钥。如果在[创建声网项目](#创建声网项目)时启用**调试模式**，那么将 `token` 参数传空。如果启用**安全模式**，那么你先参考[使用 Token 鉴权](https://docportal.shengwang.cn/cn/live-streaming-premium-4.x/token_server_android_ng?platform=Android)在你的业务服务端生成 Token，然后将生成的 Token 传入该参数。
 - `channelId`：频道名。
 - `options`：频道媒体设置选项。
 

diff --git a/markdown/beauty/商汤/1.0.2/beauty_integration_sensetime_ios.md b/markdown/beauty/商汤/1.0.2/beauty_integration_sensetime_ios.md
@@ -73,7 +73,7 @@
     platform :ios, '9.0'
     # 替换成你的 target 名称
     target 'Your App' do
-    # x.y.z 请填写具体的 SDK 版本号，如 4.0.1 或 4.0.0.4
+    # x.y.z 请填写具体的 RTC SDK 版本号，如 4.0.1 或 4.0.0.4
     # 可通过互动直播发版说明获取最新版本号
     pod 'AgoraRtcEngine_iOS', 'x.y.z'
     # 配置商汤美颜的依赖库
@@ -92,7 +92,7 @@
 
 ### 1. 初始化 AgoraRtcEngineKit
 
-调用声网 RTC SDK 中的 `sharedEngineWithConfig` 创建并初始化 `AgoraRtcEngineKit` 对象。同时调用 `enableVideo` 开启声网 SDK 的视频模块。
+调用声网 RTC SDK 中的 `sharedEngineWithConfig` 创建并初始化 `AgoraRtcEngineKit` 对象。调用 `enableVideo` 开启声网 SDK 的视频模块。
 
 ```swift
 // 初始化 AgoraRtcEngineKit
@@ -116,7 +116,7 @@ private lazy var rtcEngine: AgoraRtcEngineKit = {
 
 ### 2. 初始化美颜和 Beauty API
 
-创建 SenseBeautyRender 和 Beauty API 对象。Beauty API 对象是声网基于 `SenseBeautyRender` 对象封装。
+创建 SenseBeautyRender 和 Beauty API 对象。Beauty API 对象基于 `SenseBeautyRender` 对象封装。
 
 
 ```swift
@@ -234,7 +234,7 @@ extension BeautyViewController: AgoraVideoFrameDelegate {
 
 调用 `AgoraRtcEngineKit` 类的 `joinChannelByToken` 加入频道，同时传入如下参数：
 
-- `token`：用于鉴权的动态密钥。如果在[创建声网项目](#创建声网项目)时启用**调试模式**，那么 将 `token` 参数传空。如果启用**安全模式**，那么你先参考[使用 Token 鉴权](https://docportal.shengwang.cn/cn/live-streaming-premium-4.x/token_server_android_ng?platform=Android)在你的业务服务端生成 Token，然后将生成的 Token 传入该参数。
+- `token`：用于鉴权的动态密钥。如果在[创建声网项目](#创建声网项目)时启用**调试模式**，那么将 `token` 参数传空。如果启用**安全模式**，那么你先参考[使用 Token 鉴权](https://docportal.shengwang.cn/cn/live-streaming-premium-4.x/token_server_ios_ng?platform=iOS)在你的业务服务端生成 Token，然后将生成的 Token 传入该参数。
 - `channelId`：频道名。
 - `mediaOptions`：频道媒体设置选项。
 

diff --git a/markdown/beauty/字节/beauty_integration_bytedance_android.md b/markdown/beauty/字节/beauty_integration_bytedance_android.md
@@ -59,7 +59,7 @@
    ...
     dependencies {
         ...
-        // x.y.z，请填写具体的 SDK 版本号，如：4.0.0 或 4.1.0-1。
+        // x.y.z，请填写具体的 RTC SDK 版本号，如：4.0.0 或 4.1.0-1。
         // 通过互动直播产品发版说明获取最新版本号。
         implementation 'io.agora.rtc:full-sdk:x.y.z'
      }
@@ -199,7 +199,7 @@ fun initEffect(context: Context){
 
 ### 3. 初始化 Beauty API
 
-调用 `createByteDanceBeautyAPI` 创建 Beauty API 对象。Beauty API 对象是声网基于 `RenderManager` 对象封装。
+调用 `createByteDanceBeautyAPI` 创建 Beauty API 对象。Beauty API 对象基于 `RenderManager` 对象封装。
 
 ```kotlin
 // 创建 Beauty API 对象

diff --git a/markdown/beauty/字节/beauty_integration_bytedance_ios.md b/markdown/beauty/字节/beauty_integration_bytedance_ios.md
@@ -73,7 +73,7 @@
     platform :ios, '9.0'
     # 替换成你的 target 名称
     target 'Your App' do
-    # x.y.z 请填写具体的 SDK 版本号，如 4.0.1 或 4.0.0.4
+    # x.y.z 请填写具体的 RTC SDK 版本号，如 4.0.1 或 4.0.0.4
     # 可通过互动直播发版说明获取最新版本号
     pod 'AgoraRtcEngine_iOS', 'x.y.z'
     # 配置字节火山美颜的依赖库
@@ -91,7 +91,7 @@
 
 ### 1. 初始化 AgoraRtcEngineKit
 
-调用声网 RTC SDK 中的 `sharedEngineWithConfig` 创建并初始化 `AgoraRtcEngineKit` 对象。同时调用 `enableVideo` 开启声网 SDK 的视频模块。
+调用声网 RTC SDK 中的 `sharedEngineWithConfig` 创建并初始化 `AgoraRtcEngineKit` 对象。调用 `enableVideo` 开启声网 SDK 的视频模块。
 
 ```swift
 // 初始化 AgoraRtcEngineKit
@@ -115,7 +115,7 @@ private lazy var rtcEngine: AgoraRtcEngineKit = {
 
 ### 2. 初始化美颜和 Beauty API
 
-创建 `BytesBeautyRender` 和 Beauty API 对象。Beauty API 对象是声网基于 `BytesBeautyRender` 对象封装。
+创建 `BytesBeautyRender` 和 Beauty API 对象。Beauty API 对象基于 `BytesBeautyRender` 对象封装。
 
 
 ```swift
@@ -233,7 +233,7 @@ extension BeautyViewController: AgoraVideoFrameDelegate {
 
 调用 `AgoraRtcEngineKit` 类的 `joinChannelByToken` 加入频道，同时传入如下参数：
 
-- `token`：用于鉴权的动态密钥。如果在[创建声网项目](#创建声网项目)时启用**调试模式**，那么 将 `token` 参数传空。如果启用**安全模式**，那么你先参考[使用 Token 鉴权](https://docportal.shengwang.cn/cn/live-streaming-premium-4.x/token_server_android_ng?platform=Android)在你的业务服务端生成 Token，然后将生成的 Token 传入该参数。
+- `token`：用于鉴权的动态密钥。如果在[创建声网项目](#创建声网项目)时启用**调试模式**，那么将 `token` 参数传空。如果启用**安全模式**，那么你先参考[使用 Token 鉴权](https://docportal.shengwang.cn/cn/live-streaming-premium-4.x/token_server_ios_ng?platform=iOS)在你的业务服务端生成 Token，然后将生成的 Token 传入该参数。
 - `channelId`：频道名。
 - `mediaOptions`：频道媒体设置选项。
 

diff --git a/markdown/beauty/字节/beauty_run_github_project_bytedance_ios.md b/markdown/beauty/字节/beauty_run_github_project_bytedance_ios.md
@@ -21,7 +21,7 @@
 运行以下命令克隆仓库到本地：
 
 ```shell
-git clone [email protected]:AgoraIO-Usecase/agora-ent-scenarios.git
+git clone [email protected]:AgoraIO-Community/BeautyAPI.git
 ```
 
 ## 集成第三方美颜 SDK

diff --git a/markdown/beauty/相芯/beauty_integration_faceunity_android.md b/markdown/beauty/相芯/beauty_integration_faceunity_android.md
@@ -69,7 +69,7 @@
 
     dependencies {
         ...
-        // x.y.z，请填写具体的 SDK 版本号，如：4.0.0 或 4.1.0-1。
+        // x.y.z，请填写具体的 RTC SDK 版本号，如：4.0.0 或 4.1.0-1。
         // 通过互动直播产品发版说明获取最新版本号。
         implementation 'io.agora.rtc:full-sdk:x.y.z'
         // 集成相芯美颜资源
@@ -207,7 +207,7 @@ object FaceUnityBeautySDK {
 
 ### 3. 初始化 Beauty API
 
-调用 `createFaceUnityBeautyAPI` 创建 Beauty API 对象。Beauty API 对象是声网基于 `FuRenderKit` 对象封装。
+调用 `createFaceUnityBeautyAPI` 创建 Beauty API 对象。Beauty API 对象基于 `FuRenderKit` 对象封装。
 
 
 ```kotlin
@@ -325,7 +325,7 @@ mRtcEngine.registerVideoFrameObserver(object : IVideoFrameObserver {
 
 调用 `RtcEngine` 类的 `joinChannel` 加入频道，同时传入如下参数：
 
-- `token`：用于鉴权的动态密钥。如果在[创建声网项目](#创建声网项目)时启用**调试模式**，那么 将 `token` 参数传空。如果启用**安全模式**，那么你先参考[使用 Token 鉴权](https://docportal.shengwang.cn/cn/live-streaming-premium-4.x/token_server_android_ng?platform=Android)在你的业务服务端生成 Token，然后将生成的 Token 传入该参数。
+- `token`：用于鉴权的动态密钥。如果在[创建声网项目](#创建声网项目)时启用**调试模式**，那么将 `token` 参数传空。如果启用**安全模式**，那么你先参考[使用 Token 鉴权](https://docportal.shengwang.cn/cn/live-streaming-premium-4.x/token_server_android_ng?platform=Android)在你的业务服务端生成 Token，然后将生成的 Token 传入该参数。
 - `channelId`：频道名。
 - `options`：频道媒体设置选项。
 

diff --git a/markdown/beauty/相芯/beauty_integration_faceunity_ios.md b/markdown/beauty/相芯/beauty_integration_faceunity_ios.md
@@ -72,7 +72,7 @@
     platform :ios, '9.0'
     # 替换成你的 target 名称
     target 'Your App' do
-    # x.y.z 请填写具体的 SDK 版本号，如 4.0.1 或 4.0.0.4
+    # x.y.z 请填写具体的 RTC SDK 版本号，如 4.0.1 或 4.0.0.4
     # 可通过互动直播发版说明获取最新版本号
     pod 'AgoraRtcEngine_iOS', 'x.y.z'
     # 配置相芯美颜的依赖库
@@ -91,7 +91,7 @@
 
 ### 1. 初始化 AgoraRtcEngineKit
 
-调用声网 RTC SDK 中的 `sharedEngineWithConfig` 创建并初始化 `AgoraRtcEngineKit` 对象。同时调用 `enableVideo` 开启声网 SDK 的视频模块。
+调用声网 RTC SDK 中的 `sharedEngineWithConfig` 创建并初始化 `AgoraRtcEngineKit` 对象。调用 `enableVideo` 开启声网 SDK 的视频模块。
 
 ```swift
 // 初始化 AgoraRtcEngineKit
@@ -115,7 +115,7 @@ private lazy var rtcEngine: AgoraRtcEngineKit = {
 
 ### 2. 初始化美颜和 Beauty API
 
-创建 `FUBeautyRender` 和 Beauty API 对象。Beauty API 对象是声网基于 `FUBeautyRender` 对象封装。
+创建 `FUBeautyRender` 和 Beauty API 对象。Beauty API 对象基于 `FUBeautyRender` 对象封装。
 
 
 ```swift
@@ -233,7 +233,7 @@ extension BeautyViewController: AgoraVideoFrameDelegate {
 
 调用 `AgoraRtcEngineKit` 类的 `joinChannelByToken` 加入频道，同时传入如下参数：
 
-- `token`：用于鉴权的动态密钥。如果在[创建声网项目](#创建声网项目)时启用**调试模式**，那么 将 `token` 参数传空。如果启用**安全模式**，那么你先参考[使用 Token 鉴权](https://docportal.shengwang.cn/cn/live-streaming-premium-4.x/token_server_android_ng?platform=Android)在你的业务服务端生成 Token，然后将生成的 Token 传入该参数。
+- `token`：用于鉴权的动态密钥。如果在[创建声网项目](#创建声网项目)时启用**调试模式**，那么将 `token` 参数传空。如果启用**安全模式**，那么你先参考[使用 Token 鉴权](https://docportal.shengwang.cn/cn/live-streaming-premium-4.x/token_server_ios_ng?platform=iOS)在你的业务服务端生成 Token，然后将生成的 Token 传入该参数。
 - `channelId`：频道名。
 - `mediaOptions`：频道媒体设置选项。
 

diff --git a/markdown/beauty/相芯/beauty_run_github_project_faceunity_ios.md b/markdown/beauty/相芯/beauty_run_github_project_faceunity_ios.md
@@ -21,7 +21,7 @@
 运行以下命令克隆仓库到本地：
 
 ```shell
-git clone [email protected]:AgoraIO-Usecase/agora-ent-scenarios.git
+git clone [email protected]:AgoraIO-Community/BeautyAPI.git
 ```
 
 ## 集成第三方美颜 SDK