本文介绍如何在你的项目中集成和使用拓幻美颜特效系列插件(以下简称“拓幻美颜插件”),包括 Android 和 iOS 平台。
拓幻美颜插件是对拓幻 Ti SDK 核心 API 的封装。通过声网 SDK v4.x 提供的 setExtensionProperty 或 setExtensionPropertyWithVendor 方法,传入指定的 key
和 value
参数,你可以快速集成拓幻的美颜能力。
以 setExtensionProperty
为例,其中的 key
参数与拓幻的 API 名称完全对应,value
参数以 JSON 格式包装该 API 的部分或全部参数。因此,调用 setExtensionProperty
时只要传入指定的 key
和 value
,就可以调用对应的拓幻 API,实现美颜的有关功能。setExtensionPropertyWithVendor
同理。
支持的 key 和 value 详见插件接口说明。
在 Gitee 上查看完整的示例代码和项目结构
平台 | 语言 | 示例项目 |
---|---|---|
Android | Java | agora-tillusory-extension-demo/Android |
iOS | Objective-C | agora-tillusory-extension-demo/iOS |
参考以下步骤快速跑通示例项目:
Android
git clone https://gitee.com/tillusory/agora-tillusory-extension-demo.git
拓幻美颜特效系列插件使用说明.md
文件的示例项目一节完成后续步骤。iOS
git clone https://gitee.com/tillusory/agora-tillusory-extension-demo.git
拓幻美颜特效系列插件使用说明.md
文件的示例项目一节完成后续步骤。拓幻美颜插件需要与声网视频 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
库文件保存到你的项目文件夹下。
点击下载拓幻美颜插件的资源包,将 TiSDKResource.bundle
保存到项目文件夹下。
在 Xcode 中添加动态库,确保 Embed 属性设置为 Embed & Sign。
导入需要用到的头文件:
#import <AgoraRtcKit/AgoraRtcEngineKit.h>
#import "TiKey.h"
下面介绍插件相关接口的调用流程。接口的参数解释详见接口说明。
Android
初始化 RtcEngine
时,调用 enableExtension
启用插件。
private void enableExtension(boolean enabled) {
mRtcEngine.enableExtension("Tillusory", "TiSDK", enabled);
}
iOS
初始化 AgoraRtcEngineKit
时,调用 enableExtensionWithVendor
启用插件。
[self.agoraKit enableExtensionWithVendor:@"Tillusory"
extension:@"TiSDK"
enabled:self.enable];
初始化插件需要调用 setExtensionProperty
(Android)或 setExtensionPropertyWithVendor
(iOS)并传入对应的 key 和 value,具体顺序如下:
Android
private void initExtension() {
// 初始化
try {
//在线鉴权方式
JSONObject jsonObject = new JSONObject();
jsonObject.put("key",TiSDKKey);
setExtensionProperty("tiInit", jsonObject.toString());
//离线鉴权方式
//JSONObject jsonObject = new JSONObject();
//jsonObject.put("key",TiSDKKey);
//setExtensionProperty("tiInitOffline", jsonObject.toString());
} catch (JSONException e) {
Log.e(TAG, e.toString());
}
}
// 方便多次调用 setExtensionProperty
private void setExtensionProperty(String key, String property) {
mRtcEngine.setExtensionProperty("Tillusory", "TiSDK", key, property);
}
iOS
- (void)initExtension{
// 在线鉴权方式
[self.agoraKit setExtensionPropertyWithVendor:@"Tillusory"
extension:@"TiSDK"
key:@"tiInit"
value:[self toJson:@{
@"key":TiSDKKey
}]];
// 离线鉴权方式
// [self.agoraKit setExtensionPropertyWithVendor:@"Tillusory"
// extension:@"TiSDK"
// key:@"tiInitOffline"
// value:[self toJson:@{
// @"key":TiSDKKey
// }]];
}
调用 setExtensionProperty
(Android)或 setExtensionPropertyWithVendor
(iOS)并传入对应的 key 和 value,实现以下功能:
你可以根据场景需要进行组合调用。对应的 key 和 value 详见接口说明。
插件相关所有接口的参数解释详见接口说明。