跑通字节火山示例项目

前提条件Copy Anchor Link

本文介绍如何快速跑通 BeautyAPI 示例项目，体验字节火山美颜效果。开始前，请确保满足以下前提条件：

• Git
• Java Development Kit 11
• Android Studio 3.5 及以上
• 开通秀场直播服务
• Android 手机，版本 Android 5.0（API Level 21）及以上
  注意

  声网推荐使用真机运行项目。部分模拟机可能存在功能缺失或者性能问题。

克隆仓库Copy Anchor Link

运行以下命令克隆仓库到本地：

git clone git@github.com:AgoraIO-Community/BeautyAPI.git

集成第三方美颜 SDKCopy Anchor Link

按照如下步骤进行集成：

1. 联系字节技术支持获取最新的美颜 SDK、美颜资源、美颜证书。

2. 下载并解压美颜 SDK，然后将 SDK 中如下文件添加到美颜示例项目对应的文件路径下：

3. 在 app/src/main/java/io/agora/beautyapi/demo/ByteDanceActivity.kt 文件中，将 LICENSE_NAME 设置为申请到的证书文件名。

   Copy Text

   // 这里的证书文件名只用于声网示例项目测试
   // 请替换成你的证书文件名
   private val LICENSE_NAME = "agora_test_20220805_20230815_io.agora.entfull_4.2.3.licbag"

4. 在 app/build.gradle 文件中，将 applicationId 修改为你的包名，例如 com.example.app。包名用于在设备上唯一标识应用程序。在开发应用时，你需要设置包名。在此处设置的包名需要与你申请美颜 SDK 时提供的包名一致。

   Copy Text

   android {
       defaultConfig {
           applicationId "io.agora.entfull"
           ...
       }
   }

配置示例项目Copy Anchor Link

运行美颜项目前，你需要在 local.properties 文件中添加并设置如下参数：

AGORA_APP_ID = "YOUR_APP_ID"

你可以在创建声网项目后，从控制台获取参数的值，详情如下：

编译并运行示例项目Copy Anchor Link

按照如下步骤进行操作：

1. 开启 Android 设备的开发者选项，打开 USB 调试，通过 USB 连接线将 Android 设备接入电脑。

2. 用 Android Studio 打开 BeautyAPI/Android 文件夹。

3. 在 Android Studio 中，点击 Sync Project with Gradle Files 按钮，让项目与 Gradle 文件同步。

4. 待同步成功后，点击 Run 'app'。片刻后，美颜应用便会安装到你的 Android 设备上。

5. 打开美颜应用，进行体验。

本文介绍如何快速跑通 BeautyAPI 示例项目，体验字节火山美颜效果。

前提条件Copy Anchor Link

开始前，请确保满足以下前提条件：

• Git
• CocoaPods
• Xcode 13.0 及以上
• 有效的苹果开发者账号
• 开通秀场直播服务
• iOS 设备，版本 11.0 及以上
  注意

  声网推荐使用真机运行项目。部分模拟机可能存在功能缺失或者性能问题。

克隆仓库Copy Anchor Link

运行以下命令克隆仓库到本地：

git clone git@github.com:AgoraIO-Community/BeautyAPI.git

集成第三方美颜 SDKCopy Anchor Link

按照如下步骤进行集成：

1. 联系字节技术支持获取最新的美颜 SDK、美颜资源、美颜证书。

2. 下载并解压美颜 SDK 等文件，然后将如下文件添加到美颜示例项目对应的文件路径下：

   文件	项目路径
   byted_effect_ios_static/iossample_static/app/Resource/*.bundle	iOS/ByteEffectLib/Resource/*.bundle
   byted_effect_ios_static/iossample_static/effect-sdk.framework	iOS/ByteEffectLib/effect-sdk.framework
   byted_effect_ios_static/libeffect-sdk.a	iOS/ByteEffectLib/ibeffect-sdk.a
   证书：LicenseBag.bundle/<prefix>_<your_bundle_id>_<version_id>.licbag	iOS/ByteEffectLib/Resource/LicenseBag.bundle/<prefix>_<your_bundle_id>_<version_id>.licbag

   表格内容超出当前宽度，可横向滚动查看更多列。

配置示例项目Copy Anchor Link

按照如下步骤进行配置：

1. 运行美颜项目前，你需要在 iOS/BeautyAPi/KeyCenter.swift 文件中设置如下参数：

   Copy Text

   static let AppId: String = <#YOUR_APP_ID#>

   你可以在创建声网项目后，从控制台获取这些参数的值，详情如下：

   参数	描述	获取方式
   AppId	声网项目的 App ID	获取 App ID

   表格内容超出当前宽度，可横向滚动查看更多列。

2. 在 iOS/ 目录下运行 pod install，然后等待依赖库安装完成。

编译并运行示例项目Copy Anchor Link

按照如下步骤进行操作：

1. 连接上 iOS 设备后，点击 pod install 生成的 .xcworkspace 文件以通过 Xcode 打开项目，并在 iOS Device 选项中勾选上你的 iOS 设备。

2. 在项目 TARGETS 下的 Signing & Capabilities 界面勾选 Automatically manage signing，配置你的苹果开发者账号和 Bundle Identifier。Bundle ID 是设备上应用程序的唯一标识。在开发应用时，你需要设置 Bundle ID。在此处设置的 Bundle ID 需要与你申请字节火山美颜 SDK 时提供的 Bundle ID 一致。

3. 点击 开始编译。

4. 编译成功后，你的 iOS 设备上会出现美颜应用。在 iOS 系统设置中将该应用设为信任开发者后你才能打开应用。

5. 打开美颜应用，进行体验。