小雅OS开放平台文档

小雅OS开放平台文档

  • 快速入门
  • 客户端接入
  • 服务端接入

›Android SDK

概述

  • 客户端接入

API 接入

  • WebSocket接口协议定义
  • Http接口协议定义
  • 调用样例
  • API 列表
  • 实体列表
  • 错误码

设备端

    Android SDK

    • 配置工程
    • 初始化
    • 功能
    • 回调
    • Demo 使用
    • 更新日志

    iOS SDK

    • 配置工程
    • 初始化
    • 功能
    • 回调
    • 更新日志

    C++ SDK

    • SDK获取方法
    • 环境要求
    • 目录结构
    • SDK架构
    • 调用示例
    • 接口文档

手机伴侣

    Android SDK

    • 接入准备
    • 账号模块
    • 内容模块
    • 反向控制
    • 设备管理模块
    • 技能模块
    • 蓝牙模块
    • 更新日志

    iOS SDK

    • 接入准备
    • 账号模块
    • 内容模块
    • 反向控制
    • 设备管理模块
    • 技能模块

内容页

    Android

    • 更新日志
    • 初始化

    iOS

    • 更新日志
    • 初始化

配置工程

接入准备

(1)在 小雅开放平台-硬件开放平台 中设备详情页的“设备接入”模块中,获取productId、productSecret、ptfId信息。

介绍

(2)sdk以及demo可通过线下邮件获取

(3)将SDK中的com.ximalaya.xiaoya.devicesdk-XXX.aar包放入工程的libs目录下,同时在gradle中添加依赖。(XXX为版本号)

配置 gradle

(1) 指定 aar 文件夹

在 gradle 里添加下面代码,指定 aar 的文件夹,如果已经存在则忽略:

repositories{
    flatDir {
        dirs 'libs'
    }
}

(2) 添加 dependencies

然后在 dependencies 中配置 com.ximalaya.xiaoya.devicesdk-XXX.aar 的依赖,由于其依赖了 exoplayer,所以还要添加 exoplayer 的依赖。

implementation(name:'com.ximalaya.xiaoya.devicesdk-XXX', ext:'aar')
implementation 'com.google.android.exoplayer:exoplayer-core:2.9.6'

(3) 添加 Java 8 支持

由于 exoplayer 用到了 Java 8,所以需要配置一下,添加下面代码到 android 下面:

compileOptions {
    sourceCompatibility JavaVersion.VERSION_1_8
    targetCompatibility JavaVersion.VERSION_1_8
}

(4) abiFilters过滤

devicesdk的aar包含armeabi、armeabi-v7a、arm64-v8a三种so,请用abiFilters过滤需要的abi以减小集成后的包大小。

ndk {
    abiFilters 'armeabi'//, 'armeabi-v7a', 'arm64-v8a'
}

添加权限

在 AndroidManifest.xml 中添加需要的权限,如果已经有的可以忽略:

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />

配置文件

开发者可以在开放平台官网生成配置文件,可以配置人设、语速、asr语音识别方案 等属性,生成的文件可以下载到本地,注意需要命名为 xiaoya_open_platform_config.ini,然后放到 ${project}/src/main/assets 下即可。

混淆规则

-keep class com.ximalaya.xiaoya.** {*;}
← 错误码初始化 →
  • 接入准备
  • 配置 gradle
    • (1) 指定 aar 文件夹
    • (2) 添加 dependencies
    • (3) 添加 Java 8 支持
    • (4) abiFilters过滤
  • 添加权限
  • 配置文件
  • 混淆规则
北京小雅星空科技有限公司 京ICP备19010603号