diff --git "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/audio.Audio.md" "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/audio.Audio.md" index 2090f01afb50f3d4eba2be57a12afdca31daf7e9..1338a9234b96641a842ad9155ab98fe577a40225 100644 --- "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/audio.Audio.md" +++ "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/audio.Audio.md" @@ -13,10 +13,10 @@ from machine import Pin import utime def audio_cb(event): - if event == 0: - print('audio-play start.') - elif event == 7: - print('audio-play finish.') + if event == 0: + print('audio-play start.') + elif event == 7: + print('audio-play finish.') aud = audio.Audio(0) aud.setCallback(audio_cb) @@ -61,7 +61,7 @@ class audio.Audio(device) **参数描述:** -- `device` - 输出通道,int类型,`0`表示听筒,`1`表示耳机,`2`表示喇叭。具体模块所支持通道详见下表。 +- `device` - 输出通道,int类型,0表示听筒,1表示耳机,2表示喇叭。具体模块所支持通道详见下表。 **模块输出通道对应表:** @@ -161,7 +161,7 @@ Audio.setCallback(cb) 该方法用于注册用户的回调函数,用于通知用户音频文件播放状态。 -> **注意**:该回调函数中不要进行耗时以及阻塞性的操作,建议只进行简单、耗时短的操作。 +> 该回调函数中不要进行耗时以及阻塞性的操作,建议只进行简单、耗时短的操作。 **参数描述:** @@ -267,7 +267,7 @@ Audio.aud_tone_play(tone, time) 该方法用于播放tone音,播放一段时间(time)后自动停止播放。 -> **注意**:EC600N/EC800N系列模组调用该接口为立即返回,EC600U/EC200U系列模组调用该接口为阻塞等待。 +> EC600N/EC800N系列模组调用该接口为立即返回,EC600U/EC200U系列模组调用该接口为阻塞等待。 **参数描述:** diff --git "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/audio.Record.md" "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/audio.Record.md" index 4b9eb5a521128e7d3086b9bf8cfd0becfb2de6ef..c0f3c784d6b71feedb975ac49b1878b196727b5f 100644 --- "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/audio.Record.md" +++ "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/audio.Record.md" @@ -62,7 +62,7 @@ class audio.Record(device) 创建Record对象。 -> 注意:如果传参,请与audio.Audio(device)的参数保持一致。 +> 如果传参,请与audio.Audio(device)的参数保持一致。 **参数描述:** @@ -198,7 +198,7 @@ Record.getSize(file_name) 若获取成功,返回文件大小 (EC600N系列、EC800N系列、EC800M系列、EC600M系列、EG915N不返回文件头),单位字节。 -> 注意:wav格式时,此值会比返回callback返回值大44 bytes(44 bytes为文件头);amr格式时,此值会比返回callback返回值大6 bytes(6 bytes为文件头)。 +> wav格式时,此值会比返回callback返回值大44 bytes(44 bytes为文件头);amr格式时,此值会比返回callback返回值大6 bytes(6 bytes为文件头)。 失败返回值如下: @@ -273,14 +273,18 @@ Record.end_callback(cb) - `cb` - 录音结束回调函数,function类型,函数原型: ``` - cb(file_path, audio_len, audio_state) + cb(audio_msg) ``` **回调函数参数描述**: - - `file_path` - 文件路径,string类型。 - - `audio_len` - 录音长度,int类型。 - - `audio_state` - 录音状态,int类型,点此查看回调函数参数audio_state说明表。 + - `audio_msg` - 录音信息,list类型,其中元素如下: + + ​ `audio_msg[0]`:`file_path` ,文件路径,string类型。 + + ​ `audio_msg[1]`:`audio_len` , 录音长度,int类型。 + + ​ `audio_msg[2]`:`audio_state` ,录音状态,int类型,点此查看回调函数参数audio_state说明表。 **返回值描述:** @@ -306,7 +310,7 @@ Record.gain(code_gain,dsp_gain) **参数描述:** -- `code_gain` - 上行编解码器增益,int型,`0~4`。 +- `code_gain` - 上行编解码器增益,int型,[0,4]。 - `dsp_gain` - 上行数字增益,int型,`-36~12` 。 **返回值描述:** @@ -340,7 +344,7 @@ Record.amrEncDtx_enable(on_off) Record.stream_start(format, samplerate, time) ``` -该方法用于开始录音音频流。注意:录制音频流的同时,应及时读取音频流。目前是采用循环buf,不及时读取,会导致数据丢失。 +该方法用于开始录音音频流。注意:录制音频流的同时,应及时读取音频流。目前是采用循环buf,不及时读取,会导致数据丢失。 > 目前仅EC200U/EC600U系列模组支持该功能。 @@ -366,7 +370,7 @@ Record.stream_read(read_buf, len) **参数描述** -- `read_buf` - 录音流buf,buf型 。 +- `read_buf` - 录音流buf,bytearray型 。 - `len` - 读取的长度,int类型。 **返回值描述:** diff --git "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/audio.md" "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/audio.md" index 481cf9c99448c3e6ab1c6d713688e9e4e0b400ca..b2d46e4613d3794217b153b83c7ca3fe3fb53975 100644 --- "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/audio.md" +++ "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/audio.md" @@ -1,6 +1,6 @@ # audio - 音频播放 -模块功能:音频播放,支持TTS、mp3以及AMR文件播放、录音功能。 +该模块包含各种音频功能,支持音频播放、TTS文本到语音播放、录音等功能。 ## Classes