音频驱动
ws(s)://vms.cn-huadong-1.xf-yun.com/v1/private/vms2d_audio_ctrl
参数名 | 类型 | 必传 | 描述 |
---|---|---|---|
header | Object | 是 | 协议头部,用于描述平台特性的参数 |
header.app_id | string | 是 | 在平台申请的appid信息 |
header.session | string | 是 | 会话的session,必须携带该字段,取值从start的响应数据中获取 |
header.status | int | 是 | 数据状态 |
header.uid | string | 是 | 请求用户服务返回的uid,用户及设备级别个性化功能依赖此参数 |
payload | Object | 是 | 数据段,携带请求的数据 |
payload.audio | Object | 是 | 输入数据 |
payload.audio.encoding | string | 否 | 音频编码,可选值:lame, opus-wb, speex-wb, raw(默认) |
payload.audio.sample_rate | int | 否 | 音频采样率,可选值:16000 |
payload.audio.channels | int | 否 | 声道数,可选值:1 |
payload.audio.bit_depth | int | 否 | 位深,单位bit,可选值:16 |
payload.audio.status | int | 是 | 数据状态,0:开始, 1:开始, 2:结束 |
payload.audio.seq | int | 否 | 数据序号 |
payload.audio.audio | string | 是 | 音频数据,需base64编码,音频大小:0~10M 注意:由于平台在用户送end结束标识的时候,如果没有语音数据则该请求将被忽略,导致引擎接收不到结束标识,用户将无法获取部分尾部合成数据! 因此:如果最后一帧的语音长度为1,且status=2,那么引擎层可以接收到该请求,同时会将该帧作为结束标识,并丢弃这1个字节的废数据合成,从而保证用户能获取准确完整的合成数据 |
payload.audio.frame_size | int | 否 | 帧大小,最小值:0(默认), 最大值:1024 |
payload.ctrl_t | Object | 是 | 输入数据 |
payload.ctrl_t.encoding | string | 否 | 文本编码,可选值:utf-8 |
payload.ctrl_t.compress | string | 否 | 文本压缩格式,可选值:raw |
payload.ctrl_t.format | string | 否 | 文本格式,可选值:json |
payload.ctrl_t.status | int | 是 | 数据状态,0:开始, 1:开始, 2:结束 |
payload.ctrl_t.seq | int | 是 | 数据序号,最小值:0, 最大值:9999999 |
payload.ctrl_t.text | string | 是 | 驱动指令,json格式,文本大小:0-1M |
{
"header": {
"code": 0,
"message": "success",
"session": "xdF7sUElilEdfmAlfGFHu8h5EmHlgQAZgQAcfmIZhmRMgQv4hmWlfGF4tTIlilFkv7RbgVAciVwnh5BHwQWKhQBphmkpr4rLgVI5gQW8glF9",
"sid": "vms000f4062@hu1850f6923bc0442882",
"status": 0
}
}
字段 | 类型 | 说明 |
---|---|---|
header | Object | 协议头部,用于描述平台特性的参数 |
header.code | int | 返回码,0表示成功,其它表示异常 |
header.message | string | 返回信息详细描述 |
header.sid | string | 本次会话的id |
header.session | string | 会话的session |
header.status | int | 状态码 |
请求参数
无
修改于 2023-12-19 06:29:46