科大讯飞
  1. AI虚拟人技术
科大讯飞
  • iOS SDK接入文档
  • 平台文档
    • 开发者新手指南
      • 平台简介
      • 快速指引
    • 服务协议
      • 讯飞开放平台用户服务协议
      • 讯飞星火认知大模型接口服务协议
      • 开发者应用创建规则
      • 讯飞开放平台隐私政策
      • 开发者用户个人信息保护合规指引
      • 开放平台SDK合规使用说明
      • SDK隐私政策总览
      • SDK合规使用说明总览
      • 科大讯飞儿童隐私保护政策
      • 讯飞开放平台SLA协议
      • 讯飞开放平台订购协议
    • 用户认证须知
      • 用户认证简介
      • 企业实名认证
      • 个人实名认证
      • 初创团队认证
      • 学生认证
      • 公益项目认证
      • 个人升级企业认证
    • 财务
      • 退款规则及退款流程
      • 财务相关说明
    • 账号
      • 账号注销与删除流程
      • 账号与应用说明
    • 会员
      • 会员权益详情
      • 会员时效说明
      • 会员试用版
  • 星火认知大模型
    • SparkDesk
      • SparkDesk使用指南
      • SparkDesk隐私政策
      • SparkDesk用户协议
    • 星火认知大模型
      • 服务说明
      • 通用鉴权URL生成说明
      • Spark Android SDK接入文档
      • Linux SDK接入文档
      • Windows SDK接入文档
      • 讯飞星火认知大模型隐私政策
      • Web 文档
        • 星火认知大模型Web API文档
        • 星火大模型V1.5
        • 星火大模型V2
        • 星火大模型V3
    • 星火知识库
      • 星火知识库 API 文档
        • 星火知识库 API 文档
        • 文档问答
        • 文档上传
        • 文档总结
        • 获取文档总结/概要信息
      • 新版Embedding API文档
    • 图片生成
      • 图片生成 API
    • 图片理解
      • 图片理解 API
    • 大模型定制训练平台
      • 产品使用说明
      • 星火微调服务Web API文档文档
        • 星火微调服务Web API文档文档
        • V1.5版本
        • 微调模型
  • 语音识别
    • 语音唤醒(新版)
    • 语音听写
      • Android SDK 文档
      • iOS SDK 文档
      • Linux SDK 文档
      • Windows SDK 文档
      • Java SDK 文档
      • 音频文件格式说明
      • 语音听写服务说明
      • 语音听写(流式版)SDK隐私政策
      • 语音听写(流式版)SDK合规使用说明
      • HarmonyOS SDK 文档
      • 语音听写自训练平台
      • 语音听写(流式版)WebAPI
    • 语音转写
      • 语音转写服务说明
      • 语音转写 服务协议
      • WebAPI 文档
        • 语音转写 API 文档
        • 文件上传
        • 查询结果
    • 极速语音转写
      • 极速语音转写 API 文档
      • 小文件上传
      • 初始化分块信息
      • 分块上传
      • 分块上传完成
      • 创建任务
      • 查询任务
    • 实时语音转写
      • 实时语音转写服务说明
      • 实时语音转写 API
    • 离线语音听写
      • Android SDK 文档
      • 离线语音听写服务说明
      • 离线语音听写SDK隐私政策
      • 离线语音听写SDK合规使用说明
    • 离线语音听写(新版)
      • Android SDK 文档
      • 离线语音听写隐私政策
    • 语音唤醒
      • Android SDK 文档
      • iOS SDK 文档
      • Linux SDK 文档
      • Windows SDK 文档
      • 语音唤醒服务说明
      • 离线唤醒SDK隐私政策
    • 语音唤醒(新版)
      • Android SDK 文档
      • Linux SDK 文档
      • 语音唤醒隐私政策
    • 离线命令词识别
      • Android SDK 文档
      • iOS SDK 文档
      • Linux SDK 文档
      • Windows SDK 文档
      • 离线命令词识别服务说明
      • 离线命令词识别SDK隐私政策
      • 离线命令词SDK合规使用说明
  • 语音合成
    • 在线语音合成
      • Android SDK 文档
      • iOS SDK 文档
      • Linux SDK 文档
      • Windows SDK 文档
      • Java SDK 文档
      • 服务协议
      • 在线语音合成服务说明
      • 发音人自训练平台使用指南
      • WebAPI
    • 长文本语音合成
      • 长文本语音合成 API 文档
      • 创建任务
      • 查询任务
    • 离线语音合成
      • Android SDK 文档
      • iOS SDK 文档
      • Linux SDK 文档
      • Windows SDK 文档
      • 服务协议
      • 离线语音合成服务说明
    • AI虚拟人技术
      • Web SDK 2.0 接入指南
      • Android-SDK
      • iOS-SDK
      • Web API 文档
        • AI虚拟人技术 API 文档
        • 音频驱动
        • 启动
        • 文本驱动
        • 停止
        • 心跳
  • 语音扩展
    • 语音评测(流式版)
      • 接口说明
      • Android SDK 文档
      • iOS SDK 文档
      • Linux SDK 文档
      • Windows SDK 文档
      • 语音评测SDK隐私政策
      • 语音评测(流式版)API
    • 语音评测suntone
      • 语音评测suntone API
    • 离线变声
      • Android SDK 集成文档
    • 音色转换
      • 音色转换 API
    • 性别年龄识别
      • 性别能力识别 API
    • 声纹识别
      • Web API 文档
      • 声纹识别 API
    • 歌曲识别
      • 歌曲识别 API
    • 歌曲识别 ACRCloud
      • 接口说明
      • 哼唱识别
      • 音乐识别
    • AI 客服中间件
      • 接口说明
      • 获取token
      • 查询配置
      • 直接外呼
      • 创建外呼任务
      • 提交任务数据
      • 启动外呼任务
      • 暂停外呼任务
      • 删除外呼任务
      • 查询任务
      • 结果数据推送
      • 话单推送
      • 录音推送
      • 会话推送
      • 呼入话术上下文动态数据获取
  • 自然语言处理
    • 文本纠错
      • 文本纠错 API
      • 黑白名单上传
    • 公文校队
      • 公文校对 API
    • 文本合规
      • 文本合规 API
      • 新增黑名单词库
      • 根据lib_id添加黑名单词条
      • 根据lib_id查询词条明细
      • 根据lib_id删除词条
      • 根据appid查询账户下所有词库
      • 根据lib_id删除词库
      • 创建白名单库
      • 根据lib_id添加放行词条
      • 根据lib_id查询词条详情
      • 根据lib_id删除词条信息
      • 根据appid查询所有词库列表
      • 根据lib_id删除词库
    • 图片合规
      • 图片合规 API
    • 音频合规
      • 音频合规 API
    • 视频合规
      • 视频合规 API
    • 文本改写
      • 文本改写 API
    • 机器翻译
      • 机器翻译(新) API
    • 机器翻译niutrans
      • 机器翻译niutrans API
    • 同声传译
      • 同声传译 API 
    • 离线分词
      • Android SDK 文档
  • 人脸识别
    • 人脸验证与检索
      • Android SDK 文档
      • iOS SDK 文档
      • 人脸验证与检索SDK隐私政策
      • 人脸验证与检索SDK合规使用说明
    • 人脸对比
      • 人脸比对 API
    • 人脸比对sensetime
      • 人脸比对sensetime API
    • 人脸水印照比对
      • 人脸水印照比对 API
    • 静默活体检测
      • 静默活体检测 API
    • 配合式活体检测
      • 配合式活体检测 API
    • 静默活体检测sensetime
      • 静默活体检测sensetime API
    • 人脸检测和属性分析
      • 人脸检测和属性分析 API
    • 人脸特征分析tuputech
      • 年龄 API
      • 颜值 API
      • 性别 API
      • 表情 API
  • 文字识别
    • 通用文字识别
      • 通用文字识别 API
    • 通用文字识别
      • 通用文字识别 intsig API
    • 手写文字识别
      • 手写文字识别 API
    • 印刷文字识别
      • 印刷文字识别 API
    • 印刷文字识别(多语种)
      • 印刷文字识别(多语种)
    • 印刷文字识别(多语种)intsig
      • 印刷文字识别(多语种)intsig API
    • 图片文档还原
      • 图片文档还原 API 
    • 国内通用票据识别
      • 接口说明
      • 国内通用票据识别 API
    • 离线OCR
      • Android SDK 文档
    • 名片识别 intsig
      • 名片识别 API
    • 身份证识别 intsig
      • 身份证识别 intsig API
    • 银行卡识别 intsig
      • 银行卡识别 API
    • 营业执照识别 intsig
      • 营业执照识别 intsig API
    • 增值税发票识别 intsig
      • 增值税发票识别 intsig API
    • 拍照速算识别
      • 接口说明
      • 拍照速算识别 API
    • 公式识别
      • 接口说明
      • 公式识别 API
    • 指尖文字识别
      • 接口说明
      • 指尖文字识别 API
    • 身份证识别
      • 接口说明
      • 身份证识别 API
    • 增值税发票识别
      • 接口说明
      • 增值税发票识别 API
    • 营业执照识别
      • 接口说明
      • 营业执照识别 API
    • 火车票识别
      • 接口说明
      • 火车票识别 API
    • 出租车发票识别
      • 接口说明
      • 出租车发票识别 API
  • 图像识别
    • 场景识别
      • 场景识别 API
    • 物体识别
      • 物体识别 API
    • 场所识别
      • 场所识别 API 文档
  • 基础服务
    • 云服务器 CVM
      • 云服务器 CVM 产品简介
      • 快速入门
      • 服务协议
  • 解决方案
    • 签到解决方案
      • SaaS操作文档
    • 智能硬件通用方案
      • 智能硬件通用方案说明
      • 麦克风阵列Android SDK
      • 麦克风阵列Linux SDK
      • 双麦阵列设计参考
      • 麦克风阵列录音要求
      • 语音唤醒Android SDK
      • 语音唤醒Linux SDK
      • 离线声纹Android SDK
      • 离线声纹Linux SDK
  • MSC API 文档
    • Android
      • 文件列表
      • SDK初始化
      • 语音识别(Recognizer)
      • 语音合成(Synthesizer)
      • 语音评测(Evaluator)
      • 语音唤醒(Wakeuper)
      • 声纹人脸(Verifier)
      • Android 常量字段值
      • 基础类
    • IOS
      • 文件列表
      • SDK初始化
      • 语音识别(Recognizer)
      • 语音合成(Synthesizer)
      • 语音评测(Evaluator)
      • 语音唤醒(Wakeuper)
      • 声纹人脸(Verifier)
      • 基础类
    • Windows&Linux
      • 文件列表
      • API 文档
    • Java
      • 所有类列表
      • SDK初始化
      • 语音识别(Recognizer)
      • 语音合成(Synthesizer)
      • 常量字段值
      • 基础类
  1. AI虚拟人技术

iOS-SDK

1. 总体说明#

#1.1 简介#

虚拟人交互 SDK(以下简称 AIKit)为接入方提供支持虚拟人服务与视频流服务方案的SDK。接入方需按此集成文档集成 SDK,以使用相关能力。

#1.2 适用范围#

本文档定义了 AIKit 在iOS操作系统中的使用说明和体系结构及API接口。

#1.3 开发准备#

开发者在使用iOS SDK进行开发前,需要经过我们的授权,获取对应的appId、apiKey、apiSecret、avatarid、vcn。

#1.4 支持平台#

支持iOS9.0及以上的平台,支持arm64 架构。

#2. 使用说明#

#2.1 申请使用#

请与平台业务人员联系获取集成 SDK 包,需要提供接入方客户端包名、应用签名等信息,并获取接入方 appId、apiKey、apiSecret、虚拟形象、发音人,以及其他相关资源。

#3. SDK集成#

#3.1 集成步骤#

1.
AIKit.framework、XRTCSDK.framework添加至目标项目中。
2.
在主工程的 TARGET > Bulid Phases > Link Bianry With Libraries 添加以下依系统赖库。
3.
在工程配置Build Settings里的Other Linker Flags中添加-ObjC标记,BitCode 设置为NO。
如图所示:
![image-20220906101726249](../../../Library/Application Support/typora-user-images/image-20220906101726249.png)
4.
主工程 Info.plist添加权限设置。
5.
主工程添加以下三方开源库

#4. SDK使用#

#4.1 SDK初始化#

初始化SDK,传入相关鉴权参数。
/**
 * SDK初始化函数用以初始化整个SDK
 * @param param  SDK配置参数
 * @return 结果错误码,0=成功
 */
int ret = [ILibrary initSDK:^(AiHelperMaker *maker) {                            maker.appId(@"appId").apiKey(@"apiKey").apiSecret(@"apiSecret").authInterval(300).logOpen(true).iLogOpen(true).workDir(@"xx/xx/workDir");
}]; 
参数类型说明必填
appIdstring应用ID是
apiKeystring唯一的应用标识是
apiSecretstring唯一的应用密钥是
authIntervalint授权更新间隔,单位为秒否,默认为300秒
iLogOpenbool是否开启控制台日志输出否
logOpenbool是否开始日志输出文件否
workDirstringsdk工作目录否

#4.2 配置虚拟人能力回调、渲染视图#

//设置虚拟人能力回调代理
[AiHelper shareInstance].delegate = self;
//设置虚拟人拉流渲染视图 
AiHelper.shareInstance.virtualView = self.remoteView;
能力输出回调:AIKitCoreDelegate协议
//result 回调
- (void)aikitOnResult:(NSString*)ability outputData:(NSArray<AIKITDataModel*>*)data usrCtx:(AIKITUserContext*)context;
//event 回调  event:19表示ws已经关闭连接
- (void)aikitOnEvent:(NSString*)ability event:(NSInteger)event eventData:(NSArray<AIKITDataModel*>*)data usrCtx:(AIKITUserContext*)context;
//error 回调
- (void)aikitOnError:(NSString*)ability error:(AIKITError*)error usrCtx:(AIKITUserContext*)context;

#4.3 上传个性化数据#

/// 上传个性化数据
/// @param ability 能力标识
/// @param data 数据
+ (AIKITOutput*)loadDataSync:(NSString*)ability data:(AIKITCustomData*)data;    
代码示例:
/// 例如:获取上传背景的res_id
- (nullable NSString *)getResidWithUploadData:(NSData *)fileData{

    AIKITCustomData *customData = [[AIKITCustomData alloc] init];
    NSString *base64Str = [fileData base64EncodedStringWithOptions:NSDataBase64Encoding64CharacterLineLength];   
    [customData addText:base64Str key:@"background_data" index:0];
    
    AIKITOutput *output = [AiHelper loadDataSync:VMS_ABILITY data:customData];
    
    if (output.code != 0) {
        NSLog(@"loadData failed code:%ld",(long)output.code);
        return nil;
    }
    
    if (output.data.count > 0) {
        for (AIKITDataModel *model in output.data) {
            Byte *bytes = (Byte *)model.value;
            if (bytes == NULL) {
                continue;
            }
            NSData *data = [[NSData alloc] initWithBytes:bytes length:model.len];
            NSString *value = [NSString stringWithUTF8String:[data bytes]];
            
            if ([model.key isEqualToString:@"result"]) {
                NSError *error;
                NSDictionary *dic = [VMTools jsonToArrayOrDictionary:value];
                if ([dic.allKeys containsObject:@"data"]) {
                    NSDictionary *resultData = dic[@"data"];
                    return resultData[@"res_id"];
                }
            }
        }
    }
}

##

/// 上传字幕模板数据,注意字幕模板上传后需要进行文本驱动,详细见demo
 AIKITCustomData *customData = [[AIKITCustomData alloc] init];
 NSString *base64Str = [data base64EncodedStringWithOptions:0];
    
 if (!kStringIsEmpty(base64Str)) {
    [customData addText:base64Str key:@"template_data" index:0];
}
 _template_id = [self getResidWithUploadCustomData:customData];  

#4.4 启动虚拟人服务#

/// 启动会话
/// @param ability 能力标识
/// @param param AIKITParameters能力参数
/// @param content 用户自定义标识
+ (AiHandle*)start:(NSString*)ability param:(nullable AIKITParameters*)param ctxContent:(nullable AIKITCtxContent*)content;    
创建AIKITParameters:
参数类型说明必填
uidstring唯一标识是
avataridstring形象ID是
widthint视频分辨率:宽是,默认为1280
heightint视频分辨率:高否,默认为720
scaledouble主播在背景图像中的大小 (0,1.0]否,默认为1
maskRegionbool形象截取区域,用于控制形象展示区域,比如可以截取半身等 示例 : [0,0,1080,1920]否
moveHint主播平移像素距离 [-4096, +4096],控制主播中心位置距离合成图像中心位置水平距离,为负数表示向左平移,为正数表示向右平移否,默认为0
moveVint主播垂直移动像素距离 [-4096, +4096],控制主播在展示画面中的上下移动距离,0为默认情况,主播在画面中下贴边位置。该值为负数表示向下移动,为正数表示向上移动否,默认为0
res_idstring上传背景生成唯一标识否
interactive_scenestring部分形象需要传值为type=live否
template_idstring后处理模板生成的唯一标识否

#4.5 文本驱动#

/// 会话模式输入数据
/// @param data AIKITInputData能力数据
/// @param handle 启动服务的handle对象
/// @param param AIKITParameters能力参数
+ (int)write:(nullable AIKITInputData*)data handle:(nonnull AiHandle *)handle param:(nullable AIKITParameters *)param; 
代码示例:
AIKITParameters *param = [[AIKITParameters alloc] init];
//发音人
[param addSection:@"tts"];
[param addString:@"vcn" value:vcn];
//文本驱动传rhy有字幕效果,其他可不传入
[param addInt:@"rhy" value:3];

//打断模式:追加、打断
[param addSection:@"vms_dispatch"];
[param addInt:@"interactive_mode" value:interactiveMode];

AIKITInputData *input = [[AIKITInputData alloc] init];
//合成文本
[input addText:text key:@"text" status:DataStatusOnce];

//动作
if (actions.count == 0){
      [input addText:@"" key:@"ctrl_w" status:DataStatusOnce];
}else{
    NSMutableArray *avatarArray = [NSMutableArray array];
    for (NSString *action in actions) {
      NSDictionary *dic = @{@"type":@"action",
                               @"value":action,
                               @"wb":@2,
                               @"we":@10,
       };
      [avatarArray addObject:dic];
    }
    NSDictionary *avatarDic = @{@"avatar":avatarArray.copy};
    NSData *data = [NSJSONSerialization dataWithJSONObject:avatarDic options:NSJSONWritingPrettyPrinted error:nil];
    [input addTextData:data key:@"ctrl_w" status:DataStatusOnce];
}
//后处理字幕相关
if (!kStringIsEmpty(_template_id)){
     NSString *path = [ConfigManager.sharedInstance getSandBoxDefaultFilePath:ConfigJsonFileTypeWordLevel3];
     NSData *templateData = [[NSData alloc] initWithContentsOfFile:path];
     NSDictionary *json = [NSJSONSerialization JSONObjectWithData:templateData
                                                             options:kNilOptions
                                                               error:nil];
     TemplateModel *model = [TemplateModel yy_modelWithDictionary:json];
     if (!kStringIsEmpty(_res_id)){
        model.controls.firstObject.elements.firstObject.resource.res = _res_id;
     }
     NSString *jsonStr = [model yy_modelToJSONString];

     if(!kStringIsEmpty(jsonStr)){
       [input addText:jsonStr key:@"ctrl_postproc" status:DataStatusOnce];
    }
}

//文本、动作附属参数
AIKITParameters *inputParam = [[AIKITParameters alloc] init];
[inputParam addString:@"encoding" value:@"utf8"];
[inputParam addString:@"compress" value:@"raw"];
[inputParam addString:@"format" value:@"plain"];

[input addControl:inputParam key:@"text"];
[input addControl:inputParam key:@"ctrl_w"];
//写入驱动
int ret = [AiHelper write:input handle:self.handle param:param];
if (ret != 0) {
    NSLog(@"vms write failed! ret is %ld", (long)ret);
}
创建param:
tts
参数类型说明必填
vcnstring合成发言人是
rhyint文本驱动传rhy有字幕效果否
vms_dispatch
参数类型说明必填
interactive_modeint打断模式 [0,1] (0 追加模式 1 打断模式)否,默认为1
创建input:
参数类型说明必填
textstring合成的文本数据是
ctrl_wdata字偏移控制指令否
ctrl_postprocstring后处理控制指令否
control
参数类型说明必填
textobject含有 encoding、compress、format参数是
encodingstring文本编码: utf8是
compressstring文本压缩格式: raw是
formatstring文本格式: raw是
ctrl_wobject含有 encoding、compress、format参数,动作相关否
ctrl_postprocobject含有 encoding、compress、format参数,后处理相关否

#4.5 ws文本驱动 - 支持回调播报状态#

/// 会话模式输入数据
/// @param data AIKITInputData能力数据
/// @param handle 启动服务的handle对象
/// @param param AIKITParameters能力参数
+ (int)write:(nullable AIKITInputData*)data handle:(nonnull AiHandle *)handle param:(nullable AIKITParameters *)param; 
代码示例:
    DataStatus status = DataStatusEnd;
    if (_wsTextStatus == 0) {
        status = DataStatusBegin;
    }else {
        status = DataStatusContinue;
    }
    if (_wsTextStatus == 0) {
        _wsTextStatus ++;
    }
    
    AIKITParameters *param = [[AIKITParameters alloc] init];
    [param addSection:@"tts"];
    [param addString:@"vcn" value:vcn];
    //文本驱动传rhy有字幕效果,其他可不传入
    [param addInt:@"rhy" value:3];
    
//    [param addSection:@"realtime_status"];
//    [param addInt:@"tts_status" value:1];
//    [param addInt:@"vmr_status" value:1];
//    [param addInt:@"vmr_action_status" value:1];

    [param addSection:@"vms_dispatch"];
    [param addInt:@"interactive_mode" value:interactiveMode];

    [param addSection:@"header"];
    [param addInt:@"status" value:status];
    
    AIKITInputData *input = [[AIKITInputData alloc] init];
    [input addText:text key:@"text" status:status];
    //动作
    if (actions.count == 0){
        [input addText:@"" key:@"ctrl_w" status:DataStatusOnce];
    }else{
        NSMutableArray *avatarArray = [NSMutableArray array];
        for (NSString *action in actions) {
            NSDictionary *dic = @{@"type":@"action",
                                  @"value":action,
                                  @"wb":@2,
                                  @"we":@10,
            };
            [avatarArray addObject:dic];
        }
        NSDictionary *avatarDic = @{@"avatar":avatarArray.copy};
        NSData *data = [NSJSONSerialization dataWithJSONObject:avatarDic options:NSJSONWritingPrettyPrinted             error:nil];
        [input addTextData:data key:@"ctrl_w" status:DataStatusOnce];
    }
    
    
    AIKITParameters *inputParam = [[AIKITParameters alloc] init];
    [inputParam addString:@"encoding" value:@"utf8"];
    [inputParam addString:@"compress" value:@"raw"];
    [inputParam addString:@"format" value:@"plain"];
    //后处理字幕相关
    if (!kStringIsEmpty(_template_id)){
        NSString *path = [ConfigManager.sharedInstance getSandBoxDefaultFilePath:ConfigJsonFileTypeWordLevel3];
        NSData *templateData = [[NSData alloc] initWithContentsOfFile:path];
        NSDictionary *json = [NSJSONSerialization JSONObjectWithData:templateData
                                                             options:kNilOptions
                                                               error:nil];
        TemplateModel *model = [TemplateModel yy_modelWithDictionary:json];
        if (!kStringIsEmpty(_res_id)){
            model.controls.firstObject.elements.firstObject.resource.res = _res_id;
        }
        NSString *jsonStr = [model yy_modelToJSONString];

        if(!kStringIsEmpty(jsonStr)){
            [input addText:jsonStr key:@"ctrl_postproc" status:DataStatusOnce];
        }
    }
    
    [input addControl:inputParam key:@"text"];
    [input addControl:inputParam key:@"ctrl_w"];
    [input addControl:inputParam key:@"ctrl_postproc"];
    
    int ret = [AiHelper write:input handle:self.handle param:param];
    if (ret != 0) {
        NSLog(@"vms write failed! ret is %ld text: %@", (long)ret,text);
    }
创建param:
header
参数类型说明必填
statusint数据状态 0:开始, 1:开始, 2:结束是
tts
参数类型说明必填
vcnstring合成发言人是
rhyint文本驱动传rhy有字幕效果否
vms_dispatch
参数类型说明必填
interactive_modeint打断模式 [0,1] (0 追加模式 1 打断模式)否,默认为1
创建input:
参数类型说明必填
textstring合成的文本数据是
ctrl_wdata字偏移控制指令否
ctrl_postprocstring后处理控制指令否
control
参数类型说明必填
textobject含有 encoding、compress、format等参数是
encodingstring文本编码: utf8是
compressstring文本压缩格式: raw是
formatstring文本格式: raw是
ctrl_wobject含有 encoding、compress、format等参数,动作相关否
ctrl_postprocobject含有 encoding、compress、format等参数,后处理相关否

#4.6 音频驱动#

/// 会话模式输入数据
/// @param data AIKITInputData能力数据
/// @param handle 启动服务的handle对象
+ (int)write:(nullable AIKITInputData*)data handle:(nonnull AiHandle *)handle; 
代码示例:
int ret = 0;
//一次性音频文件
int leftAudioBytes = (int)audioData.length;
int byteWrites = 1280;
int writeLen   = 0;
int x_sb = 0;
while (leftAudioBytes > 0) {
    bool isLast = false;
    if (leftAudioBytes > byteWrites) {
        writeLen = byteWrites;
    } else {
        isLast   = true;
        writeLen = leftAudioBytes;
    }
    leftAudioBytes -= writeLen;
    
    int loc_dsb = x_sb*byteWrites;
    x_sb ++;
    
    @autoreleasepool {
        AIKITInputData *inputs = [[AIKITInputData alloc] init];
        NSData *part = [audioData subdataWithRange:NSMakeRange(loc_dsb, writeLen)];
        
        //传入音频数据
        if (loc_dsb == 0) {
            [inputs addAudio:part key:@"audio" status:DataStatusBegin];
        } else if (isLast) {
            [inputs addAudio:part key:@"audio" status:DataStatusEnd];
        } else {
            [inputs addAudio:part key:@"audio" status:DataStatusContinue];
        }
        //音频附属参数
        AIKITParameters *audioParam = [[AIKITParameters alloc] init];
        [audioParam addString:@"encoding" value:@"raw"];
        [audioParam addInt:@"sample_rate" value:16000];
        [audioParam addInt:@"seq" value:x_sb];
        
        [inputs addControl:audioParam key:@"audio"];
        ret = [AiHelper write:inputs handle:self.handle];
    }
    if (ret != 0) {
        NSLog(@"音频写入失败:%d",ret);
        return;
    }
    [NSThread sleepForTimeInterval:0.04]; //间隔时长
}
创建input:
参数类型说明必填
audiodata驱动音频是
ctrl_tdata字偏移控制指令否
control
参数类型说明必填
audioobject含有 encoding、sample_rate、seq等参数是
encodingstring编码格式: 默认值raw是
sample_rateint采样率: 16000是
seqint数据序号:标明数据为第几块是
ctrl_tobject含有 encoding、sample_rate、seq等参数否

#4.7 重置接口#

reset 接口用于中止当前正在进行中的所有驱动任务,回到虚拟形象静默状态
/** 
 * 中止进行中的驱动
 * @return 结果错误码,0=成功
 */
 int ret = [AiHelper reset:self.handle];

#4.8 结束虚拟人服务#

/** 
 * 结束会话实例
 * @return 结果错误码,0=成功
 */
 int ret = [AiHelper end:self.handle];

#4.9 SDK逆初始化#

/** 
 * SDK逆初始化函数用以释放SDK所占资源
 * @return 结果错误码,0=成功
 */
int ret = [ILibrary unInit];  

#字偏移控制指令#

ctrl_w
参数类型说明必填
avatar[]形象控制,单次输入含1个或多个控制项是
typestring控制数据类型,支持动作控制 取值: action是
value控制数据取值动作id 如:A_LH_introduced_O是
wbint字偏移起始位置,char begin文本驱动需要;音频驱动不需要该字段
wechar字偏移终止位置,char end动作终止位置(暂不支持)音频驱动时,不要传该字段

#字幕#

字幕相关的模板详细见demo,其中subtitle_portrait.json 竖屏字幕模板,subtitle_landscape.json 横屏字幕模板,demo中的字幕模板默认用的subtitle_portrait.json ,想看demo中横屏效果,修改config_new.json中的 宽高为1920 × 1080,字幕模板使用subtitle_landscape.json ,字幕模板上传后需重新启动虚拟人服务然后进行文本驱动

#5. 附录#

虚拟形象实时交互服务接口文档
上一页
Android-SDK
下一页
AI虚拟人技术 API 文档
Built with