public final class VoiceInteractor
extends Object
| java.lang.Object | |
| android.app.VoiceInteractor | |
用于通过语音与用户交互的Activity接口。 如果活动当前涉及语音交互,请使用Activity.getVoiceInteractor检索界面。
语音交互者围绕将语音交互请求提交给与用户一起工作的后端语音交互服务来进行。 这些请求与submitRequest(VoiceInteractor.Request)一起提交,提供描述要执行的操作类型的VoiceInteractor.Request子类的新实例 - 当前可能的请求是VoiceInteractor.ConfirmationRequest和VoiceInteractor.CommandRequest 。
提交请求后,语音系统将处理该请求并最终将结果提交给请求对象。 应用程序可以随时取消挂起的请求。
VoiceInteractor与Activity的状态保存机制集成在一起,因此如果某个活动正在以保留状态重新启动,它将保留当前的VoiceInteractor和任何未完成的请求。 因此,您应该始终使用Request.getActivity来回到请求的活动,而不是通过一个非静态的内部类来显式或隐式地保留活动实例。
Nested classes |
|
|---|---|
class |
VoiceInteractor.AbortVoiceRequest 报道当前的交互不能通过语音完成,因此应用程序需要切换到传统的输入UI。 |
class |
VoiceInteractor.CommandRequest 使用可信系统VoiceInteractionService执行特定于供应商的命令。 |
class |
VoiceInteractor.CompleteVoiceRequest 报告当前的交互已成功完成,语音,因此应用程序可以向用户报告最终状态。 |
class |
VoiceInteractor.ConfirmationRequest 通过可信系统VoiceInteractionService确认与用户的操作。 |
class |
VoiceInteractor.PickOptionRequest 用户通过可信系统VoiceInteractionService从多个潜在选项中选择一个选项。 |
class |
VoiceInteractor.Prompt 一组语音提示可与语音交互系统一起用于确认操作,选择选项或执行类似操作。 |
class |
VoiceInteractor.Request 可以提交给交互者的语音交互请求的基类。 |
公共方法(Public methods) |
|
|---|---|
VoiceInteractor.Request |
getActiveRequest(String name) 返回使用指定名称提交的当前活动请求。 |
Request[] |
getActiveRequests() 返回所有当前活动的请求。 |
boolean |
submitRequest(VoiceInteractor.Request request) |
boolean |
submitRequest(VoiceInteractor.Request request, String name) 向语音交互服务提交新的 |
boolean[] |
supportsCommands(String[] commands) 查询VoiceInteractionService中可用的支持命令。 |
继承方法(Inherited methods) |
|
|---|---|
java.lang.Object
|
|
VoiceInteractor.Request getActiveRequest (String name)
返回使用指定名称提交的当前活动请求。
| 参数(Parameters) | |
|---|---|
name |
String: The name used to submit the request, as per submitRequest(android.app.VoiceInteractor.Request, String). |
| 返回(Returns) | |
|---|---|
VoiceInteractor.Request |
Returns the active request with that name, or null if there was none. |
Request[] getActiveRequests ()
返回所有当前活动的请求。
| 返回(Returns) | |
|---|---|
Request[] |
|
boolean submitRequest (VoiceInteractor.Request request)
| 参数(Parameters) | |
|---|---|
request |
VoiceInteractor.Request
|
| 返回(Returns) | |
|---|---|
boolean |
|
boolean submitRequest (VoiceInteractor.Request request, String name)
向语音交互服务提交新的VoiceInteractor.Request 。 请求必须是可用的一个子类- VoiceInteractor.ConfirmationRequest , VoiceInteractor.PickOptionRequest , VoiceInteractor.CompleteVoiceRequest , VoiceInteractor.AbortVoiceRequest ,或VoiceInteractor.CommandRequest 。
| 参数(Parameters) | |
|---|---|
request |
VoiceInteractor.Request: The desired request to submit. |
name |
String: An optional name for this request, or null. This can be used later with getActiveRequests() and getActiveRequest(String) to find the request. |
| 返回(Returns) | |
|---|---|
boolean |
Returns true of the request was successfully submitted, else false. |
boolean[] supportsCommands (String[] commands)
查询VoiceInteractionService中可用的支持命令。 该命令是描述要执行的通用操作的字符串。 一个例子可能是“org.example.commands.PICK_DATE”来要求用户选择一个日期。 (注意:这不是一个实际的工作示例。)
| 参数(Parameters) | |
|---|---|
commands |
String: The array of commands to query for support. |
| 返回(Returns) | |
|---|---|
boolean[] |
Array of booleans indicating whether each command is supported or not. |