Audiogum iOS SDK

有关Audiogum平台的概述，请参阅 https://www.audiogum.com/developers

使用SDK需要客户端密钥和秘密。请联系以获取这些信息。

文档

SDK的文档可以在 https://www.audiogum.com/developers/docs/iossdk.html 找到。

安装

要构建项目，请使用Carthage安装依赖项。如果需要，请安装Carthage，然后从存储库的本地副本根目录运行以下命令

carthage bootstrap --platform iOS
cd Samples & carthage bootstrap --platform iOS

安装依赖项后，您应该能够使用Xcode打开Audiogum.xcworkspace。该工作区包含三个项目 - Audiogum（源代码和测试）、Remote Control（Swift示例应用）和Voice Control（Swift示例应用）。

Audiogum项目包含Objective-C测试（在AGMClientTests文件夹中）和Swift测试（在AudiogumTests文件夹中），它们演示了如何从Objective-C或Swift调用方法并使用其响应。您需要在TestConfig类（在AudiogumTests/utils中）和AGMConsts.m（在AGMTests中）中添加客户端密钥和秘密，以及将被用于创建测试用户的电子邮件地址和密码。

SDK使用google promises从Audiogum平台获取异步响应。

远程控制和语音控制示例应用程序是使用Swift与SDK结合使用的更详细的示例。您的客户端密钥和密钥需要在每个项目的ApiConstants类中添加。远程控制应用程序将远程控制命令发送到Audiogum服务，可以用来控制已连接的设备。有关如何在设备固件中添加Audiogum服务的更多信息，请参阅我们的固件集成指南。语音控制应用程序将嵌入的wav文件中的音频数据发送到Audiogum服务，该服务返回远程控制命令。有关更多信息，请参阅我们的Audiogum语音API。

包含在远程控制应用程序中使用的UI元素编写的Sketch文件已包含（在远程控制目录中），供您修改设计。Audiogum矢量徽标也包含在内。

开始使用

Audiogum iOS SDK可以使用CocoaPods或Carthage进行安装。

使用CocoaPods将Audiogum添加到您的项目中，请将以下内容添加到您的Podfile

pod 'Audiogum'

某些依赖项是Swift，所以如果您的项目是Objective-C，您需要启用模块头

pod 'Audiogum:modular_headers => true'

使用Carthage将Audiogum添加到您的项目中，请将以下内容添加到您的Cartfile

github "audiogum/iossdk" 

在Swift中使用您的客户端ID和密钥初始化AudiogumClient

let client = AudiogumClient(clientId: "YOUR_CLIENT_ID",
        clientSecret: "YOUR_CLIENT_SECRET",
        deviceId: "YOUR_DEVICE_ID")

或在Objective-C中

AGMClient *deviceClient = deviceClient = [[AGMClient alloc] initWithClientId:YOUR_CLIENT_ID 
        clientSecret:YOUR_CLIENT_SECRET 
        deviceId:YOUR_DEVICE_ID];

设备将进行身份验证，但许多方法还需要用户身份验证 - 因此在Swift中创建/登录一个用户

client.loginUser(email: email, password: password).then {
...
}

或在Objective-C中

[loginUserWithEmail:TEST_USERNAME withPassword:TEST_PASSWORD] then:^id(NSNull *null) {
...
}

在AudiogumClient类（Swift）或AGMClient（Objective-C）上调用方法。