接入流程
开发准备
SDK 获取
接入须知
开发者在调用前请先查看录音文件识别极速版的 接口说明，了解接口的使用要求和使用步骤。
该接口需要手机能够连接网络（3G、4G、5G 或 Wi-Fi 网络等），且系统为 iOS 9.0及以上版本。
运行 Demo 必须设置 AppID、SecretID、SecretKey，可在 API 密钥管理 中获取。
SDK 导入
直接导入
1. 下载并解压 iOS SDK 压缩包，压缩包中包含 Demo 和 SDK，其中 QCloudFileRecognizer.xcframework 为录音文件识别极速版 framework 包； VoiceCommon.framework 为语音 SDK 公共组件 framework 包。
2. XcodeFile > Add Files to "Your Project"，在弹出 Panel 选中所下载 SDK 包 QCloudFileRecognizer.xcframework > Add（选中“Copy items if needed”）。
CocoaPods导入
使用 CocoaPods 导入时,需将以下内容添加到 Podfile 中。
pod 'QCloudFileRecognizer'
工程配置
在工程中添加依赖库，在 build Phases Link Binary With Libraries 中添加以下库：
QCloudFileRecognizer.xcframework
VoiceCommon.framework
libc++.tbd
AVFoundation.framework
AudioToolbox.framework
类说明
QCloudFlashFileRecognizer 初始化说明
QCloudFlashFileRecognizer 是录音文件极速版入口类。
/**通过 appId secretId secretKey 初始化@param appid 腾讯云 appId@param secretId 腾讯云 secretId@param secretKey 腾讯云 secretKey**/- (instancetype)initWithAppId:(NSString *)appid secretId:(NSString *)secretId secretKey:(NSString *)secretKey;/**通过 appId 临时secretId 临时secretKey token 初始化详见 https://cloud.tencent.com/document/product/598/33416@param appid 腾讯云 appId@param secretId 腾讯云 临时secretId@param secretKey 腾讯云 临时secretKey@param token 腾讯云 token**/- (instancetype)initWithAppId:(NSString *)appid secretId:(NSString *)secretId secretKey:(NSString *)secretKey token:(NSString *)token;
QCloudFlashFileRecognizerDelegate 协议说明
此 delegate 为录音文件识别相关回调，调用者需要实现此 delegate 获取识别结果事件。
@protocol QCloudFlashFileRecognizerDelegate <NSObject>@optional/**录音文件识别获取服务器结果成功回调@param recognizer 录音文件识别器@param status 非0时识别失败@param text 识别文本，status非0时，此为服务器端返回的错误信息@param resultData 原始数据*/- (void)FlashFileRecognizer:(QCloudFlashFileRecognizer *_Nullable)recognizer status:(nullable NSInteger *) status text:(nullable NSString *)text resultData:(nullable NSDictionary *)resultData;/**录音文件识别失败回调@param recognizer 录音文件识别器@param error 识别错误，出现错误此字段有@param resultData 原始数据*/- (void)FlashFileRecognizer:(QCloudFlashFileRecognizer *_Nullable)recognizer error:(nullable NSError *)error resultData:(nullable NSDictionary *)resultData;@end
示例
1. 创建 QCloudFlashFileRecognizer 实例
QCloudFlashFileRecognizer *recognizer = [[QCloudFlashFileRecognizer alloc] initWithAppId:appIdsecretId:secretId secretKey:secretKey];//设置 delegate，相关回调方法见 QCloudFlashFileRecognizerDelegate 定义recognizer.delegate = self;
2. 实现此 QCloudFlashFileRecognizerDelegate 协议方法
3. 调用方式示例
(void)recognizeWithAudioData {QCloudFlashFileRecognizeParams *params = [QCloudFlashFileRecognizeParams defaultRequestParams];NSString *filePath = [[NSBundle mainBundle] pathForResource:@"test" ofType:@"mp3"];NSData *audioData = [[NSData alloc] initWithContentsOfFile:filePath];params.audioData = audioData;//音频格式。支持 wav、pcm、ogg-opus、speex、silk、mp3、m4a、aac。params.voiceFormat = @"mp3";//以下参数不设置将使用默认值params.engineModelType = @"16k_zh";//引擎模型类型,默认16k_zh。8k_zh：8k 中文普通话通用；16k_zh：16k 中文普通话通用；16k_zh_video：16k 音视频领域。params.filterDirty = 0;;// 0 ：默认状态 不过滤脏话 1：过滤脏话params.filterModal = 0;// 0 ：默认状态 不过滤语气词 1：过滤部分语气词 2:严格过滤params.filterPunc = 0;// 0 ：默认状态 不过滤句末的句号 1：滤句末的句号params.convertNumMode = 1;;//1：默认状态 根据场景智能转换为阿拉伯数字；0：全部转为中文数字。params.speakerDiarization = 0; //是否开启说话人分离（目前支持中文普通话引擎），默认为0，0：不开启，1：开启。params.firstChannelOnly = 1; //是否只识别首个声道，默认为1。0：识别所有声道；1：识别首个声道。params.wordInfo = 0; //是否显示词级别时间戳，默认为0。0：不显示；1：显示，不包含标点时间戳，2：显示，包含标点时间戳。params.customizationID = @""; //自学习模型 id。如设置了该参数，将生效对应的自学习模型。params.hotwordID = @""; // 热词表 id。如不设置该参数，自动生效默认热词表；如设置了该参数，那么将生效对应的热词表。[_recognizer recognize:params];}
QCloudVoiceLogger 日志设置说明
用于宿主层对 SDK log 等级设置以及本地逻辑、回调功能实现。导包 <VoiceCommon/QCloudVoiceLogger.h>
1. + (void)setLoggerLevel:(VoiceLoggerLevel)level;
设置 Log 等级。默认为 VOICE_SDK_ERROR_LEVEL 等级
2. + (void)needLogFile:(BOOL) needLogFile;
设置 log 本地落盘开关，默认为 false，needLogFile=true 则将 log 落盘到手机本地，默认路径为 Documents/test。不支持自定义路径，若需要自定义 log 写入业务可通过 registerLoggerListener 实现。落盘的 log 不受 log 等级过滤限制。
3. + (void)registerLoggerListener:(OnLoggerEventBlock _Nullable)listener withNativeLog:(BOOL)needNative;
宿主层对 SDK log 回调注册接口。needNative 参数默认传 true 即可。
示例
//导入日志工具类头文件#import <VoiceCommon/QCloudVoiceLogger.h>//设置log等级为DEBUG级， 上生产环境可选择ERROR等级的log[QCloudVoiceLogger setLoggerLevel:VOICE_SDK_DEBUG_LEVEL];// (可选)将log写入本地磁盘，上生产环境建议关闭。[QCloudVoiceLogger needLogFile:YES];// (可选)注册log回调[QCloudVoiceLogger registerLoggerListener:^(VoiceLoggerLevel loggerLevel, NSString * _Nonnull logInfo) {NSLog(@"[ASR]-%@",logInfo);} withNativeLog:YES];
