xt_audio_dev（音频设备）

音频设备抽象层（普通用户接口） 更多...

结构体
struct	xt_audio_dev_cb_info
	音频设备回调信息结构体 更多...
struct	xt_audio_dev_info
	音频设备操作信息结构体 更多...
struct	xt_audio_dev_config
	音频设备配置结构体 更多...

宏定义
#define	xt_audio_dev_stop(_hdl)
#define	xt_audio_dev_read_stop(_hdl)
#define	xt_audio_dev_write(_hdl, _data, _size, _level)
#define	xt_audio_dev_read(_hdl, _data, _size, _level)

类型定义
typedef void(*	xt_audio_dev_evt_cb_t) (xt_audio_t hdl, enum xt_audio_dev_evt evt, struct xt_audio_dev_cb_info *info)
	音频设备事件回调函数类型

枚举
enum	xt_audio_dev_evt {   XT_AUDIO_DEV_EVT_NO_ERR , XT_AUDIO_DEV_EVT_WRITE_BATCH , XT_AUDIO_DEV_EVT_WRITE_ERROR , XT_AUDIO_DEV_EVT_WRITE_UNDERRUN ,   XT_AUDIO_DEV_EVT_READ_BATCH , XT_AUDIO_DEV_EVT_READ_READY , XT_AUDIO_DEV_EVT_READ_ERROR }
	音频设备事件枚举 更多...

函数
xt_err_t	xt_audio_dev_setup (struct xt_audio_dev_config *cfg, xt_audio_t *hdl)
	初始化音频设备
xt_err_t	xt_audio_dev_close (xt_audio_t hdl)
	关闭音频设备
xt_err_t	xt_audio_dev_stop_ext (xt_audio_t hdl, xt_audio_mode_t mode)
	停止音频设备指定方向的传输
int	xt_audio_dev_write_ext (xt_audio_t hdl, uint8_t *data, uint32_t size, struct xt_audio_dev_info *info)
	向音频设备写入数据（扩展版本）
int	xt_audio_dev_read_ext (xt_audio_t hdl, uint8_t *data, uint32_t size, struct xt_audio_dev_info *info)
	从音频设备读取数据（扩展版本）
int	xt_audio_dev_read_start_ext (xt_audio_t hdl, struct xt_audio_dev_info *info)
	启动音频设备读取（扩展版本）
xt_err_t	xt_audio_dev_get_format (xt_audio_t hdl, struct xt_audio_format *fmt)
	获取音频设备当前格式
uint16_t	xt_audio_dev_get_frame_interval (xt_audio_t hdl)
	获取帧间隔时间
xt_err_t	xt_audio_dev_sleep (xt_audio_t hdl)
	音频设备进入休眠
xt_err_t	xt_audio_dev_resume (xt_audio_t hdl)
	音频设备从休眠恢复
xt_err_t	xt_audio_dev_register_drv (struct xt_audio_dev_drv *drv)
	注册音频设备驱动
struct xt_audio_dev_drv *	xt_audio_dev_get_drv (const char *name)
	按名称获取已注册的音频驱动

详细描述

音频设备抽象层（普通用户接口）

宏定义说明

xt_audio_dev_read

#define xt_audio_dev_read	(		_hdl,
			_data,
			_size,
			_level )

值:

xt_audio_dev_read_ext(_hdl, _data, _size, &((struct xt_audio_dev_info){.level = _level}))

在文件 xt_audio_dev.h 第 156 行定义.

xt_audio_dev_read_stop

#define xt_audio_dev_read_stop

(

_hdl

)

值:

xt_audio_dev_stop_ext(_hdl, XT_AUDIO_MODE_READ)

在文件 xt_audio_dev.h 第 120 行定义.

xt_audio_dev_stop

#define xt_audio_dev_stop

(

_hdl

)

值:

xt_audio_dev_stop_ext(_hdl, (xt_audio_mode_t)-1)

在文件 xt_audio_dev.h 第 119 行定义.

xt_audio_dev_write

#define xt_audio_dev_write	(		_hdl,
			_data,
			_size,
			_level )

值:

xt_audio_dev_write_ext(_hdl, _data, _size, &((struct xt_audio_dev_info){.level = _level}))

在文件 xt_audio_dev.h 第 133 行定义.

类型定义说明

xt_audio_dev_evt_cb_t

typedef void(* xt_audio_dev_evt_cb_t) (xt_audio_t hdl, enum xt_audio_dev_evt evt, struct xt_audio_dev_cb_info *info)

音频设备事件回调函数类型

参数

hdl	音频设备句柄
evt	事件类型，见 xt_audio_dev_evt
info	回调信息，见 xt_audio_dev_cb_info

在文件 xt_audio_dev.h 第 63 行定义.

枚举类型说明

xt_audio_dev_evt

enum xt_audio_dev_evt

音频设备事件枚举

枚举值
XT_AUDIO_DEV_EVT_NO_ERR	无错误
XT_AUDIO_DEV_EVT_WRITE_BATCH	写入（单次）完成
XT_AUDIO_DEV_EVT_WRITE_ERROR	写入错误
XT_AUDIO_DEV_EVT_WRITE_UNDERRUN	写入下溢
XT_AUDIO_DEV_EVT_READ_BATCH	读取（单次）完成
XT_AUDIO_DEV_EVT_READ_READY	读取就绪
XT_AUDIO_DEV_EVT_READ_ERROR	读取错误

在文件 xt_audio_dev.h 第 37 行定义.

函数说明

xt_audio_dev_close()

xt_err_t xt_audio_dev_close

(

xt_audio_t

hdl

)

关闭音频设备

参数

hdl

设备句柄

返回

xt_err_t XT_EOK 成功，其他失败

xt_audio_dev_get_drv()

struct xt_audio_dev_drv * xt_audio_dev_get_drv

(

const char *

name

)

按名称获取已注册的音频驱动

参数

name

驱动名称

返回

struct xt_audio_dev_drv* 驱动描述符指针，未找到返回 NULL

xt_audio_dev_get_format()

xt_err_t xt_audio_dev_get_format	(	xt_audio_t	hdl,
		struct xt_audio_format *	fmt )

获取音频设备当前格式

参数

hdl	设备句柄
fmt	输出格式信息，见 xt_audio_format

返回

xt_err_t XT_EOK 成功，其他失败

xt_audio_dev_get_frame_interval()

uint16_t xt_audio_dev_get_frame_interval

(

xt_audio_t

hdl

)

获取帧间隔时间

参数

hdl

设备句柄

返回

uint16_t 帧间隔（单位：ms）

xt_audio_dev_read_ext()

int xt_audio_dev_read_ext	(	xt_audio_t	hdl,
		uint8_t *	data,
		uint32_t	size,
		struct xt_audio_dev_info *	info )

从音频设备读取数据（扩展版本）

参数

hdl	设备句柄
data	数据缓冲区
size	缓冲区大小（字节）
info	操作信息，见 xt_audio_dev_info

返回

int 实际读取字节数，负数为错误码

xt_audio_dev_read_start_ext()

int xt_audio_dev_read_start_ext	(	xt_audio_t	hdl,
		struct xt_audio_dev_info *	info )

启动音频设备读取（扩展版本）

参数

hdl	设备句柄
info	操作信息，见 xt_audio_dev_info

返回

int 0 成功，负数为错误码

xt_audio_dev_register_drv()

xt_err_t xt_audio_dev_register_drv

(

struct xt_audio_dev_drv *

drv

)

注册音频设备驱动

参数

drv	驱动描述符，见 xt_audio_dev_drv（音频设备驱动）

返回

xt_err_t XT_EOK 成功，其他失败

xt_audio_dev_resume()

xt_err_t xt_audio_dev_resume

(

xt_audio_t

hdl

)

音频设备从休眠恢复

参数

hdl

设备句柄

返回

xt_err_t XT_EOK 成功，其他失败

xt_audio_dev_setup()

xt_err_t xt_audio_dev_setup	(	struct xt_audio_dev_config *	cfg,
		xt_audio_t *	hdl )

初始化音频设备

参数

cfg	设备配置，见 xt_audio_dev_config
hdl	输出设备句柄

返回

xt_err_t XT_EOK 成功，其他失败

xt_audio_dev_sleep()

xt_err_t xt_audio_dev_sleep

(

xt_audio_t

hdl

)

音频设备进入休眠

参数

hdl

设备句柄

返回

xt_err_t XT_EOK 成功，其他失败

xt_audio_dev_stop_ext()

xt_err_t xt_audio_dev_stop_ext	(	xt_audio_t	hdl,
		xt_audio_mode_t	mode )

停止音频设备指定方向的传输

参数

hdl	设备句柄
mode	要停止的方向，(xt_audio_mode_t)-1 表示停止全部

返回

xt_err_t XT_EOK 成功，其他失败

xt_audio_dev_write_ext()

int xt_audio_dev_write_ext	(	xt_audio_t	hdl,
		uint8_t *	data,
		uint32_t	size,
		struct xt_audio_dev_info *	info )

向音频设备写入数据（扩展版本）

参数

hdl	设备句柄
data	音频数据
size	数据大小（字节）
info	操作信息（可设置音量等参数），见 xt_audio_dev_info

返回

int 0 成功，负数为错误码