用于播放命令词表格中与命令词关联的播报音，包含通过命令词表格中的命令词ID、语义ID等关联的播报音更多...

结构体
struct	prompt_play_info_st
	提示音信息结构体。在调用"prompt_play_by_multi_cmd_id"接口时需要此类型,用于指定要播放的提示音。更多...

宏定义
#define	MAX_COMBINATION_COUNT 16
	一个组合播报支持的最大音频文件数量。更多...

类型定义
typedef void(*	play_done_callback_t) (cmd_handle_t cmd_handle)
	定义提示音播报回调函数的指针类型。更多...

typedef struct prompt_play_info_st	prompt_play_info_t
	提示音信息结构体。在调用"prompt_play_by_multi_cmd_id"接口时需要此类型,用于指定要播放的提示音。更多...

函数
uint32_t	prompt_play_by_cmd_handle (cmd_handle_t cmd_handle, int select_index, play_done_callback_t play_done_callback, bool preemptive)
	通过命令词句柄开始播放指定的命令词对应的提示音。此函数为异步调用函数，也就是此函数会在启动播放后立即返回，不会等到播放结束才返回。\ 在播放结束时会通过调用play_done_callback所指定的回调函数来通知播放结束事件。更多...

uint32_t	prompt_play_by_cmd_id (uint16_t cmd_id, int select_index, play_done_callback_t play_done_callback, bool preemptive)
	通过命令词ID开始播放指定的命令词对应的提示音。此函数为异步调用函数，也就是此函数会在启动播放后立即返回，不会等到播放结束才返回。\ 在播放结束时会通过调用play_done_callback所指定的回调函数来通知播放结束事件。更多...

uint32_t	prompt_play_by_semantic_id (uint32_t semantic_id, int select_index, play_done_callback_t play_done_callback, bool preemptive)
	通过命令词语义ID开始播放指定的命令词对应的提示音。此函数为异步调用函数，也就是此函数会在启动播放后立即返回，不会等到播放结束才返回。\ 在播放结束时会通过调用play_done_callback所指定的回调函数来通知播放结束事件。更多...

uint32_t	prompt_play_by_cmd_string (char *cmd_string, int select_index, play_done_callback_t play_done_callback, bool preemptive)
	通过命令词字符串开始播放指定的命令词对应的提示音。此函数为异步调用函数，也就是此函数会在启动播放后立即返回，不会等到播放结束才返回。\ 在播放结束时会通过调用play_done_callback所指定的回调函数来通知播放结束事件。更多...

uint32_t	prompt_play_by_voice_id (uint16_t voice_id, play_done_callback_t play_done_callback, bool preemptive)
	通过音频文件ID开始播放指定的命令词对应的提示音, 只播放一个文件，没有选择播放和组合音频的功能。此函数为异步调用函数，也就是此函\ 数会在启动播放后立即返回，不会等到播放结束才返回。在播放结束时会通过调用play_done_callback所指定的回调函数来通知播放结束事件。更多...

void	prompt_player_enable (FunctionalState state)
	设置提示音播放器是否使能。更多...

uint32_t	prompt_is_playing ()
	查询提示音播放器是否正在播放提示音。更多...

uint32_t	prompt_play_by_multi_cmd_id (prompt_play_info_t *p_play_info, int number, play_done_callback_t play_done_callback)
	一次启动多个提示音播放, 多个提示音依次播放。如果当前有提示音正在播放，会被立即打断。更多...

详细描述

用于播放命令词表格中与命令词关联的播报音，包含通过命令词表格中的命令词ID、语义ID等关联的播报音

结构体说明

◆ prompt_play_info_st

struct prompt_play_info_st

提示音信息结构体。在调用"prompt_play_by_multi_cmd_id"接口时需要此类型,用于指定要播放的提示音。

成员变量
uint32_t	cmd_id	命令词ID。
uint16_t	select_index	选择索引，如果命令词有多个可选择的提示音，此索引用于指定选择第几个。-1: 表示播放器自动选择。

宏定义说明

◆ MAX_COMBINATION_COUNT

#define MAX_COMBINATION_COUNT 16

一个组合播报支持的最大音频文件数量。

类型定义说明

◆ play_done_callback_t

typedef void(* play_done_callback_t) (cmd_handle_t cmd_handle)

定义提示音播报回调函数的指针类型。

◆ prompt_play_info_t

typedef struct prompt_play_info_st prompt_play_info_t

提示音信息结构体。在调用"prompt_play_by_multi_cmd_id"接口时需要此类型,用于指定要播放的提示音。

函数说明

◆ prompt_is_playing()

uint32_t prompt_is_playing ( )

查询提示音播放器是否正在播放提示音。

返回: uint32_t 0:当前没有播放, nonzero:当前正在播放中。

◆ prompt_play_by_cmd_handle()

uint32_t prompt_play_by_cmd_handle	(	cmd_handle_t	cmd_handle,
		int	select_index,
		play_done_callback_t	play_done_callback,
		bool	preemptive
	)

通过命令词句柄开始播放指定的命令词对应的提示音。此函数为异步调用函数，也就是此函数会在启动播放后立即返回，不会等到播放结束才返回。\ 在播放结束时会通过调用play_done_callback所指定的回调函数来通知播放结束事件。

参数

cmd_handle	命令词句柄。
select_index	选择索引号，如果命令词有多个可选择的提示音，此索引用于指定选择第几个,-1: 表示播放器自动选择。如果命令词是有一个可选\ 择的提示音，此参数会被忽略。
play_done_callback	用于传入一个回调函数指针，此回调函数会在播放结束的时候被调用。
preemptive	是否打断当前正在播放的音频。

返回: uint32_t 0:开始播放成功, nonzero:开始播放失败。

◆ prompt_play_by_cmd_id()

uint32_t prompt_play_by_cmd_id	(	uint16_t	cmd_id,
		int	select_index,
		play_done_callback_t	play_done_callback,
		bool	preemptive
	)

通过命令词ID开始播放指定的命令词对应的提示音。此函数为异步调用函数，也就是此函数会在启动播放后立即返回，不会等到播放结束才返回。\ 在播放结束时会通过调用play_done_callback所指定的回调函数来通知播放结束事件。

参数

cmd_id	命令词ID。
select_index	选择索引号，如果命令词有多个可选择的提示音，此索引用于指定选择第几个,-1: 表示播放器自动选择。如果命令词是有一个可选\ 择的提示音，此参数会被忽略。
play_done_callback	用于传入一个回调函数指针，此回调函数会在播放结束的时候被调用。
preemptive	是否打断当前正在播放的音频。

返回: uint32_t 0:开始播放成功, nonzero:开始播放失败。

◆ prompt_play_by_cmd_string()

uint32_t prompt_play_by_cmd_string	(	char *	cmd_string,
		int	select_index,
		play_done_callback_t	play_done_callback,
		bool	preemptive
	)

通过命令词字符串开始播放指定的命令词对应的提示音。此函数为异步调用函数，也就是此函数会在启动播放后立即返回，不会等到播放结束才返回。\ 在播放结束时会通过调用play_done_callback所指定的回调函数来通知播放结束事件。

参数

cmd_string	字符串的指针，指向一个命令词字符串。
select_index	选择索引号，如果命令词有多个可选择的提示音，此索引用于指定选择第几个,-1: 表示播放器自动选择。如果命令词是有一个可选\ 择的提示音，此参数会被忽略。
play_done_callback	用于传入一个回调函数指针，此回调函数会在播放结束的时候被调用。
preemptive	是否打断当前正在播放的音频。

返回: uint32_t 0:开始播放成功, nonzero:开始播放失败。

◆ prompt_play_by_multi_cmd_id()

uint32_t prompt_play_by_multi_cmd_id	(	prompt_play_info_t *	p_play_info,
		int	number,
		play_done_callback_t	play_done_callback
	)

一次启动多个提示音播放, 多个提示音依次播放。如果当前有提示音正在播放，会被立即打断。

参数

p_play_info	指向prompt_play_info_t类型结构体数组的指针，用于指定需要播放的多个提示音。
number	需要播放的提示音数量。注意，一个组合提示音也只算一个。
play_done_callback	用于传入一个回调函数指针，此回调函数会在播放结束的时候被调用。

返回: uint32_t 0:开始播放成功, nonzero:开始播放失败。

◆ prompt_play_by_semantic_id()

uint32_t prompt_play_by_semantic_id	(	uint32_t	semantic_id,
		int	select_index,
		play_done_callback_t	play_done_callback,
		bool	preemptive
	)

通过命令词语义ID开始播放指定的命令词对应的提示音。此函数为异步调用函数，也就是此函数会在启动播放后立即返回，不会等到播放结束才返回。\ 在播放结束时会通过调用play_done_callback所指定的回调函数来通知播放结束事件。

参数

semantic_id	命令词语义ID。
select_index	选择索引号，如果命令词有多个可选择的提示音，此索引用于指定选择第几个,-1: 表示播放器自动选择。如果命令词是有一个可选\ 择的提示音，此参数会被忽略。
play_done_callback	用于传入一个回调函数指针，此回调函数会在播放结束的时候被调用。
preemptive	是否打断当前正在播放的音频。

返回: uint32_t 0:开始播放成功, nonzero:开始播放失败。

◆ prompt_play_by_voice_id()

uint32_t prompt_play_by_voice_id	(	uint16_t	voice_id,
		play_done_callback_t	play_done_callback,
		bool	preemptive
	)

通过音频文件ID开始播放指定的命令词对应的提示音, 只播放一个文件，没有选择播放和组合音频的功能。此函数为异步调用函数，也就是此函\ 数会在启动播放后立即返回，不会等到播放结束才返回。在播放结束时会通过调用play_done_callback所指定的回调函数来通知播放结束事件。

参数

voice_id	音频文件ID，用于指定要播放的音频文件。
play_done_callback	用于传入一个回调函数指针，此回调函数会在播放结束的时候被调用。
preemptive	是否打断当前正在播放的音频。

返回: uint32_t 0:开始播放成功, nonzero:开始播放失败。

◆ prompt_player_enable()

void prompt_player_enable ( FunctionalState state )

设置提示音播放器是否使能。

参数

state ENABLE:提示音播放器可用。DISABLE:提示音播放器不可用。