声音类指令¶

class mini.apis.api_sound.TTSControlType(value)[源代码]¶

基类：Enum

TTS控制类型

START : 开始播放tts

STOP : 停止播放tts

START = 1¶

STOP = 0¶

class mini.apis.api_sound.StartPlayTTS(is_serial: bool = True, text: str | None = None)[源代码]¶

基类：BaseApi

开始播放TTS api

机器人播放合成的TTS语音

参数:

is_serial (bool) – 是否等待回复，默认True
text (str) – 播放的文本，不能为空或者None

#ControlTTSResponse.isSuccess : 是否成功

#ControlTTSResponse.resultCode : 返回码

async execute()[源代码]¶

执行开始播放TTS指令

返回:: ControlTTSResponse

class mini.apis.api_sound.StopPlayTTS(is_serial: bool = True)[源代码]¶

基类：BaseApi

停止播放TTS api

机器人停止播放TTS语音

参数:: is_serial (bool) – 是否等待回复，默认True

#ControlTTSResponse.isSuccess : 是否成功

#ControlTTSResponse.resultCode : 返回码

async execute()[源代码]¶

执行停止播放TTS指令

返回:: ControlTTSResponse

class mini.apis.api_sound.AudioStorageType(value)[源代码]¶

基类：Enum

音频存储类型

NET_PUBLIC : 公网

PRESET_LOCAL : 机器人本地内置

CUSTOMIZE_LOCAL : 机器人本地自定义

NET_PUBLIC = 2¶

PRESET_LOCAL = 3¶

CUSTOMIZE_LOCAL = 4¶

class mini.apis.api_sound.PlayAudio(is_serial: bool = True, url: str | None = None, storage_type: AudioStorageType = AudioStorageType.NET_PUBLIC, volume: float = 1.0)[源代码]¶

基类：BaseApi

播放音频api

机器人播放指定的音频, 支持mp3,wav,amr等

参数:

is_serial (bool) – 是否等待回复，默认True
url (str) – 音频地址，当storage_type为NET_PUBLIC，url为音频文件网址；当storage_type为PRESET_LOCAL/CUSTOMIZE_LOCAL时， url为本地音频名称（本地音频名称可通过FetchAudioList接口获取）
storage_type (AudioStorageType) – 音频存储类型，默认NET_PUBLIC，公网
volume (float) – 音量大小，范围[0.0,1.0]，默认1.0

#PlayAudioResponse.isSuccess : 是否成功

#PlayAudioResponse.resultCode : 返回码

async execute()[源代码]¶

执行播放音频指令

返回:: PlayAudioResponse

class mini.apis.api_sound.StopAllAudio(is_serial: bool = True)[源代码]¶

基类：BaseApi

停止所有音频api

机器人停止所有正在播放的音频

参数:: is_serial (bool) – 是否等待回复，默认True

#StopAudioResponse.isSuccess : 是否成功

#StopAudioResponse.resultCode : 返回码

async execute()[源代码]¶

执行停止所有音频指令

返回:: StopAudioResponse

class mini.apis.api_sound.AudioSearchType(value)[源代码]¶

基类：Enum

音频查询类型

INNER(内置) : 机器人内置的不可修改的音效,

CUSTOM(自定义) : 放置在sdcard/customize/music目录下可被开发者修改的音效

INNER = 0¶

CUSTOM = 1¶

class mini.apis.api_sound.FetchAudioList(is_serial: bool = True, search_type: AudioSearchType = AudioSearchType.INNER)[源代码]¶

基类：BaseApi

获取机器人的音频列表api

获取存储在机器人rom或者sdcard中的音频列表

参数:

is_serial (bool) – 是否等待回复，默认True
search_type (AudioSearchType) – 查询类型，默认INNER，机器人内置

#GetAudioListResponse.audio ([Audio]) : 音效列表

#Audio.name : 音效名

#Audio.suffix : 音效后缀

#GetAudioListResponse.isSuccess : 是否成功

#GetAudioListResponse.resultCode : 返回码

async execute()[源代码]¶

执行获取音频列表指令

返回:: GetAudioListResponse

class mini.apis.api_sound.ChangeRobotVolume(is_serial: bool = True, volume: float = 0.5)[源代码]¶

基类：BaseApi

设置机器人音量api

调整机器人音量

参数:

is_serial (bool) – 是否等待回复，默认True
volume (float) – 音量，范围[0.0,1.0]，默认0.5

#ChangeRobotVolumeResponse.isSuccess : 是否成功

#ChangeRobotVolumeResponse.resultCode : 返回码

async execute()[源代码]¶

发送设置机器人音量指令

返回:: ChangeRobotVolumeResponse

class mini.apis.api_sound.RobotAudioRecordControlType(value)[源代码]¶

基类：Enum

机器人录音控制类型

START_RECORD = 0¶

STOP_RECORD = 1¶

START_PLAY = 2¶

STOP_PLAY = 3¶

PAUSE_PLAY = 4¶

CONTINUE_PLAY = 5¶

RENAME_FILE = 6¶

class mini.apis.api_sound.ControlRobotAudioRecord(is_serial: bool = True, control_type: RobotAudioRecordControlType = RobotAudioRecordControlType.START_RECORD, time_limit: int = 60000, file_name: str | None = None, new_file_name: str | None = None)[源代码]¶

基类：BaseApi

控制机器人录音/播放api

参数:

is_serial (bool) – 是否等待回复，默认True
control_type (RobotAudioRecordControlType) – 控制类型，默认START_RECORD，开始录音
time_limit (int) – 录音时长，单位ms，默认60000ms，即60s
file_name (str) – 录音文件存储名称
new_file_name (str) – 重命名录音文件的名称

#ControlRobotRecordResponse.isSuccess : 是否成功

#ControlRobotRecordResponse.resultCode : 返回码

#ControlRobotRecordResponse.id : 生成的录音文件名

async execute()[源代码]¶

发送控制录音指令

返回:: ControlRobotRecordResponse

class mini.apis.api_sound.RobotAudioStartRecord(is_serial: bool = True, time_limit: int = 60000)[源代码]¶

基类：ControlRobotAudioRecord

机器人开始录音api

控制机器人开始录音

参数:

is_serial (bool) – 是否等待回复，默认True
time_limit (int) – 录音时长，单位ms，默认60000ms，即60s

#ControlRobotRecordResponse.isSuccess : 是否成功

#ControlRobotRecordResponse.resultCode : 返回码

#ControlRobotRecordResponse.id : 生成的录音文件名

class mini.apis.api_sound.RobotAudioStopRecord(is_serial: bool = True)[源代码]¶

基类：ControlRobotAudioRecord

机器人停止录音api

控制机器人停止录音

参数:: is_serial (bool) – 是否等待回复，默认True

#ControlRobotRecordResponse.isSuccess : 是否成功

#ControlRobotRecordResponse.resultCode : 返回码

#ControlRobotRecordResponse.id : 生成的录音文件名

class mini.apis.api_sound.RobotAudioStartPlay(is_serial: bool = True, file_name: str | None = None)[源代码]¶

基类：ControlRobotAudioRecord

机器人开始播放录音api

控制机器人开始播放录音

参数:

is_serial (bool) – 是否等待回复，默认True
file_name (str) – 录音文件名，不可为空或None

#ControlRobotRecordResponse.isSuccess : 是否成功

#ControlRobotRecordResponse.resultCode : 返回码

#ControlRobotRecordResponse.id : 生成的录音文件名

class mini.apis.api_sound.RobotAudioStopPlay(is_serial: bool = True)[源代码]¶

基类：ControlRobotAudioRecord

机器人停止播放录音api

控制机器人停止播放录音

参数:: is_serial (bool) – 是否等待回复，默认True

#ControlRobotRecordResponse.isSuccess : 是否成功

#ControlRobotRecordResponse.resultCode : 返回码

#ControlRobotRecordResponse.id : 生成的录音文件名

class mini.apis.api_sound.RobotAudioPausePlay(is_serial: bool = True)[源代码]¶

基类：ControlRobotAudioRecord

机器人暂停播放录音api

控制机器人暂停播放录音

参数:: is_serial (bool) – 是否等待回复，默认True

#ControlRobotRecordResponse.isSuccess : 是否成功

#ControlRobotRecordResponse.resultCode : 返回码

#ControlRobotRecordResponse.id : 生成的录音文件名

class mini.apis.api_sound.RobotAudioContinuePlay(is_serial: bool = True)[源代码]¶

基类：ControlRobotAudioRecord

机器人继续播放录音api

控制机器人继续播放录音

参数:: is_serial (bool) – 是否等待回复，默认True

#ControlRobotRecordResponse.isSuccess : 是否成功

#ControlRobotRecordResponse.resultCode : 返回码

#ControlRobotRecordResponse.id : 生成的录音文件名

class mini.apis.api_sound.RobotAudioRenameFile(is_serial: bool = True, file_name: str | None = None, new_file_name: str | None = None)[源代码]¶

基类：ControlRobotAudioRecord

机器人重命名录音文件api

控制机器人重命名录音文件

参数:

is_serial (bool) – 是否等待回复，默认True
file_name (str) – 录音文件名，不可为空或None

#ControlRobotRecordResponse.isSuccess : 是否成功

#ControlRobotRecordResponse.resultCode : 返回码

#ControlRobotRecordResponse.id : 生成的录音文件名