日期：2017-06-05

修订版本：1.0.21

变更日志

• 1.0.21

小更新。

• 1.0.20

兼容和不兼容混合。

• 1.0.19-c

与旧音频标签算法兼容。

• 1.0.19

小优化。

• 1.0.18

移除对旧音频标签算法的支持。

• 1.0.6

支持新的音频标签算法。

• 1.0.4

在生产环境中支持 IPv6。

• 1.0.3

添加 IPv6 支持（仅限实验性使用，请在产品环境中不要使用它）

• 1.0.2

添加 IPv6 支持（仅限实验性使用，请在产品环境中不要使用它）

• 1.0.1

CWSSDK 接口更新。

前言

此文档展示了如何将 CWS SDK 集成到您的 iOS 项目中。

SDK

版本: 1.0.6

描述：该 SDK 提供了 ACR（自动内容识别）功能，允许第三方应用通过监听音频源来检索用户定义的内容。

先决条件

语言：Objective-C

IDE：XCode 8

凭证：appId & appSecret

安装

Podfile

要使用 CocoaPods 将 CWSSDK 集成到您的 Xcode 项目中，请在 Podfile 中指定它

platform :ios, '8.0'

target 'Target' do
    use_frameworks!
    inhibit_all_warnings!

    pod 'CWSSDK', '~> 1.0'
    target 'TargetTests' do
        inherit! :search_paths
        # Pods for testing
    end
end

然后，运行以下命令

$ pod install

手动操作

1. 下载 CWSSDK_iOS_1.0.6.zip 并解压它。您将获得以下文件

   • CWSSDK.framework：要与您的 iOS 项目链接的框架文件。
   • CWSSDKDemo：已集成 SDK 的示例 iOS 应用项目。

2. 将 CWSSDK.framework 复制到您的项目文件夹并添加到您的项目。

3. 将框架文件链接到您的项目。

   点击 项目 > 目标 > “通用”选项卡 > 在“链接的框架和库”中点击加号 > 添加其他...

4. 创建一个新的复制文件阶段并将框架文件作为框架复制。

   在同一视图中，点击 构建过程 > 左上角的加号 > 新建复制文件阶段

入门

1. 将 NSMicrophoneUsageDescription 添加到项目的 Info.plist。

   请注意，我们的 SDK 在用户触发摇动事件时使用麦克风。并且必须将上述键值对添加到 Info.plist 中。否则，应用将无法运行。

2. 导入 SDK 头文件。

#import <CWSSDK/CWSSDK.h>

7. 使您的视图控制器扩展 CWSViewController。

@interface ViewController : CWSShakeViewController

8. 使您的视图控制器或其他对象遵守CWSShakeDelegate，并实现该代理中定义的所有必需方法。

CWSDelegate是在SDK中定义的一个协议。声明如下：

@protocol CWSShakeDelegate <NSObject>

@required

- (void)shakeControllerDidShake:(CWSShakeViewController *)controller;

- (void)shakeController:(CWSShakeViewController *)controller didSucceedWithUserContent:(CWSUserContent *)userContent;

- (void)shakeControllerDidCancel:(CWSShakeViewController *)controller;

- (void)shakeController:(CWSShakeViewController *)controller didFailWithError:(CWSError *)error;

- (void)shakeControllerDidTimeout:(CWSShakeViewController *)controller;
@end

遵守此协议

@interface ViewController () <CWSShakeDelegate>

self.shakeDelegate = self;

9. 在调用SDK的任何其他功能之前，请使用您的appId和appSecret调用register方法。

[CWSSDK registerWithAppId:APP_ID appSecret:APP_SECRET success:^{

} failure:^(CWSError *error) {

} timeout:^{

}];

10. 编译并运行应用程序。

由于我们的SDK使用麦克风录制音频，而触发录音的唯一方式是通过摇晃，您必须在真实设备上测试该应用程序。您可能需要一个演示视频来测试ACR功能。您可以使用以下演示视频来测试您的应用程序：https://shake2buy.com/