小雅OS开放平台文档

小雅OS开放平台文档

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

›iOS SDK

概述

  • 客户端接入

API 接入

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

设备端

    Android SDK

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

    iOS SDK

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

    C++ SDK

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

手机伴侣

    Android SDK

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

    iOS SDK

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

内容页

    Android

    • 更新日志
    • 初始化

    iOS

    • 更新日志
    • 初始化

反向控制

引用头文件 <XYServiceSDK/XYSDK+ReverseController.h> 并使用以下接口:

音乐点播

+ (void)reverseOperationStartMusicAOD:(NSDictionary *_Nonnull)info
Completion:(void(^_Nullable)(NSDictionary * _Nullable statusInfo, NSError * _Nullable error))completion;

info: 音乐资源信息,NSDictionary类型,需传入"albumId"和"trackId"

FM点播

+ (void)reverseOperationStartFMAOD:(NSDictionary *_Nonnull)info
Completion:(void(^_Nullable)(NSDictionary * _Nullable statusInfo, NSError * _Nullable error))completion;

info: 音乐资源信息,NSDictionary类型,需传入"albumId"和"trackId"

暂停

+ (void)reverseOperationPauseCompletion:(void(^_Nullable)(NSDictionary * _Nullable statusInfo, NSError * _Nullable error))completion;

继续播放

+ (void)reverseOperationPlayCompletion:(void(^_Nullable)(NSDictionary * _Nullable statusInfo, NSError * _Nullable error))completion;

上一曲

+ (void)reverseOperationPreviousCompletion:(void(^_Nullable)(NSDictionary * _Nullable statusInfo, NSError * _Nullable error))completion;

下一曲

+ (void)reverseOperationNextCompletion:(void(^_Nullable)(NSDictionary * _Nullable statusInfo, NSError * _Nullable error))completion;

设置音量

+ (void)reverseOperationVolume:(NSInteger)volume
completion:(void(^_Nullable)(NSDictionary * _Nullable statusInfo, NSError * _Nullable error))completion;

volume: 音量值,NSInteger类型,数值0-10

音箱播放状态

为实时地获取音箱当前播放状态,需使用OVSReverseControlProtocol协议,引用 <XYServiceSDK/OVSReverseController.h> 头文件,实现代理[OVSReverseController shareInstance].delegate = self并通过以下方法监听结果:

- (void)notifyReverseDeviceStatusInfo:(NSDictionary *)info;

deviceStatusInfo:

字段类型描述
bluetoothStatusBOOL蓝牙状态
volumeNSInteger音量数值
onlineStatusBOOL音箱在线状态
networkStatusBOOL网络状态
micStatusBOOL网络状态
action_vod.artistNSString专辑的作者
action_vod.track_idNSString当前资源id
action_vod.trackNSString当前资源标题
action_vod.album_idNSString专辑id
action_vod.album_idNSString专辑标题
action_vod.bg_img_smallNSString封面图url
← 内容模块设备管理模块 →
  • 音乐点播
  • FM点播
  • 暂停
  • 继续播放
  • 上一曲
  • 下一曲
  • 设置音量
  • 音箱播放状态
北京小雅星空科技有限公司 京ICP备19010603号