介绍
本文介绍了适用于亿联 SkySound 设备的第三方控制 API 命令的功能和语法,并进行了详细的介绍,旨在指导读者完成 SkySound 产品的控制集成。
快速入门
开启命令字符串
对于需要控制的设备,需打开设备的命令字符串开关。
在Yealink Room Designer中,进入设备管理页面。
选择对应设备的设置页面,在系统 > 服务中,开启命令字符串。
网络相关配置
该设备支持网络模式控制主机设备,使用TCP协议建立连接,客户端需要知道主机的IP地址和端口号才能连接到主机端。
中央控制器网络模式的控制端口配置设置为6024。
IP地址可根据实际情况查看。
密码鉴权
如果中央控制器的网络模式开启了密码认证,通过TCP协议建立连接时,需要输入密码并通过认证后才能执行控制命令。密码输入格式为“XXXX\r\n”,其中XXXX代表正确的密码。
例如,建立TCP连接后,如果收到“Password:\r\n”的消息,则表示需要输入认证密码。
如果输入的密码不正确,连接将返回“Invalid Password!\r\nPassword:\r\n”,提示您重新输入密码进行认证。
只要输入正确的密码,连接就会返回“welcome yealink centralcontrol”。
API 语法
基本语法
以下是Yealink SkySound API 的语法:
命令字全部小写。
基本命令结构: “命令+参数”。
参数组成:参数名+参数值,以冒号(:)分隔。整体格式为JSON字符串传输。
数据包格式
发送格式说明:\r\n(回车换行)作为结束分隔符。 所有 API 命令都需要包含 \r\n 作为结束分隔符。
响应格式说明:\r\n作为结束分隔符。 所有响应数据包均以 \r\n 作为结束分隔符。
基本命令格式:
命令 + \r\n(无参数类型)
命令+空格+JSON字符串+\r\n(带参数类型)
命令+空格+ app:value +空格+JSON 字符串+ \r\n(带参数和 app 参数类型)
注意事项:
若输入命令后返回相同输入命令,可能是格式或指令有误,请检查指令格式及内容是否正确。
需要使用通道名称的命令,通道名称不能使用备注名称。
API 命令介绍
当前支持的 API 命令列表如下。建议读者参考命令说明,并在调试过程中使用 TCP 调试工具,基于上述环境支持情况构建并测试 API 命令。支持的命令和参数可能因版本和型号而异。
API命令参数中的可选参数用方括号[]括起来。
获取系统硬件信息
支持机型
AP08, CM20, CM50, CM50 Pro, CS10, CS10-D, AVBridge
指令
system get sys-info\r\n
返回参数
参数
类型
描述
model
string
设备机型
firmware
string
软件版本号
hardware
string
硬件版本号
serialnumber
string
设备sn号
macaddress
string
设备mac地址
cc-version
string
中控版本号
vendor
string
设备厂商名称
请求示例
system get sys-info\r\n
返回示例
system get sys-info {"model":"AP08","firmware":"294.435.0.20","hardware":"294.0.0.0.0.0.0","serialnumber":"203097G070000041","macaddress":"44:db:d2:56:b9:56","cc-version":"10.0.251.4","vendor":"Yealink"}\r\n
获取网络信息
支持机型
AP08, CM20, CM50, CM50 Pro, CS10, CS10-D, AVBridge
指令
network get info\r\n
返回参数
参数
类型
描述
network-list
network-list[]
网络信息列表
network-list[]
参数
类型
数值范围
描述
type
int
[0,1]
获取网络方式
0:动态获取
1:静态设置
port-type
int
[0,1,2,3,4,5,6]
网口类型
0:有线网口1
1:有线网口2
2:无线网口
3:AP网口
4:LAN口
5:Dante网络
6:AST芯片网络
mode
int
[0,1,2]
IP类型
0:IPv4
1:IPv6
2:IPv4和IPv6
ip
string
无
IP地址
mask
string
无
子网掩码
gateway
string
无
网关
primary-dns
string
无
首选dns服务器名
second-dns
string
无
备选dns服务器名
dante-name
string
无
音频网络的Dante名称。
仅 AP08, CM50 和 AVBridge支持。
请求示例
network get info\r\n
返回示例
network get info {"network-list":[{"type":0,"port-type":4,"mode":0,"ip":"169.254.22.145","mask":"255.255.0.0","gateway":"","primary-dns":"","second-dns":""},{"type":0,"port-type":2,"mode":0,"ip":"","mask":"","gateway":"","primary-dns":"","second-dns":""},{"type":0,"port-type":0,"mode":0,"ip":"10.50.69.53","mask":"255.255.255.0","gateway":"10.50.69.254","primary-dns":"10.100.1.1","second-dns":"10.100.1.2"}],"dante-name":"AP08-2d3192"}\r\n
设置设备定位开关
支持机型
AP08, CM20, CM50, CM50 Pro, CS10, CS10-D, AVBridge
指令
system set locating-status\r\n
请求参数
参数
类型
数值范围
是否必需
描述
status
string
["on", "off"]
是
on: 打开设备定位
off: 关闭设备定位
请求示例
system set locating-status {"status":"on"}\r\n
返回示例
system set locating-status {"status":"on"}\r\n
设置系统状态
支持机型
AP08, CM20, CM50, CM50 Pro, CS10, CS10-D, AVBridge
指令
system set status {"status":"<value>"}\r\n
请求参数
参数
类型
数值范围
是否必需
描述
status
string
["reboot", "reset"]
是
系统状态
reboot:重启
reset:恢复出厂
请求示例
system set status {"status":"reboot"}\r\n
返回示例
system set status {"status":"reboot"}\r\n
获取LED灯开关状态
支持机型
CM20, CM50, CM50 Pro, CS10, CS10-D
指令
system get led-preset enable\r\n
返回参数
参数
类型
数值范围
描述
enable
string
["on", "off"]
on:开启状态
off:关闭状态
请求示例
system get led-preset enable\r\n
返回示例
system get led-preset enable {"enable":"off"}\r\n
设置LED灯开关
支持机型
CM20, CM50, CM50 Pro, CS10, CS10-D
指令
system set led-preset-status\r\n
请求参数
参数
类型
数值范围
是否必需
描述
enable
string
["on", "off"]
是
on: 打开LED灯
off: 关闭LED灯
打开及关闭的都是对应事件的LED灯。
请求示例
system set led-preset-status {"enable": "on"}\r\n
返回示例
system set led-preset-status {"enable": "on"}\r\n
获取LED灯事件的颜色
支持机型
CM20, CM50, CM50 Pro
指令
system get led-preset config\r\n
请求参数
参数
类型
数值范围
是否必需
描述
event
string
["mute", "unmute"]
是
获取灯颜色的事件
返回参数
参数
类型
数值范围
描述
event
string
["mute", "unmute"]
无
color
string
["red", "green", "orange", "#xxxxxx"]
灯的颜色
请求示例
system get led-preset config {"event":"unmute"}\r\n
返回示例
system get led-preset config {"color":"#00FF00FF","event":"unmute"}\r\n
设置LED灯事件的颜色
支持机型
CM20, CM50, CM50 Pro
指令
system set led-preset config\r\n
请求参数
参数
类型
数值范围
是否必需
描述
event
string
["mute", "unmute"]
是
灯的事件
color
string
["red", "green", "orange", "#xxxxxx"]
是
对应事件的灯的颜色
请求示例
system set led-preset config {"event":"mute","color":"red"}\r\n
返回示例
system set led-preset config {"event":"mute","color":"red"}\r\n
获取设备通道声源信息
支持机型
CM50, CM50 Pro
指令
audio get lobe-enable\r\n
返回参数
参数
类型
是否必需
描述
max_channel_count
int
是
最大通道数
channel_enable
bool[]
是
通道使用状态
请求示例
audio get lobe-enable\r\n
返回示例
audio get lobe-enable {"max_channel_count":8,"channel_enable":[true,true,true,true,true,true,true,true]}\r\n
获取设备声源通道激活状态
支持机型
CM50, CM50 Pro
指令
audio get lobe-activation\r\n
返回参数
参数
类型
是否必需
描述
active_status
bool[]
是
通道激活状态
请求示例
audio get lobe-activation\r\n
返回示例
audio get lobe-activation {"active_status":[true,true,true,true,true,true,true,true]}\r\n
获取发言者位置坐标
支持机型
CM50, CM50 Pro
指令
audio get sound-locate\r\n
返回参数
参数
类型
是否必需
描述
doa
doa[]
是
设备doa数组信息
doa[]
参数
类型
是否必需
描述
dev_type
string
是
设备类型
dev_sn
string
是
设备SN
snd_src_num
int
是
声源个数
snd_src
snd_src[]
是
声源数据
snd_src[]
参数
类型
是否必需
描述
x
int
是
x轴数值
y
int
是
y轴数值
z
int
是
z轴数值
请求示例
audio get sound-locate\r\n
返回示例
audio get sound-locate {"doa":[{"dev_type":"CM50","dev_sn":"sfsfsfsff","snd_src_num":1,"snd_src":[{"x":0,"y":0,"z":0}]}]}\r\n
获取音频参数预设
支持机型
AP08, CM20, CM50, CM50 Pro, AVBridge
指令
audio get preset\r\n
请求参数
参数
类型
是否必需
描述
preset_info
preset_info[]
true
无
preset_info[]
参数
类型
是否必需
描述
preset_type
string
true
无
preset_id
string
true
预设的唯一ID
preset_name
string
true
preset_type为官方预设时,name和id一致
请求示例
audio get preset\r\n
返回示例
audio get preset {"preset_info":[{"preset_type":"custom_preset","preset_name":"自定义1","preset_id":"OFQjdE"},{"preset_type":"official_preset","preset_name":"general_preset","preset_id":"general_preset"}]}\r\n
设置音频参数预设
支持机型
AP08, CM20, CM50, CM50 Pro, AVBridge
指令
audio set preset {"preset_name":"<value>"}\r\n
请求参数
参数
类型
是否必需
描述
preset_name
string
是
预设的唯一名字,中文需用utf8
请求示例
audio set preset {"preset_name":"preset1"}\r\n
返回示例
audio set preset {"preset_name":"preset1"}\r\n
获取音频静音状态
支持机型
AP08, CM20, CM50, CM50 Pro, CS10, CS10-D, AVBridge
指令
audio get mute\r\n
返回参数
参数
类型
数值范围
描述
status
string
["on", "off"]
静音状态
on:打开
off:关闭
请求示例
audio get mute \r\n
返回示例
audio get mute {"status":"on"} \r\n
设置音频静音状态
设置设备所有通道mute状态,并且和单独获取设置通道mute的接口状态不同步。
支持机型
AP08, CM20, CM50, CM50 Pro, CS10, CS10-D, AVBridge
指令
audio set mute {"status":"off"}\r\n
请求参数
参数
类型
数值范围
是否必需
描述
status
string
["on", "off"]
是
静音状态
on:打开
off:关闭
请求示例
audio set mute {"status":"off"}\r\n
返回示例
audio set mute {"status":"off"} \r\n
获取设备当前分割状态
支持机型
AP08
指令
division-room get config\r\n
返回参数
参数
类型
是否必需
描述
room_info
room_info[]
是
房间信息
room_info[]
参数
类型
数值范围
是否必需
描述
room_id
int[]
[1,3]
是
分割后每个房间包含的最小可分割的房间的id。
请求示例
division-room get config\r\n
返回示例
division-room get config {"room_info":[{"room_id":[1]},{"room_id":[2]},{"room_id":[3]}]}\r\n
设置设备当前分割状态
支持机型
AP08
指令
division-room set config\r\n
请求参数
参数
类型
是否必需
描述
room_info
room_info[]
是
房间信息
room_info[]
参数
类型
数值范围
是否必需
描述
room_id
int[]
[1,3]
是
分割后每个房间包含的最小可分割的房间的id。
请求示例
division set config {"room_info":[{"room_id":[1,2]},{"room_id":[3]}]}\r\n
返回示例
division set config {"room_info":[{"room_id":[1,2]},{"room_id":[3]}]}\r\n
获取硬件信息
支持机型
AP08
指令
system get hardware\r\n
请求参数
参数
类型
数值范围
是否必需
描述
hal_list
hal_list[]
无
是
硬件列表
hal_list[]
参数
类型
数值范围
是否必需
描述
type
string
["gpio"]
是
硬件类型
index
int
[0-8]
是
索引列表
mode
string
["input", "output"]
是
硬件模式
返回参数
参数
类型
数值范围
是否必需
描述
hal_list
hal_list[]
无
是
硬件列表
hal_list[]
参数
类型
数值范围
是否必需
描述
type
string
["gpio"]
是
硬件类型
mode
string
["input", "output"]
是
硬件模式
status
status[]
无
是
状态信息
index
int
[0-8]
是
索引列表
status
string
["low", "high"]
是
电平状态
status[]
参数
类型
数值范围
是否必需
描述
index
int
[0-8]
是
Index list
status
string
["low", "high"]
是
Level state
请求示例
system get hardware {"hal_list":[{"type":"gpio","mode":"input","index":[1,2]}]}\r\n
返回示例
system get hardware {"hal_list":[{"type":"gpio","mode":"input","status":[{"index":1,"status":"high"},{"index":2,"status":"low"}]}]}\r\n
获取通道音量
支持机型
AP08, CM20, CM50, CM50 Pro, AVBridge
指令
audio get channel volume\r\n
请求参数
参数
类型
是否必需
描述
arr_gain_info
string[]
是
通道名称数组,增益是一种物理量。该接口需要指定通道名称,若未提供通道名称,将会返回增益数值。
返回参数
参数
类型
是否必需
描述
arr_gain_info
arr_gain_info[]
是
无
arr_gain_info
参数
类型
数值范围
描述
name
string
无
通道名称
value
int
[0-100]
通道音量。如设置50,可能获取到的是51。
请求示例
audio get channel volume {"arr_gain_info":["Dante-Input-1","Dante-Input-2"]}\r\n
返回示例
audio get channel volume {"arr_gain_info":[{"name":"Dante-Input-1","value":51},{"name":"Dante-Input-2","value":60}]}\r\n
设置通道音量
支持机型
AP08, CM20, CM50, CM50 Pro, AVBridge
指令
audio set channel volume {"arr_gain_info":[{"name":"<value>","value":<value>,"mode":"<value>"}]}\r\n
请求参数
参数
类型
是否必需
arr_gain_info
arr_gain_info[]
是
arr_gain_info
参数
类型
数值范围
描述
name
string
无
通道名称
value
int
[0-100]
通道音量。如设置50,可能获取到的是51。
mode
string
["assign", "adjust"]
assign:将增益直接设定为指定数值(默认模式)。
adjust:依据设定数值,在当前增益数值基础上进行增减调整。
请求示例
audio set channel volume {"arr_gain_info":[{"name":"Dante-Input-1","value":10,"mode":"assign"},{"name":"Dante-Input-2","value":10,"mode":"adjust"}]}\r\n
返回示例
audio set channel volume {"arr_gain_info":[{"name":"Dante-Input-1","value":10,"mode":"assign"},{"name":"Dante-Input-2","value":10,"mode":"adjust"}]}\r\n
获取通道mute状态
支持机型
AP08, CM20, CM50, CM50 Pro, AVBridge
指令
audio get channel mute {"channel_mute":["<value>"]}\r\n
请求参数
参数
类型
是否必需
数值范围
描述
channel_mute
channel_mute[]
是
无
通道静音信息列表
返回参数
参数
类型
是否必需
数值范围
描述
channel_mute
channel_mute[]
是
无
通道静音信息列表
channel_mute[]
参数
类型
是否必需
数值范围
描述
name
string
是
无
Designer UI 上显示的通道名称
value
string
是
["off", "on"]
静音状态
请求示例
audio get channel mute {"channel_mute":["Dante-Input-1","Dante-Input-2"]}\r\n
返回示例
audio get channel mute {"channel_mute":[{"name":"Dante-Input-1","value":"on"},{"name":"Dante-Input-2","value":"off"}]}\r\n
如果未指定任何参数,将返回所有通道的静音状态。
设置通道mute状态
支持机型
AP08, CM20, CM50, CM50 Pro, AVBridge
指令
audio set channel mute {"channel_mute":[{"name":"<value>","value":<value>}]}\r\n
请求参数
参数
类型
是否必需
数值范围
描述
channel_mute
channel_mute[]
是
无
通道静音信息列表
channel_mute[]
参数
类型
是否必需
数值范围
描述
name
string
是
无
Designer UI 上显示的通道名称
value
string
是
["off", "on"]
静音状态
请求示例
audio set channel mute {"channel_mute":[{"name":"Pickup-Area-1","value":"on"},{"name":"Amplifier-Area-1","value":"off"}]}\r\n
返回示例
audio set channel mute {"channel_mute":[{"name":"Pickup-Area-1","value":"on"},{"name":"Amplifier-Area-1","value":"off"}]}\r\n
获取当前增益
支持机型
AP08, CM20, CM50, CM50 Pro, AVBridge
指令
audio get channel gain {"arr_gain_info":["<value>"]}\r\n
请求参数
参数
类型
是否必需
描述
arr_gain_info
string[]
是
通道增益信息列表
返回参数
参数
类型
是否必需
描述
arr_gain_info
arr_gain_info[]
是
通道增益信息列表
arr_gain_info[]
参数
类型
是否必需
数值范围
描述
name
string
是
无
Designer UI 上显示的通道名称
value
integer
是
[-60, 20]
增益值
请求示例
audio get channel gain {"arr_gain_info":["USB_IN-1","USB_IN-0"]}\r\n
返回示例
audio get channel gain {"arr_gain_info":[{"name":"USB-Input-1","value":10},{"name":"USB-Input-2","value":10}]}\r\n
如果未指定任何参数,将返回所有通道的增益值。
设置通道增益
支持机型
AP08, CM20, CM50, CM50 Pro, AVBridge
指令
audio set channel gain {"arr_gain_info":[{"name":"<value>","value":"<value>"}]}\r\n
请求参数
参数
类型
是否必需
描述
arr_gain_info
arr_gain_info[]
是
通道增益信息列表
arr_gain_info[]
参数
类型
是否必需
数值范围
描述
name
string
是
无
Designer UI 上显示的通道名称
value
integer
是
[-60, 20]
增益值
mode
string
否
["assign", "adjust"]
assign: 将增益直接设定为指定数值(默认模式)。
adjust: 根据设定数值,在当前增益数值的基础上进行增减调整。
请求示例
audio set channel gain {"arr_gain_info":[{"name":"Dante-Input-1","value":10,"mode":"adjust"},{"name":"Dante-Input-3","value":10,"mode":"assign"}]}\r\n
返回示例
audio set channel gain {"arr_gain_info":[{"name":"Dante-Input-1","value":10,"mode":"adjust"},{"name":"Dante-Input-3","value":10,"mode":"assign"}]}\r\n
获取设备加密状态
支持机型
AP08, CM20, CM50, CM50 Pro, CS10, CS10-D, AVBridge
指令
system get encryption-status\r\n
请求示例
system get encryption-status\r\n
返回示例
system get encryption-status {"status":"inactive"}\r\n
获取声源定位灵敏度
支持机型
CM50, CM50 Pro
指令
audio get sound-locate-sensitivity\r\n
返回参数
参数
类型
数值范围
描述
level
string
["low", "middle", "high"]
low: 声源定位灵敏度较低。
middle: 声源定位灵敏度中等。
high: 声源定位灵敏度较高。
请求示例
audio get sound-locate-sensitivity\r\n
返回示例
audio get sound-locate-sensitivity {"level":"high"}\r\n
设置声源定位灵敏度
支持机型
CM50, CM50 Pro
指令
audio set sound-locate-sensitivity {"level":"<value>"}\r\n
请求参数
参数
类型
数值范围
是否必需
描述
level
string
["low", "middle", "high"]
是
low: 声源定位灵敏度低。
middle: 声源定位灵敏度中等。
high: 声源定位灵敏度高。
请求示例
audio set sound-locate-sensitivity {"level":"high"}\r\n
返回示例
audio set sound-locate-sensitivity {"level":"high"}\r\n
获取通道信息
支持机型
AP08, CM20, CM50, CM50 Pro, AVBridge
指令
audio get channel info\r\n
返回参数
参数
类型
描述
channel_name
channel_name[]
无
channel_name[]
参数
类型
描述
name
string
在Designer界面中显示的通道名称。
usage
string
算法节点名称。
请求示例
audio get channel info\r\n
返回示例
audio get channel info {"channel_name":[{"name":"AI-NR-Mix-Out-2","usage":"TX_AI-1"},{"name":"AI-NR-Mix-Out-1","usage":"TX_AI-0"}]}\r\n
获取降噪等级
支持机型
AP08, CM20, CM50, CM50 Pro
指令
audio get noise-reduction\r\n
请求参数
参数
类型
是否必需
描述
noise_reduction
noise_reduction[]
否
无
noise_reduction[]
参数
类型
数值范围
是否必需
描述
name
string
无
是
在Designer界面中显示的通道名称。
mode
string
["traditional", "ai"]
是
traditional: 传统模式。
ai: 人工智能模式。
仅CM50和CM20支持AI降噪功能。
返回参数
参数
类型
描述
noise_reduction
noise_reduction[]
无
noise_reduction[]
参数
类型
数值范围
描述
name
string
无
在Designer界面中显示的通道名称。
mode
string
["traditional", "ai"]
traditional: 传统模式。
ai: 人工智能模式。
仅CM50和CM20支持AI降噪功能。
level
string
["low", "middle", "high"]
low: 低降噪等级。
middle: 中等降噪等级。
high: 高降噪等级。
请求示例
audio get noise-reduction {"noise_reduction":[{"mode":"traditional","name":"AEC-Dante-Input-4"}]}\r\n
返回示例
audio get noise-reduction {"noise_reduction":[{"mode":"traditional","name":"AEC-Dante-Input-4","level":"high"}]}\r\n
如果未指定参数,系统将返回所有声道的降噪等级信息。
设置降噪等级
支持机型
AP08, CM20, CM50, CM50 Pro
指令
audio set noise-reduction {"noise_reduction":[{"name":"<value>","mode":"<value>","level":"<value>"}]}\r\n
请求参数
参数
类型
是否必需
描述
noise_reduction
noise_reduction[]
否
无
noise_reduction[]
参数
类型
数值范围
描述
name
string
无
在Designer界面中显示的通道名称。
mode
string
["traditional", "ai"]
traditional: 传统模式。
ai: 人工智能模式。
仅CM50和CM20支持AI降噪功能。
level
string
["low", "middle", "high"]
low: 低降噪等级。
middle: 中等降噪等级。
high: 高降噪等级。
请求示例 1
audio set noise-reduction {"noise_reduction":[{"level":"high","mode":"traditional","name":"AEC-Dante-Input-1"},{"level":"low","mode":"traditional","name":"AEC-Dante-Input-2"},{"level":"low","mode":"traditional","name":"AEC-Dante-Input-3"},{"level":"middle","mode":"traditional","name":"AEC-Dante-Input-4"},{"level":"middle","mode":"traditional","name":"AEC-Dante-Input-5"},{"level":"middle","mode":"traditional","name":"AEC-Dante-Input-6"},{"level":"middle","mode":"traditional","name":"AEC-Dante-Input-7"},{"level":"middle","mode":"traditional","name":"AEC-Dante-Input-8"}]}\r\n
返回示例 1
audio set noise-reduction {"noise_reduction":[{"level":"high","mode":"traditional","name":"AEC-Dante-Input-1"},{"level":"low","mode":"traditional","name":"AEC-Dante-Input-2"},{"level":"low","mode":"traditional","name":"AEC-Dante-Input-3"},{"level":"middle","mode":"traditional","name":"AEC-Dante-Input-4"},{"level":"middle","mode":"traditional","name":"AEC-Dante-Input-5"},{"level":"middle","mode":"traditional","name":"AEC-Dante-Input-6"},{"level":"middle","mode":"traditional","name":"AEC-Dante-Input-7"},{"level":"middle","mode":"traditional","name":"AEC-Dante-Input-8"}]}\r\n
请求示例 2
audio set noise-reduction {"noise_reduction":[{"level":"middle","mode":"traditional","name":"Mic-AEC-Mix-Out"}]}\r\n
返回示例 2
audio set noise-reduction {"noise_reduction":[{"level":"middle","mode":"traditional","name":"Mic-AEC-Mix-Out"}]}\r\n
获取通话状态
支持机型
AP08, AVBridge
指令
call get state\r\n
返回参数
参数
类型
数值范围
描述
call-status
string
["incoming", "talk", "idle"]
incoming: 来电
talk: 通话中
idle: 空闲中
来电状态和通话状态均视作通话中状态。
app-info
app_info[]
无
当通话处于未接通状态时,所有相关的应用信息字段均返回空值("")。
AP08和AVBridge不支持应用信息,相关内容会返回为空。
app_info[]
参数
类型
描述
id
string
App id名
name
string
App 名称
version
string
App 版本号
请求示例
call get state\r\n
返回示例
call get state {"call-status":"idle","app-info":{"id":"","name":"","version":""}}\r\n
获取降噪旁路状态
支持机型
AP08
指令
audio get noise-reduction-bypass\r\n
请求参数
参数
类型
是否必需
描述
noise_bypass
noise_bypass[]
是
无
noise_bypass[]
参数
类型
数值范围
是否必需
描述
name
string
无
是
在Designer界面中显示的通道名称。
mode
string
["traditional", "ai"]
是
traditional: 传统模式。
ai: 人工智能模式。
返回参数
参数
类型
是否必需
描述
noise_bypass
noise_bypass[]
是
无
noise_bypass[]
参数
类型
数值范围
描述
bypass
string
["on", "off"]
on: 启用降噪旁路功能。
off: 禁用降噪旁路功能。
mode
string
["traditional", "ai"]
traditional: 传统模式。
ai: 人工智能模式。
name
string
无
在Designer界面中显示的通道名称。
请求示例
audio get noise-reduction-bypass {"noise_bypass":[{"name":"<value>","mode":"<value>"}]}\r\n
返回示例
audio get noise-reduction-bypass {"noise_bypass":[{"bypass":"on","mode":"ai","name":"AI-NR-Mix-Out-1"},{"bypass":"on","mode":"ai","name":"AI-NR-Mix-Out-2"}]}\r\n
设置降噪旁路状态
支持机型
AP08
指令
audio set noise-reduction-bypass\r\n
请求参数
参数
类型
是否必需
描述
noise_bypass
noise_bypass[]
是
无
noise_bypass[]
参数
类型
数值范围
描述
bypass
string
["on", "off"]
on: 启用降噪旁路功能。
off: 禁用降噪旁路功能。
mode
string
["ai"]
ai: 人工智能模式。
name
string
无
在Designer界面中显示的通道名称。
请求示例
audio set noise-reduction-bypass {"noise_bypass":[{"bypass":"off","mode":"ai","name":"AI-NR-Mix-Out-1"},{"bypass":"off","mode":"ai","name":"AI-NR-Mix-Out-2"}]}\r\n
返回示例
audio set noise-reduction-bypass {"noise_bypass":[{"bypass":"off","mode":"ai","name":"AI-NR-Mix-Out-1"},{"bypass":"off","mode":"ai","name":"AI-NR-Mix-Out-2"}]}\r\n