com.asus.robotframework.API

Class DialogSystem

java.lang.Object

com.asus.robotframework.API.DialogSystem

public class DialogSystem
extends java.lang.Object

Class that can be used to make Zenbo speak and listen, and to change the facial expressions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DialogSystem.DynamicEditAction

Field Summary

Fields

Modifier and Type	Field and Description
static int	LANGUAGE_ID_EN_US
static int	LANGUAGE_ID_ZH_TW

Method Summary

Modifier and Type	Method and Description
int	clearAppContext(java.lang.String domain) Clear specific domain UUID in current dialog system stack.
int	clearBackgroundContext(java.lang.String domain) Clear background context
int	dynamicEditInstance(java.lang.String domain, DialogSystem.DynamicEditAction action, java.lang.String entity, org.json.JSONArray instances) Add/Delete/Update user defined instances of an specific Entity.
int	jumpToPlan(java.lang.String domain, java.lang.String plan) Let dialog state switch to specific plan, and set output context of this plan on top of the context stack.
int	jumpToPlan(java.lang.String domain, java.lang.String plan, boolean crossIntent) Let dialog state switch to specific plan, and set output context of this plan on top of the context stack.
int	queryExpressionStatus() Query expression status return result in RobotCallback.onResult(int, int, RobotErrorCode, Bundle) callback, result bundle will have an JSON string, key is "RESULT".
int	registerListenCallback(RobotCallback.Listen listen) Register the listen callback functions for Dialog System.
int	resetListenTimeoutCounter() Reset listen timeout counter
int	setBackgroundContext(java.lang.String domain, java.lang.String plan) Set background context
int	setExpression(RobotFace face) Set the robot expression.
int	setExpression(RobotFace face, java.lang.String sentence) Make robot expression and speak.
int	setExpression(RobotFace face, java.lang.String sentence, ExpressionConfig config) Make robot expression and speak.
int	setListenContext(java.lang.String domain, java.lang.String context) Force Dialog System to listen specific context in the DS Editor
int	setPressOnHeadAction(boolean enable) Set press on head action.
int	setTouchOnlySignal(boolean setting) Touch only signal It will show "touch only" on top of screen if user trigger by "Hey Zenbo".
int	setVoiceTrigger(boolean enable) Set dialog system voice trigger.
int	speak(java.lang.String sentence) Start speaking.
int	speak(java.lang.String sentence, int languageType) Deprecated.
int	speak(java.lang.String sentence, SpeakConfig config) Start speaking.
int	speakAndListen(java.lang.String sentence, float timeout) Deprecated.
int	speakAndListen(java.lang.String sentence, float timeout, int retry) Deprecated.
int	speakAndListen(java.lang.String sentence, SpeakConfig config) Start speaking and listening If sentence is an empty string (""), Zenbo will listen directly.
int	stopSpeak() Stop TTS
int	stopSpeakAndListen() Stop speak and listen
int	unregisterListenCallback() Unregister listen callback

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LANGUAGE_ID_EN_US

public static final int LANGUAGE_ID_EN_US

See Also:

Constant Field Values

LANGUAGE_ID_ZH_TW

public static final int LANGUAGE_ID_ZH_TW

See Also:

Constant Field Values

Method Detail

clearAppContext

public int clearAppContext(java.lang.String domain)

Clear specific domain UUID in current dialog system stack.

Parameters:

domain - domain UUID

Returns:

serial number of the command

clearBackgroundContext

public int clearBackgroundContext(java.lang.String domain)

Clear background context

Parameters:

domain - domain UUID

Returns:

serial number of the command

dynamicEditInstance

public int dynamicEditInstance(java.lang.String domain,
                               DialogSystem.DynamicEditAction action,
                               java.lang.String entity,
                               org.json.JSONArray instances)

Add/Delete/Update user defined instances of an specific Entity.

Parameters:

domain - domain UUID

action - types of action

entity - the existed entity added on the Concept page of DS Editor

instances - the instances to be modified

Returns:

serial number of the command

jumpToPlan

public int jumpToPlan(java.lang.String domain,
                      java.lang.String plan)

Let dialog state switch to specific plan, and set output context of this plan on top of the context stack.

Parameters:

domain - domain UUID

plan - Plan ID to be switched to

Returns:

serial number of the command

jumpToPlan

public int jumpToPlan(java.lang.String domain,
                      java.lang.String plan,
                      boolean crossIntent)

Let dialog state switch to specific plan, and set output context of this plan on top of the context stack.

Parameters:

domain - domain UUID

plan - Plan ID to be switched to

crossIntent - true enable cross intent

Returns:

serial number of the command

queryExpressionStatus

public int queryExpressionStatus()

Query expression status return result in RobotCallback.onResult(int, int, RobotErrorCode, Bundle) callback, result bundle will have an JSON string, key is "RESULT". JSON object have two element, FaceID and FaceExit. FaceID is current face value, get face value by RobotFace.getValue() and FaceExit is an boolean true is currently have display expression.

Example: {"FaceID":"1","FaceExit":"false"}

Returns:

serial number of the command

registerListenCallback

public int registerListenCallback(RobotCallback.Listen listen)

Register the listen callback functions for Dialog System.

Parameters:

listen - listen callback functions

Returns:

serial number of the command

See Also:

RobotCallback.Listen

resetListenTimeoutCounter

public int resetListenTimeoutCounter()

Reset listen timeout counter

Returns:

serial number of the command

setBackgroundContext

public int setBackgroundContext(java.lang.String domain,
                                java.lang.String plan)

Set background context

Parameters:

domain - domain UUID

plan - Plan ID

Returns:

serial number of the command

setExpression

public int setExpression(RobotFace face)

Set the robot expression.

Parameters:

face - robot face expression ID

Returns:

serial number of the command

setExpression

public int setExpression(RobotFace face,
                         java.lang.String sentence)

Make robot expression and speak.

Parameters:

face - robot face expression ID

sentence - sentence of text to speech

Returns:

serial number of the command

setExpression

public int setExpression(RobotFace face,
                         java.lang.String sentence,
                         ExpressionConfig config)

Make robot expression and speak.

Parameters:

face - robot face expression ID

sentence - sentence of text to speech

config - configuration for expression engine

Returns:

serial number of the command

setListenContext

public int setListenContext(java.lang.String domain,
                            java.lang.String context)

Force Dialog System to listen specific context in the DS Editor

Parameters:

domain - domain UUID

context - context to listen to

Returns:

serial number of the command

setPressOnHeadAction

public int setPressOnHeadAction(boolean enable)

Set press on head action. Enable/disable short press to shy and long press to close app.

Parameters:

enable - flag to enable/disable press on head action.

Returns:

Serial number of the command.

setTouchOnlySignal

public int setTouchOnlySignal(boolean setting)

Touch only signal It will show "touch only" on top of screen if user trigger by "Hey Zenbo".

Parameters:

setting - enable/disable this function

Returns:

serial number of the command

setVoiceTrigger

public int setVoiceTrigger(boolean enable)

Set dialog system voice trigger.

Parameters:

enable - flag to enable/disable dialog system voice trigger

Returns:

serial number of the command

speak

public int speak(java.lang.String sentence)

Start speaking.

Parameters:

sentence - sentence of text to speech

Returns:

serial number of the command

speak

@Deprecated
public int speak(java.lang.String sentence,
                              int languageType)

Deprecated.

Start speaking.

Parameters:

sentence - sentence of text to speech

languageType - LANGUAGE_ID_ZH_TW or LANGUAGE_ID_EN_US

Returns:

serial number of the command

speak

public int speak(java.lang.String sentence,
                 SpeakConfig config)

Start speaking.

Parameters:

sentence - sentence of text to speech

config - configuration for speak engine

Returns:

serial number of the command

speakAndListen

@Deprecated
public int speakAndListen(java.lang.String sentence,
                                       float timeout)

Deprecated.

Start speaking and listening If sentence is an empty string (""), Zenbo will listen directly.

Parameters:

sentence - sentence of text to speech

timeout - CSR listening timeout setting (sec)

Returns:

serial number of the command

speakAndListen

@Deprecated
public int speakAndListen(java.lang.String sentence,
                                       float timeout,
                                       int retry)

Deprecated.

Start speaking and listening If sentence is an empty string (""), Zenbo will listen directly.

Parameters:

sentence - sentence of text to speech

timeout - CSR listening timeout setting (sec)

retry - max retry times to ask user to speak again

Returns:

serial number of the command

speakAndListen

public int speakAndListen(java.lang.String sentence,
                          SpeakConfig config)

Start speaking and listening If sentence is an empty string (""), Zenbo will listen directly.

Parameters:

sentence - sentence sentence of text to speech

config - configuration for speak engine

Returns:

serial number of the command

stopSpeak

public int stopSpeak()

Stop TTS

Returns:

serial number of the command

stopSpeakAndListen

public int stopSpeakAndListen()

Stop speak and listen

Returns:

serial number of the command

unregisterListenCallback

public int unregisterListenCallback()

Unregister listen callback

Returns:

serial number of the command