KMCStFilter

商汤贴纸+金山直播

项目背景

金山魔方是一个多媒体能力提供平台，通过统一接入 API、统一鉴权、统一计费等多种手段，降低客户接入多媒体处理能力的成本，提高供应商的效率。本文档主要针对统一 FILTER 功能进行说明。

名词解释

• 贴纸资源：如右图所示，选中图标后下载出现在人脸上的图案称为贴纸资源。
• 缩略图：如右图左侧下方十个格子中，每个格子中的图标就是滤镜缩略图。
• 贴纸特效动作：贴纸中可能包含点头、摇头、张嘴等触发特效的动作，KMCArMaterial 中详细定义了具体的触发动作和 tips。

安装

安装包分为三部分

• demo：可运行的示例程序
• doc：说明文档

目前 SDK 支持通过 pod 引入。

• pod ‘KMCSTFilter’

SDK 包总体介绍

目前无论是哪个厂家的贴纸资源，接口都是一致的，只是 framework 不同。

• KMCFilter.h —— SDK 包头
• KMCArMaterial.h —— 资源索引文件类

SDK 使用指南

目前本 SDK 集成了多家厂家的信息，厂家的贴纸信息有的托管在金山的服务器上，有的托管在厂家的服务器上，具体信息可咨询商务，本 SDK 只提供统一的贴纸鉴权、下载、显示服务。

鉴权

本 SDK 包采用鉴权加密方式，需要通过商务渠道获取授权的 AK/SK 信息方可使用，具体请咨询商务。鉴权函数如下，其中 accessKey 为 ak 信息，date 为过期时间。

(void)authorizeWithAccessKey:(NSString *)accessKey
                     amzDate:(NSString *)date
                   onSuccess:(void (^)(void))completeSuccess
                   onFailure:(void (^)(int iErrorCode))completeFailure;

上传贴纸（不在本 SDK 范围内，请参考控制台文档）

客户根据选择的厂家，按照厂家要求设计好贴纸，通过金山控制台上传贴纸。

拉取贴纸索引信息

客户可以在控制台将贴纸放入一个 group 中，SDK 通过 groupID 进行拉取，相关函数为：

- (void)fetchMaterialsWithGroupID:(NSString *)strGroupID
                       OnSuccess:(void (^)(NSArray <KMCArMaterial *>* arrMaterials))completeSuccess
                       onFailure:(void (^)(int iErrorCode , NSString *strMessage))completeFailure;

拉取成功后，资源索引文件，包括贴纸的下载地址、缩略图的下载地址、贴纸的手势 ID、手势描述信息等，可以在此处设置 UI 相关信息。

下载贴纸

贴纸资源大小不固定，较大的可能几 M，较小的可能几十 K，相关函数：

(void)downloadMaterial:(KMCArMaterial *)material
             onSuccess:(void (^)(KMCArMaterial *material))completeSuccess
             onFailure:(void (^)(KMCArMaterial *material , int iErrorCode , NSString *strMessage))completeFailure
            onProgress:(void (^)(KMCArMaterial *material , float fProgress , int64_t iSize))processingCallBack;

显示贴纸

下载完成后，需要调用显示贴纸设置进推流 SDK 中，相关函数：

-(void)startShowingMaterial:(KMCArMaterial *)material;

接入流程

接入步骤

1. 登录 金山云控制台，选择视频服务 - 金山魔方

2. 在金山魔方控制台中选择所需服务。

3. 点击申请试用，填写申请资料。

4. 申请审核通过后，金山云注册时的邮箱会收到邮件及试用 token。

5. 下载安卓/iOS版本的SDK，将其集成到项目中。

6. 按照文档和DEMO填写TOKEN，项目就可以正常运行了。
7. 在试用期间或试用结束后，如有意愿购买该服务，请联系我们的商务人员。
（商务Email:[email protected]）

反馈与建议  

主页：金山魔方
邮箱：[email protected]
QQ讨论群：574179720 [视频云技术交流群]