本文介绍如何在你的项目中集成和使用虹图美颜特效系列(以下简称“虹图特效插件”),包括 Android 和 iOS 平台。
虹图特效插件是对虹图 HTEffect 核心 API 的封装。通过声网 SDK v4.x 提供的 setExtensionProperty 或 setExtensionPropertyWithVendor 方法,传入指定的 key
和 value
参数,你可以快速集成虹图的美颜特效能力。
以 setExtensionProperty
为例,其中的 key
参数与虹图的 API 名称完全对应,value
参数以 JSON 格式包装该 API 的部分或全部参数。因此,调用 setExtensionProperty
时只要传入指定的 key
和 value
,就可以调用对应的虹图 API,实现美颜特效的有关功能。setExtensionPropertyWithVendor
同理。
在 Gitee 上查看完整的示例代码和项目结构:
平台 | 语言 | 示例项目 |
---|---|---|
Android | Java | AgoraTexelJoyExtensionDemo/Android |
iOS | Objective-C | AgoraTexelJoyExtensionDemo/iOS |
参考以下步骤快速跑通示例项目:
Android
git clone https://gitee.com/htai-open/agora-texel-joy-extension-demo.git
.aar
文件保存到 agora-texel-joy-extension-demo/Android/app/libs
路径(libs
文件夹需自行创建)。agora-texel-joy-extension-demo/Android/app/src/main/assets
路径(assets
文件夹需自行创建)。agora-texel-joy-extension-demo/Android
。agora-texel-joy-extension-demo/Android/app/src/main/java/io/agora/rte/extension/hteffect/example/Constants.java
,进行如下修改:<YOUR_APP_ID>
替换为你的 App ID。获取 App ID 请参考开始使用 Agora 平台。mToken
和 mLicenseName
在运行 demo 时不必填写。public interface Constants {
String mAppId = "<YOUR_APP_ID>";
String mToken = null;
String mLicenseName = "<YOUR_LICENSE_NAME>";
}
agora-texel-joy-extension-demo/Android/app/src/main/java/io/agora/rte/extension/hteffect/example
/HtKey.java
,进行如下修改:<YOUR_HT_SDK_KEY>
替换为在声网购买的由虹图提供的测试 key:public interface HtKey {
String HTKey = "<YOUR_HT_SDK_KEY>";
}
iOS
git clone https://gitee.com/htai-open/agora-texel-joy-extension-demo.git
.framework
库文件保存到 agora-texel-joy-extension-demo/iOS/ExtensionExample
。HTKey.h
和资源包 HTEffect.bundle
保存到 agora-texel-joy-extension-demo/iOS/ExtensionExample
路径。agora-texel-joy-extension-demo/iOS
目录,运行以下命令使用 CocoaPods 安装依赖: pod install
ExtensionExample.xcworkspace
。Config.h
,进行如下修改:<YOUR_APP_ID>
替换为你的 App ID。获取 App ID 请参考开始使用 Agora 平台。token
在运行 demo 时不必填写。NSString *const appID = @"<YOUR_APP_ID>";
NSString *const token = nil;
agora-texel-joy-extension-demo/iOS/ExtensionExample/HTKey.h
,进行如下修改:<YOUR_HT_SDK_KEY>
替换为在声网购买的由虹图提供的测试 key:NSString *const HTKey = @"<YOUR_HT_SDK_KEY>";
运行成功后,示例项目会安装到你的 Android 或 iOS 设备上。
enableExtension
、setStyleFilter
、setSticker
按钮和 faces:0
人脸数量显示。setStyleFilter
加载风格滤镜效果。默认是自然 3 效果。setSticker
设置贴纸效果。默认是兔子蝴蝶结风格。虹图美颜特效插件需要与声网视频 SDK v4.x 搭配使用。参考以下文档集成视频 SDK v4.x 并实现基础的视频通话:
在声网控制台购买和激活虹图特效插件,购买时需要保存好获取的证书文件,用于后续集成插件。
Android
下载虹图美颜特效系列的 Android 插件包。解压后,将所有 .aar
文件保存到项目文件夹,比如 /app/libs
路径。
联系声网获取资源包,将所需的模型和道具文件保存到项目文件夹,比如 /app/src/main/assets
路径。
打开 app/build.gradle
文件,在 dependencies
中添加如下行
implementation fileTree(dir: "libs", include: ["*.jar", "*.aar"])
导入需要用到的类:
import io.agora.rtc2.Constants;
import io.agora.rtc2.IMediaExtensionObserver;
import io.agora.rtc2.IRtcEngineEventHandler;
import io.agora.rtc2.RtcEngine;
import io.agora.rtc2.RtcEngineConfig;
import io.agora.rtc2.video.VideoCanvas;
iOS
下载虹图美颜特效系列的 iOS 插件包。
解压文件夹,将所有 .framework
库文件保存到你的项目文件夹下。
联系声网获取资源包,将 HTEffect.bundle
保存到项目文件夹下。
在 Xcode 中添加动态库,确保 Embed 属性设置为 Embed & Sign。
导入需要用到的头文件:
#import <AgoraRtcKit/AgoraRtcEngineKit.h>
#import "HTKey.h"
下面介绍插件相关接口的调用流程。接口的参数解释详见接口说明。
Android
初始化 RtcEngine
时,调用 enableExtension
启用插件。
private void enableExtension(boolean enabled) {
mRtcEngine.enableExtension("Texeljoy", "HTEffect", enabled);
}
iOS
初始化 AgoraRtcEngineKit
时,调用 enableExtensionWithVendor
启用插件。
-(void)enableExtension:(BOOL)enabled{
[self.agoraKit enableExtensionWithVendor:@"Texeljoy"
extension:@"HTEffect"
enabled:enable];
}
初始化插件需要调用 setExtensionProperty
(Android) 或setExtensionPropertyWithVendor
(iOS) 并传入对应的 key 和 value,具体顺序如下:
Android
private void initExtension() {
// 初始化
try {
//在线鉴权方式
JSONObject jsonObject = new JSONObject();
jsonObject.put("appId",HtKey.HTKey);
setExtensionProperty("htInitHTEffectOnline", jsonObject.toString());
} catch (JSONException e) {
Log.e(TAG, e.toString());
}
}
private void initExtension() {
// 初始化
try {
//离线鉴权方式
JSONObject jsonObject = new JSONObject();
jsonObject.put("license",HtKey.HTKey);
setExtensionProperty("htInitHTEffectOffline", jsonObject.toString());
} catch (JSONException e) {
Log.e(TAG, e.toString());
}
}
iOS
- (void)initExtension{
// 在线鉴权方式
[self.agoraKit setExtensionPropertyWithVendor:@"Texeljoy"
extension:@"HTEffect"
key:@"htInitHTEffectOnline"
value:[self toJson:@{
@"license":HTSDKKey
}]];
}
- (void)initExtension{
// 离线鉴权方式
[self.agoraKit setExtensionPropertyWithVendor:@"Texeljoy"
extension:@"HTEffect"
key:@"htInitHTEffectOffline"
value:[self toJson:@{
@"license":HTSDKKey
}]];
}
调用 setExtensionProperty
(Android)或setExtensionPropertyWithVendor
(iOS) 并传入对应的 key 和 value,实现以下功能:
你可以根据场景需要进行组合调用。对应的 key 和 value 详见接口说明。
插件相关所有接口的参数解释详见接口说明。