CI13LC SDK API手册  2.1.1
本手册用于描述CI13LC SDK各个组件和驱动API
prompt_player.h
浏览该文件的文档.
1 
12 #ifndef __PROMPT_PLAYER_H__
13 #define __PROMPT_PLAYER_H__
14 
15 #include <stdbool.h>
16 #include "command_info.h"
17 #include "ci_system.h"
18 
19 
26 #define MAX_COMBINATION_COUNT 16
28 
33 typedef void (*play_done_callback_t)(cmd_handle_t cmd_handle);
34 
39 typedef struct prompt_play_info_st
40 {
41  uint32_t cmd_id;
42  uint16_t select_index;
44 
56 extern uint32_t prompt_play_by_cmd_handle(
57  cmd_handle_t cmd_handle,
58  int select_index,
59  play_done_callback_t play_done_callback,
60  bool preemptive);
61 
73 extern uint32_t prompt_play_by_cmd_id(
74  uint16_t cmd_id,
75  int select_index,
76  play_done_callback_t play_done_callback,
77  bool preemptive);
78 
90 extern uint32_t prompt_play_by_semantic_id(
91  uint32_t semantic_id,
92  int select_index,
93  play_done_callback_t play_done_callback,
94  bool preemptive);
95 
107 extern uint32_t prompt_play_by_cmd_string(
108  char* cmd_string,
109  int select_index,
110  play_done_callback_t play_done_callback,
111  bool preemptive);
112 
122 extern uint32_t prompt_play_by_voice_id(uint16_t voice_id, play_done_callback_t play_done_callback, bool preemptive);
123 
129 extern void prompt_player_enable(FunctionalState state);
130 
136 extern uint32_t prompt_is_playing();
137 
146 extern uint32_t prompt_play_by_multi_cmd_id(prompt_play_info_t *p_play_info, int number, play_done_callback_t play_done_callback);
147 
156 extern uint32_t prompt_stop_play();
157 
158 #endif
159 
160 
161 
uint32_t prompt_play_by_cmd_handle(cmd_handle_t cmd_handle, int select_index, play_done_callback_t play_done_callback, bool preemptive)
通过命令词句柄开始播放指定的命令词对应的提示音。此函数为异步调用函数,也就是此函数会在启动播放后立即...
Definition: prompt_player.c:347
提示音信息结构体。在调用"prompt_play_by_multi_cmd_id"接口时需要此类型,用于指定要播放的提示音。 ...
Definition: prompt_player.h:39
uint32_t prompt_stop_play()
停止当前正在播放的提示音。
Definition: prompt_player.c:616
struct prompt_play_info_st prompt_play_info_t
提示音信息结构体。在调用"prompt_play_by_multi_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开始播放指定的命令词对应的提示音。此函数为异步调用函数,也就是此函数会在启动播放后立即返...
Definition: prompt_player.c:474
void(* play_done_callback_t)(cmd_handle_t cmd_handle)
定义提示音播报回调函数的指针类型。
Definition: prompt_player.h:33
此模块用于查询和读取命令词信息(来源于命令词信息excel表格).
uint32_t prompt_is_playing()
查询提示音播放器是否正在播放提示音。
Definition: prompt_player.c:604
chip级定义
uint32_t cmd_id
Definition: prompt_player.h:41
uint32_t prompt_play_by_cmd_string(char *cmd_string, int select_index, play_done_callback_t play_done_callback, bool preemptive)
通过命令词字符串开始播放指定的命令词对应的提示音。此函数为异步调用函数,也就是此函数会在启动播放后立...
Definition: prompt_player.c:494
void * cmd_handle_t
定义命令词信息结构的句柄类型。
Definition: command_info_v2.h:54
uint32_t prompt_play_by_voice_id(uint16_t voice_id, play_done_callback_t play_done_callback, bool preemptive)
通过音频文件ID开始播放指定的命令词对应的提示音, 只播放一个文件,没有选择播放和组合音频的功能。此函数...
Definition: prompt_player.c:469
uint32_t prompt_play_by_semantic_id(uint32_t semantic_id, int select_index, play_done_callback_t play_done_callback, bool preemptive)
通过命令词语义ID开始播放指定的命令词对应的提示音。此函数为异步调用函数,也就是此函数会在启动播放后立...
Definition: prompt_player.c:484
uint16_t select_index
命令词ID。
Definition: prompt_player.h:42
uint32_t prompt_play_by_multi_cmd_id(prompt_play_info_t *p_play_info, int number, play_done_callback_t play_done_callback)
一次启动多个提示音播放, 多个提示音依次播放。如果当前有提示音正在播放,会被立即打断。 ...
Definition: prompt_player.c:512
FunctionalState
Definition: ci_system.h:46
void prompt_player_enable(FunctionalState state)
设置提示音播放器是否使能。
Definition: prompt_player.c:339