语音业务

更新时间:2022-11-24 09:20:11下载pdf

本文介绍了语音业务相关的接口。

API 列表

函数名称 功能描述
voice_svc_init 语音模块初始化
voice_svc_start 语音模块启动
voice_speaker_upload_send 语音开始上传
voice_speaker_upload_stop 语音停止上传
voice_speaker_mqtt_report_nick_name 设置昵称
speaker_mqtt_report_dev_status 上传语音状态
onThingConfig 配网状态回调
onTaskAlert 配网状态回调
onCloudMedia 媒体信息回调
onAlarmClock 闹钟回调
onMediaControl 媒体控制回调
onMediaVolume 音量设置回调
onCloudExtMsg MQTT protocol 501 扩展消息接口
onNickName 昵称设置回调

API 说明

voice_svc_init

函数原型

fun voice_svc_init(voiceListener: VoiceListener): Int

功能说明

语音模块初始化

参数说明

参数名称 说明
voiceListener 语音操作回调

返回值

返回值 说明
0 成功
非0 失败

voice_svc_start

函数原型

external fun voice_svc_start(): Int

功能说明

语音模块启动

返回值

返回值 说明
0 成功
非0 失败

voice_speaker_upload_send

函数原型

external fun voice_speaker_upload_send(data: ByteArray): Int

功能说明

语音开始上传

参数说明

参数名称 说明
data 语音数据

返回值

返回值 说明
0 成功
非0 失败

voice_speaker_upload_stop

函数原型

external fun voice_speaker_upload_stop(): Int

功能说明

语音停止上传

返回值

返回值 说明
0 成功
非0 失败

voice_speaker_mqtt_report_nick_name

函数原型

fun voice_speaker_mqtt_report_nick_name(
        mode: DataEnum.TY_NICK_NAME_MODE_T,
        nickName: String,
        pinyin: String
    ): Int

功能说明

设置昵称

参数说明

参数名称 说明
mode 删除/设置 模式
nickName 昵称
pinyin 昵称拼音

返回值

返回值 说明
0 成功
非0 失败

speaker_mqtt_report_dev_status

函数原型

fun speaker_mqtt_report_dev_status(tyVoiceDevStatusE: DataEnum.TY_VOICE_DEV_STATUS_E): Int {
        return speaker_mqtt_report_dev_status(tyVoiceDevStatusE.value)
    }

功能说明

上传语音状态

参数说明

参数名称 说明
tyVoiceDevStatusE TY_VOICE_DEV_STATUS_E

返回值

返回值 说明
0 成功
非0 失败

onThingConfig

函数原型

fun onThingConfig(mode: Int, token: String, timeout: Int)

功能说明

配网状态回调

参数说明

参数名称 说明
mode 配网状态,值为 THING_CONFIG_XXX 之一:[.THING_CONFIG_START],[.THING_CONFIG_STOP],[.THING_CONFIG_INVALD]
token token
timeout 超时时间

onTaskAlert

函数原型

fun onTaskAlert(type: Int, msg: String)

功能说明

配网状态回调

参数说明

参数名称 说明
type 任务类型
msg 下发的提醒事件,JSON 格式的字符串

onCloudMedia

函数原型

fun onCloudMedia(mediaAttributes: Array<MediaAttribute>)

功能说明

媒体信息回调

参数说明

参数名称 说明
mediaAttributes 媒体信息集合

onAlarmClock

函数原型

fun onAlarmClock(alarm: String)

功能说明

闹钟回调

参数说明

参数名称 说明
alarm 设置的闹钟事件触发通知

onMediaControl

函数原型

fun onMediaControl(ctl: Int)

功能说明

媒体控制回调

参数说明

参数名称 说明
ctl 网关下发的媒体控制指令,App 需要更具下发的指令执行对应的操作。

onMediaVolume

函数原型

fun onMediaVolume(vol: Int)

功能说明

音量设置回调。

参数说明

参数名称 说明
vol 音量值,取值 0 ~ 100

onCloudExtMsg

函数原型

fun onCloudExtMsg(type: String, msg: String)

功能说明

MQTT protocol 501 扩展消息接口。

参数说明

参数名称 说明
type 消息类型
msg JSON 格式消息

onNickName

函数原型

fun onNickName(mode: Int, nickname: String?, pinyin: String?)

功能说明

昵称设置回调。

参数说明

参数名称 说明
mode 删除/设置 模式
nickName 昵称
pinyin 昵称拼音