alienwalker 3 лет назад
Родитель
Сommit
91c47dc3ef

+ 2 - 0
components/camera/luat_lib_camera.c

@@ -203,6 +203,8 @@ static int l_camera_init(lua_State *L){
 @return nil 无返回值
 @usage
 camera.on(0, "scanned", function(id, str)
+--id int camera id
+--str 多种类型 false 摄像头没有正常工作,true 拍照模式下拍照成功并保存完成, int 原始数据模式下本次返回的数据大小, string 扫码模式下扫码成功后的解码值
     print(id, str)
 end)
 */

+ 0 - 1
components/multimedia/luat_lib_multimedia_audio.c

@@ -294,7 +294,6 @@ static int l_audio_play_get_last_error(lua_State *L) {
 @int 在DAC启动后,延迟多长时间打开PA,单位1ms
 @int 外部dac电源控制IO,如果不填,则表示使用平台默认IO,比如Air780E使用DACEN脚,air105则不启用
 @int 外部dac打开时,电源控制IO的电平,默认拉高
-@return
 @usage
 audio.config(0, pin.PC0, 1)	--PA控制脚是PC0,高电平打开,air105用这个配置就可以用了
 audio.config(0, 25, 1, 6, 200)	--PA控制脚是GPIO25,高电平打开,Air780E云喇叭板用这个配置就可以用了

+ 11 - 11
components/multimedia/luat_lib_multimedia_codec.c

@@ -17,9 +17,9 @@
 
 /**
 创建编解码用的codec
-@api codec.create(codec.MP3)
+@api codec.create(codec.MP3, isDecoder)
 @int 多媒体类型,目前支持decode.MP3
-@boolean 是否是编码器,默认true,是解码器
+@boolean 是否是解码器,true解码器,false编码器,默认true,是解码器
 @return userdata 成功返回一个数据结构,否则返回nil
 @usage
 -- 创建decoder
@@ -61,13 +61,12 @@ decoder从文件中解析出音频信息
 @api codec.info(decoder, file_path)
 @coder 解码用的decoder
 @string 文件路径
-@return
-@boolean 是否成功解析
-@int 音频格式
-@int 声音通道数
-@int 采样频率
-@int 采样位数
-@boolean 是否有符号
+@return boolean 是否成功解析
+@return int 音频格式
+@return int 声音通道数
+@return int 采样频率
+@return int 采样位数
+@return boolean 是否有符号
 @usage
 local result, audio_format, num_channels, sample_rate, bits_per_sample, is_signed= codec.get_audio_info(coder, "xxx")
  */
@@ -189,7 +188,7 @@ static int l_codec_get_audio_info(lua_State *L) {
 }
 
 /**
-decoder从文件数据中解析出音频数据
+decoder从文件中解析出原始音频数据,比如从MP3文件里解析出PCM数据,这里的文件路径已经在codec.info传入,不需要再次传入
 @api codec.data(decoder, out_buff)
 @coder 解码用的decoder
 @zbuff 存放输出数据的zbuff,空间必须不少于16KB
@@ -318,7 +317,8 @@ static int l_codec_gc(lua_State *L)
 /**
 释放编解码用的coder
 @api codec.release(coder)
-@return
+@coder codec.create创建的编解码用的coder
+@usage
 codec.release(coder)
  */
 static int l_codec_release(lua_State *L) {

+ 1 - 1
components/network/errdump/luat_lib_errdump.c

@@ -455,7 +455,7 @@ void luat_errdump_record_init(uint8_t enable, uint32_t upload_period)
 }
 
 /*
-读取异常日志,这里可以读取系统和用户的,主要用于用户发送给自己的服务器,如果配置了周期上传,请不要使用!!!
+手动读取异常日志,主要用于用户将日志发送给自己的服务器而不是IOT平台,如果在errDump.config配置了周期上传,则不能使用本函数
 @api    errDump.dump(zbuff, type, isDelete)
 @zbuff 日志信息缓存,如果为nil就不会读出,一般当
 @int 日志类型,目前只有errDump.TYPE_SYS和errDump.TYPE_USR