com.aldebaran.qi.helper.proxies

Class ALAudioPlayer

java.lang.Object

com.aldebaran.qi.helper.ALProxy

com.aldebaran.qi.helper.proxies.ALAudioPlayer

public class ALAudioPlayer
extends ALProxy

This module allows to play wav and mp3 files on NAO

See Also:

NAOqi APIs for ALAudioPlayer

Field Summary

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

name, service

Constructor Summary

Constructors

Constructor and Description
ALAudioPlayer(Session session)

Method Summary

Modifier and Type	Method and Description
void	clearStats()
void	exit() Exits and unregisters the module.
java.lang.String	getBrokerName() Gets the name of the parent broker.
java.lang.Float	getCurrentPosition(java.lang.Integer playId) Returns the position in the file which is currently played
java.lang.Float	getFileLength(java.lang.Integer playId) Returns the length of the file played
java.util.List<java.lang.String>	getInstalledSoundSetsList()
java.util.List<java.lang.String>	getLoadedFilesIds() returns an array containing the Ids of the currently loaded files
java.util.List<java.lang.String>	getLoadedFilesNames() returns an array containing the names of the currently loaded files
java.util.List<java.lang.String>	getLoadedSoundSetsList()
java.lang.Float	getMasterVolume() Returns the master volume of the player
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.util.List<java.lang.String>	getSoundSetFileNames(java.lang.String setName) Return the list of files contained in a sound set
java.lang.String	getUsage(java.lang.String name) Gets the method usage string.
java.lang.Float	getVolume(java.lang.Integer playId) Returns the volume of the player
void	goTo(java.lang.Integer playId, java.lang.Float position) Goes to a given position in a file which is playing.
java.lang.Boolean	isRunning(java.lang.Integer id) Returns true if the method is currently running.
java.lang.Boolean	isSoundSetFileInstalled(java.lang.String setName, java.lang.String soundName)
java.lang.Boolean	isSoundSetInstalled(java.lang.String setName)
java.lang.Boolean	isStatsEnabled()
java.lang.Boolean	isTraceEnabled()
java.lang.Integer	loadFile(java.lang.String fileName) Loads a file for ulterior playback
void	loadSoundSet(java.lang.String setName) Load a sound set
void	pause(java.lang.Integer id) Pause a play back
java.lang.Boolean	ping() Just a ping.
void	play(java.lang.Integer id) Starts the playback of a file preloaded with the loadFile function.
void	play(java.lang.Integer id, java.lang.Float volume, java.lang.Float pan) Starts the playback of a file preloaded with the loadFile function, with specific volume and audio balance
void	playFile(java.lang.String fileName) Plays a wav or mp3 file
void	playFile(java.lang.String fileName, java.lang.Float volume, java.lang.Float pan) Plays a wav or mp3 file, with specific volume and audio balance
void	playFileFromPosition(java.lang.String fileName, java.lang.Float position) Plays a wav or mp3 file from a given position in the file.
void	playFileFromPosition(java.lang.String fileName, java.lang.Float position, java.lang.Float volume, java.lang.Float pan) Plays a wav or mp3 file from a given position in the file, with specific volume and audio balance
void	playFileInLoop(java.lang.String fileName) Plays a wav or mp3 file in loop
void	playFileInLoop(java.lang.String fileName, java.lang.Float volume, java.lang.Float pan) Plays a wav or mp3 file in loop, with specific volume and audio balance
void	playInLoop(java.lang.Integer id) Starts the playback in loop of a file preloaded with the loadFile function
void	playInLoop(java.lang.Integer id, java.lang.Float volume, java.lang.Float pan) Plays a wav or mp3 file in loop, with specific volume and audio balance
void	playSine(java.lang.Integer frequence, java.lang.Integer gain, java.lang.Integer pan, java.lang.Float duration) Play a sine wave which specified caracteristics.
void	playSoundSetFile(java.lang.String fileName) Plays a file contained in one of the sound sets loaded
void	playSoundSetFile(java.lang.String fileName, java.lang.Float position, java.lang.Float volume, java.lang.Float pan, java.lang.Boolean loop) Plays a file contained in a given sound set
void	playSoundSetFile(java.lang.String soundSetName, java.lang.String fileName) Plays a file contained in a given sound set
void	playSoundSetFile(java.lang.String soundSetName, java.lang.String fileName, java.lang.Float position, java.lang.Float volume, java.lang.Float pan, java.lang.Boolean loop) Plays a file contained in a given sound set
void	playWebStream(java.lang.String streamName, java.lang.Float param1, java.lang.Float param2) Starts the playback of a wab audio stream
void	setMasterVolume(java.lang.Float volume) Sets the master volume of the player
void	setPanorama(java.lang.Float param1) sets the audio panorama : -1 for left speaker / 1 for right speaker
void	setVolume(java.lang.Integer id, java.lang.Float volume) Sets the volume of the player
void	stop(java.lang.Integer id) returns true if the method is currently running
void	stopAll() Stops all the files that are currently playing.
void	unloadAllFiles() unloads all the files already loaded.
void	unloadFile(java.lang.Integer id) unloads a file previously loaded with the loadFile function
void	unloadSoundSet(java.lang.String setName) Unload a sound set
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

ALAudioPlayer

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

Throws:

java.lang.Exception

Method Detail

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

playFile

public void playFile(java.lang.String fileName)
              throws CallError,
                     java.lang.InterruptedException

Plays a wav or mp3 file

Parameters:

fileName - Path of the sound file

Throws:

CallError

java.lang.InterruptedException

playFile

public void playFile(java.lang.String fileName,
                     java.lang.Float volume,
                     java.lang.Float pan)
              throws CallError,
                     java.lang.InterruptedException

Plays a wav or mp3 file, with specific volume and audio balance

Parameters:

fileName - Path of the sound file

volume - volume of the sound file (must be between 0.0 and 1.0)

pan - audio balance of the sound file (-1.0 : left / 1.0 : right / 0.0 : centered)

Throws:

CallError

java.lang.InterruptedException

playSoundSetFile

public void playSoundSetFile(java.lang.String fileName)
                      throws CallError,
                             java.lang.InterruptedException

Plays a file contained in one of the sound sets loaded

Parameters:

fileName - Name of the file without extension

Throws:

CallError

java.lang.InterruptedException

playSoundSetFile

public void playSoundSetFile(java.lang.String soundSetName,
                             java.lang.String fileName)
                      throws CallError,
                             java.lang.InterruptedException

Plays a file contained in a given sound set

Parameters:

soundSetName - Name of the soundset

fileName - Name of the file without extension

Throws:

CallError

java.lang.InterruptedException

playSoundSetFile

public void playSoundSetFile(java.lang.String soundSetName,
                             java.lang.String fileName,
                             java.lang.Float position,
                             java.lang.Float volume,
                             java.lang.Float pan,
                             java.lang.Boolean loop)
                      throws CallError,
                             java.lang.InterruptedException

Plays a file contained in a given sound set

Parameters:

soundSetName - Name of the soundset

fileName - Name of the file without extension

position - Position in second where the playing has to begin

volume - volume of the sound file (must be between 0.0 and 1.0)

pan - audio balance of the sound file (-1.0 : left / 1.0 : right)

loop - specify if the file must be played in loop

Throws:

CallError

java.lang.InterruptedException

playSoundSetFile

public void playSoundSetFile(java.lang.String fileName,
                             java.lang.Float position,
                             java.lang.Float volume,
                             java.lang.Float pan,
                             java.lang.Boolean loop)
                      throws CallError,
                             java.lang.InterruptedException

Plays a file contained in a given sound set

Parameters:

fileName - Name of the file without extension

position - Position in second where the playing has to begin

volume - volume of the sound file (must be between 0.0 and 1.0)

pan - audio balance of the sound file (-1.0 : left / 1.0 : right)

loop - specify if the file must be played in loop

Throws:

CallError

java.lang.InterruptedException

loadSoundSet

public void loadSoundSet(java.lang.String setName)
                  throws CallError,
                         java.lang.InterruptedException

Load a sound set

Parameters:

setName - name of the set

Throws:

CallError

java.lang.InterruptedException

unloadSoundSet

public void unloadSoundSet(java.lang.String setName)
                    throws CallError,
                           java.lang.InterruptedException

Unload a sound set

Parameters:

setName - name of the set

Throws:

CallError

java.lang.InterruptedException

getSoundSetFileNames

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

Return the list of files contained in a sound set

Parameters:

setName - name of the set

Throws:

CallError

java.lang.InterruptedException

getLoadedSoundSetsList

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

Throws:

CallError

java.lang.InterruptedException

getInstalledSoundSetsList

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

Throws:

CallError

java.lang.InterruptedException

isSoundSetInstalled

public java.lang.Boolean isSoundSetInstalled(java.lang.String setName)
                                      throws CallError,
                                             java.lang.InterruptedException

Parameters:

setName - name of the set

Throws:

CallError

java.lang.InterruptedException

isSoundSetFileInstalled

public java.lang.Boolean isSoundSetFileInstalled(java.lang.String setName,
                                                 java.lang.String soundName)
                                          throws CallError,
                                                 java.lang.InterruptedException

Parameters:

setName - name of the set

soundName - name of the sound

Throws:

CallError

java.lang.InterruptedException

playFileInLoop

public void playFileInLoop(java.lang.String fileName)
                    throws CallError,
                           java.lang.InterruptedException

Plays a wav or mp3 file in loop

Parameters:

fileName - Path of the sound file

Throws:

CallError

java.lang.InterruptedException

playFileInLoop

public void playFileInLoop(java.lang.String fileName,
                           java.lang.Float volume,
                           java.lang.Float pan)
                    throws CallError,
                           java.lang.InterruptedException

Plays a wav or mp3 file in loop, with specific volume and audio balance

Parameters:

fileName - Path of the sound file

volume - volume of the sound file (must be between 0.0 and 1.0)

pan - audio balance of the sound file (-1.0 : left / 1.0 : right)

Throws:

CallError

java.lang.InterruptedException

playFileFromPosition

public void playFileFromPosition(java.lang.String fileName,
                                 java.lang.Float position)
                          throws CallError,
                                 java.lang.InterruptedException

Plays a wav or mp3 file from a given position in the file.

Parameters:

fileName - Name of the sound file

position - Position in second where the playing has to begin

Throws:

CallError

java.lang.InterruptedException

playFileFromPosition

public void playFileFromPosition(java.lang.String fileName,
                                 java.lang.Float position,
                                 java.lang.Float volume,
                                 java.lang.Float pan)
                          throws CallError,
                                 java.lang.InterruptedException

Plays a wav or mp3 file from a given position in the file, with specific volume and audio balance

Parameters:

fileName - Name of the sound file

position - Position in second where the playing has to begin

volume - volume of the sound file (must be between 0.0 and 1.0)

pan - audio balance of the sound file (-1.0 : left / 1.0 : right)

Throws:

CallError

java.lang.InterruptedException

goTo

public void goTo(java.lang.Integer playId,
                 java.lang.Float position)
          throws CallError,
                 java.lang.InterruptedException

Goes to a given position in a file which is playing.

Parameters:

playId - Id of the process which is playing the file

position - Position in the file (in second)

Throws:

CallError

java.lang.InterruptedException

stopAll

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

Stops all the files that are currently playing.

Throws:

CallError

java.lang.InterruptedException

pause

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

Pause a play back

Parameters:

id - Id of the process that is playing the file you want to put in pause

Throws:

CallError

java.lang.InterruptedException

setVolume

public void setVolume(java.lang.Integer id,
                      java.lang.Float volume)
               throws CallError,
                      java.lang.InterruptedException

Sets the volume of the player

Parameters:

id - Id of the process that is playing the file you want to put louder or less loud

volume - Volume - range 0.0 to 1.0

Throws:

CallError

java.lang.InterruptedException

setMasterVolume

public void setMasterVolume(java.lang.Float volume)
                     throws CallError,
                            java.lang.InterruptedException

Sets the master volume of the player

Parameters:

volume - Volume - range 0.0 to 1.0

Throws:

CallError

java.lang.InterruptedException

getVolume

public java.lang.Float getVolume(java.lang.Integer playId)
                          throws CallError,
                                 java.lang.InterruptedException

Returns the volume of the player

Parameters:

playId - Id of the process which is playing the file

Returns:

Volume of the player - range 0.0 to 1.0.

Throws:

CallError

java.lang.InterruptedException

getMasterVolume

public java.lang.Float getMasterVolume()
                                throws CallError,
                                       java.lang.InterruptedException

Returns the master volume of the player

Returns:

Volume of the master - range 0.0 to 1.0.

Throws:

CallError

java.lang.InterruptedException

setPanorama

public void setPanorama(java.lang.Float param1)
                 throws CallError,
                        java.lang.InterruptedException

sets the audio panorama : -1 for left speaker / 1 for right speaker

Throws:

CallError

java.lang.InterruptedException

loadFile

public java.lang.Integer loadFile(java.lang.String fileName)
                           throws CallError,
                                  java.lang.InterruptedException

Loads a file for ulterior playback

Parameters:

fileName - Path of the sound file (either mp3 or wav)

Returns:

Id of the file which has been loaded. This file can then be played with the play function

Throws:

CallError

java.lang.InterruptedException

unloadFile

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

unloads a file previously loaded with the loadFile function

Parameters:

id - Id returned by the loadFile function

Throws:

CallError

java.lang.InterruptedException

unloadAllFiles

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

unloads all the files already loaded.

Throws:

CallError

java.lang.InterruptedException

getLoadedFilesNames

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

returns an array containing the names of the currently loaded files

Returns:

Array containing the names of the files which has been loaded

Throws:

CallError

java.lang.InterruptedException

getLoadedFilesIds

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

returns an array containing the Ids of the currently loaded files

Returns:

Array containing the Ids of the files which has been loaded

Throws:

CallError

java.lang.InterruptedException

play

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

Starts the playback of a file preloaded with the loadFile function.

Parameters:

id - Id returned by the loadFile function

Throws:

CallError

java.lang.InterruptedException

play

public void play(java.lang.Integer id,
                 java.lang.Float volume,
                 java.lang.Float pan)
          throws CallError,
                 java.lang.InterruptedException

Starts the playback of a file preloaded with the loadFile function, with specific volume and audio balance

Parameters:

id - Id returned by the loadFile function

volume - volume of the sound file (must be between 0.0 and 1.0)

pan - audio balance of the sound file (-1.0 : left / 1.0 : right)

Throws:

CallError

java.lang.InterruptedException

playInLoop

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

Starts the playback in loop of a file preloaded with the loadFile function

Parameters:

id - Id returned by the loadFile function

Throws:

CallError

java.lang.InterruptedException

playInLoop

public void playInLoop(java.lang.Integer id,
                       java.lang.Float volume,
                       java.lang.Float pan)
                throws CallError,
                       java.lang.InterruptedException

Plays a wav or mp3 file in loop, with specific volume and audio balance

Parameters:

id - Id returned by the loadFile function

volume - volume of the sound file (must be between 0.0 and 1.0)

pan - audio balance of the sound file (-1.0 : left / 1.0 : right)

Throws:

CallError

java.lang.InterruptedException

playWebStream

public void playWebStream(java.lang.String streamName,
                          java.lang.Float param1,
                          java.lang.Float param2)
                   throws CallError,
                          java.lang.InterruptedException

Starts the playback of a wab audio stream

Parameters:

streamName - Path of the web audio stream

Throws:

CallError

java.lang.InterruptedException

getFileLength

public java.lang.Float getFileLength(java.lang.Integer playId)
                              throws CallError,
                                     java.lang.InterruptedException

Returns the length of the file played

Parameters:

playId - Id of the process which is playing the file

Returns:

Length of the file in seconds

Throws:

CallError

java.lang.InterruptedException

getCurrentPosition

public java.lang.Float getCurrentPosition(java.lang.Integer playId)
                                   throws CallError,
                                          java.lang.InterruptedException

Returns the position in the file which is currently played

Parameters:

playId - Id of the process which is playing the file

Returns:

Position in the file in seconds

Throws:

CallError

java.lang.InterruptedException

playSine

public void playSine(java.lang.Integer frequence,
                     java.lang.Integer gain,
                     java.lang.Integer pan,
                     java.lang.Float duration)
              throws CallError,
                     java.lang.InterruptedException

Play a sine wave which specified caracteristics.

Parameters:

frequence - Frequence in Hertz

gain - Volume Gain between 0 and 100

pan - Stereo Pan set to either {-1,0,+1}

duration - Duration of the sine wave in seconds

Throws:

CallError

java.lang.InterruptedException