com.aldebaran.qi.helper.proxies

Class ALAnimatedSpeech

java.lang.Object

com.aldebaran.qi.helper.ALProxy

com.aldebaran.qi.helper.proxies.ALAnimatedSpeech

public class ALAnimatedSpeech
extends ALProxy

The Animated Speech module makes NAO interpret a text annotated with behaviors.

See Also:

NAOqi APIs for ALAnimatedSpeech

Field Summary

Fields inherited from class com.aldebaran.qi.helper.ALProxy

name, service

Constructor Summary

Constructors

Constructor and Description
ALAnimatedSpeech(Session session)

Method Summary

Modifier and Type	Method and Description
void	addTagsToWords(java.lang.Object tagsToWords) Add some new links between tags and words.
void	clearStats()
void	declareAnimationsPackage(java.lang.String animationsPackage) Add a new package that contains animations.
void	declareTagForAnimations(java.lang.Object tagsToAnimations) Declare some tags with the associated animations.
void	exit() Exits and unregisters the module.
java.lang.Integer	getBodyLanguageMode() Set the current body language mode. 3 modes exist: BODY_LANGUAGE_MODE_DISABLED,BODY_LANGUAGE_MODE_RANDOM and BODY_LANGUAGE_MODE_CONTEXTUAL (see BodyLanguageMode enum for more details)
java.lang.String	getBodyLanguageModeToStr() Set the current body language mode. 3 modes exist: "disabled", "random" and "contextual" (see BodyLanguageMode enum for more details)
java.lang.String	getBrokerName() Gets the name of the parent broker.
java.lang.Object	getMethodHelp(java.lang.String methodName) Retrieves a method's description.
java.util.List<java.lang.String>	getMethodList() Retrieves the module's method list.
java.lang.Object	getModuleHelp() Retrieves the module's description.
java.lang.String	getUsage(java.lang.String name) Gets the method usage string.
java.lang.Boolean	isBodyLanguageEnabled() DEPRECATED since 1.22: use getBodyLanguageMode instead.Indicate if the body language is enabled or not.
java.lang.Boolean	isBodyTalkEnabled() DEPRECATED since 1.18: use getBodyLanguageMode instead.Indicate if the body talk is enabled or not.
java.lang.Boolean	isRunning(java.lang.Integer id) Returns true if the method is currently running.
java.lang.Boolean	isStatsEnabled()
java.lang.Boolean	isTraceEnabled()
java.lang.Boolean	ping() Just a ping.
void	say(java.lang.String text) Say the annotated text given in parameter and animate it with animations inserted in the text.
void	say(java.lang.String text, java.lang.Object configuration) Say the annotated text given in parameter and animate it with animations inserted in the text.
void	setBodyLanguageEnabled(java.lang.Boolean enable) DEPRECATED since 1.22: use setBodyLanguageMode instead.Enable or disable the automatic body language on the speech.If it is enabled, anywhere you have not annotate your text with animation,the robot will fill the gap with automatically calculated gestures.If it is disabled, the robot will move only where you annotate it withanimations.
void	setBodyLanguageMode(java.lang.Integer bodyLanguageMode) Set the current body language mode. 3 modes exist: BODY_LANGUAGE_MODE_DISABLED,BODY_LANGUAGE_MODE_RANDOM and BODY_LANGUAGE_MODE_CONTEXTUAL (see BodyLanguageMode enum for more details)
void	setBodyLanguageModeFromStr(java.lang.String stringBodyLanguageMode) Set the current body language mode. 3 modes exist: "disabled", "random" and "contextual" (see BodyLanguageMode enum for more details)
void	setBodyTalkEnabled(java.lang.Boolean enable) DEPRECATED since 1.18: use setBodyLanguageMode instead.Enable or disable the automatic body talk on the speech.If it is enabled, anywhere you have not annotate your text with animation,the robot will fill the gap with automatically calculated gestures.If it is disabled, the robot will move only where you annotate it withanimations.
void	stop(java.lang.Integer id) returns true if the method is currently running
java.lang.String	version() Returns the version of the module.
java.lang.Boolean	wait(java.lang.Integer id, java.lang.Integer timeoutPeriod) Wait for the end of a long running method that was called using 'post'

Methods inherited from class com.aldebaran.qi.helper.ALProxy

call, connect, connect, disconnect, getNaoqiType, getService, isProxyReady, setService

Methods inherited from class java.lang.Object

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

Constructor Detail

ALAnimatedSpeech

public ALAnimatedSpeech(Session session)
                 throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

isBodyTalkEnabled

public java.lang.Boolean isBodyTalkEnabled()
                                    throws CallError,
                                           java.lang.InterruptedException

DEPRECATED since 1.18: use getBodyLanguageMode instead.Indicate if the body talk is enabled or not.

Returns:

The boolean value: true means it is enabled, false means it is disabled.

Throws:

CallError

java.lang.InterruptedException

declareTagForAnimations

public void declareTagForAnimations(java.lang.Object tagsToAnimations)
                             throws CallError,
                                    java.lang.InterruptedException

Declare some tags with the associated animations.

Parameters:

tagsToAnimations - Map of Tags to Animations.

Throws:

CallError

java.lang.InterruptedException

isBodyLanguageEnabled

public java.lang.Boolean isBodyLanguageEnabled()
                                        throws CallError,
                                               java.lang.InterruptedException

DEPRECATED since 1.22: use getBodyLanguageMode instead.Indicate if the body language is enabled or not.

Returns:

The boolean value: true means it is enabled, false means it is disabled.

Throws:

CallError

java.lang.InterruptedException

addTagsToWords

public void addTagsToWords(java.lang.Object tagsToWords)
                    throws CallError,
                           java.lang.InterruptedException

Add some new links between tags and words.

Parameters:

tagsToWords - Map of tags to words.

Throws:

CallError

java.lang.InterruptedException

isStatsEnabled

public java.lang.Boolean isStatsEnabled()
                                 throws CallError,
                                        java.lang.InterruptedException

Throws:

CallError

java.lang.InterruptedException

clearStats

public void clearStats()
                throws CallError,
                       java.lang.InterruptedException

Throws:

CallError

java.lang.InterruptedException

isTraceEnabled

public java.lang.Boolean isTraceEnabled()
                                 throws CallError,
                                        java.lang.InterruptedException

Throws:

CallError

java.lang.InterruptedException

exit

public void exit()
          throws CallError,
                 java.lang.InterruptedException

Exits and unregisters the module.

Throws:

CallError

java.lang.InterruptedException

version

public java.lang.String version()
                         throws CallError,
                                java.lang.InterruptedException

Returns the version of the module.

Returns:

A string containing the version of the module.

Throws:

CallError

java.lang.InterruptedException

ping

public java.lang.Boolean ping()
                       throws CallError,
                              java.lang.InterruptedException

Just a ping. Always returns true

Returns:

returns true

Throws:

CallError

java.lang.InterruptedException

getMethodList

public java.util.List<java.lang.String> getMethodList()
                                               throws CallError,
                                                      java.lang.InterruptedException

Retrieves the module's method list.

Returns:

An array of method names.

Throws:

CallError

java.lang.InterruptedException

getMethodHelp

public java.lang.Object getMethodHelp(java.lang.String methodName)
                               throws CallError,
                                      java.lang.InterruptedException

Retrieves a method's description.

Parameters:

methodName - The name of the method.

Returns:

A structure containing the method's description.

Throws:

CallError

java.lang.InterruptedException

getModuleHelp

public java.lang.Object getModuleHelp()
                               throws CallError,
                                      java.lang.InterruptedException

Retrieves the module's description.

Returns:

A structure describing the module.

Throws:

CallError

java.lang.InterruptedException

wait

public java.lang.Boolean wait(java.lang.Integer id,
                              java.lang.Integer timeoutPeriod)
                       throws CallError,
                              java.lang.InterruptedException

Wait for the end of a long running method that was called using 'post'

Parameters:

id - The ID of the method that was returned when calling the method using 'post'

timeoutPeriod - The timeout period in ms. To wait indefinately, use a timeoutPeriod of zero.

Returns:

True if the timeout period terminated. False if the method returned.

Throws:

CallError

java.lang.InterruptedException

isRunning

public java.lang.Boolean isRunning(java.lang.Integer id)
                            throws CallError,
                                   java.lang.InterruptedException

Returns true if the method is currently running.

Parameters:

id - The ID of the method that was returned when calling the method using 'post'

Returns:

True if the method is currently running

Throws:

CallError

java.lang.InterruptedException

stop

public void stop(java.lang.Integer id)
          throws CallError,
                 java.lang.InterruptedException

returns true if the method is currently running

Parameters:

id - the ID of the method to wait for

Throws:

CallError

java.lang.InterruptedException

getBrokerName

public java.lang.String getBrokerName()
                               throws CallError,
                                      java.lang.InterruptedException

Gets the name of the parent broker.

Returns:

The name of the parent broker.

Throws:

CallError

java.lang.InterruptedException

getUsage

public java.lang.String getUsage(java.lang.String name)
                          throws CallError,
                                 java.lang.InterruptedException

Gets the method usage string. This summarises how to use the method.

Parameters:

name - The name of the method.

Returns:

A string that summarises the usage of the method.

Throws:

CallError

java.lang.InterruptedException

say

public void say(java.lang.String text)
         throws CallError,
                java.lang.InterruptedException

Say the annotated text given in parameter and animate it with animations inserted in the text.

Parameters:

text - An annotated text (for example: "Hello. ^start(Hey_1) My name is NAO").

Throws:

CallError

java.lang.InterruptedException

say

public void say(java.lang.String text,
                java.lang.Object configuration)
         throws CallError,
                java.lang.InterruptedException

Say the annotated text given in parameter and animate it with animations inserted in the text.

Parameters:

text - An annotated text (for example: "Hello. ^start(Hey_1) My name is NAO").

configuration - The animated speech configuration.

Throws:

CallError

java.lang.InterruptedException

setBodyTalkEnabled

public void setBodyTalkEnabled(java.lang.Boolean enable)
                        throws CallError,
                               java.lang.InterruptedException

DEPRECATED since 1.18: use setBodyLanguageMode instead.Enable or disable the automatic body talk on the speech.If it is enabled, anywhere you have not annotate your text with animation,the robot will fill the gap with automatically calculated gestures.If it is disabled, the robot will move only where you annotate it withanimations.

Parameters:

enable - The boolean value: true to enable, false to disable.

Throws:

CallError

java.lang.InterruptedException

setBodyLanguageEnabled

public void setBodyLanguageEnabled(java.lang.Boolean enable)
                            throws CallError,
                                   java.lang.InterruptedException

DEPRECATED since 1.22: use setBodyLanguageMode instead.Enable or disable the automatic body language on the speech.If it is enabled, anywhere you have not annotate your text with animation,the robot will fill the gap with automatically calculated gestures.If it is disabled, the robot will move only where you annotate it withanimations.

Parameters:

enable - The boolean value: true to enable, false to disable.

Throws:

CallError

java.lang.InterruptedException

setBodyLanguageModeFromStr

public void setBodyLanguageModeFromStr(java.lang.String stringBodyLanguageMode)
                                throws CallError,
                                       java.lang.InterruptedException

Set the current body language mode. 3 modes exist: "disabled", "random" and "contextual" (see BodyLanguageMode enum for more details)

Parameters:

stringBodyLanguageMode - The choosen body language mode.

Throws:

CallError

java.lang.InterruptedException

setBodyLanguageMode

public void setBodyLanguageMode(java.lang.Integer bodyLanguageMode)
                         throws CallError,
                                java.lang.InterruptedException

Set the current body language mode. 3 modes exist: BODY_LANGUAGE_MODE_DISABLED,BODY_LANGUAGE_MODE_RANDOM and BODY_LANGUAGE_MODE_CONTEXTUAL (see BodyLanguageMode enum for more details)

Parameters:

bodyLanguageMode - The choosen body language mode.

Throws:

CallError

java.lang.InterruptedException

getBodyLanguageModeToStr

public java.lang.String getBodyLanguageModeToStr()
                                          throws CallError,
                                                 java.lang.InterruptedException

Set the current body language mode. 3 modes exist: "disabled", "random" and "contextual" (see BodyLanguageMode enum for more details)

Returns:

The current body language mode.

Throws:

CallError

java.lang.InterruptedException

getBodyLanguageMode

public java.lang.Integer getBodyLanguageMode()
                                      throws CallError,
                                             java.lang.InterruptedException

Set the current body language mode. 3 modes exist: BODY_LANGUAGE_MODE_DISABLED,BODY_LANGUAGE_MODE_RANDOM and BODY_LANGUAGE_MODE_CONTEXTUAL (see BodyLanguageMode enum for more details)

Returns:

The current body language mode.

Throws:

CallError

java.lang.InterruptedException

declareAnimationsPackage

public void declareAnimationsPackage(java.lang.String animationsPackage)
                              throws CallError,
                                     java.lang.InterruptedException

Add a new package that contains animations.

Parameters:

animationsPackage - The new package that contains animations.

Throws:

CallError

java.lang.InterruptedException