com.aldebaran.qi.helper.proxies

Class ALPhotoCapture

java.lang.Object

com.aldebaran.qi.helper.ALProxy

com.aldebaran.qi.helper.proxies.ALPhotoCapture

public class ALPhotoCapture
extends ALProxy

This module provides methods to take pictures and store them on disk.

See Also:

NAOqi APIs for ALPhotoCapture

Field Summary

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

name, service

Constructor Summary

Constructors

Constructor and Description
ALPhotoCapture(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.Integer	getCameraID() Returns current camera ID.
java.lang.Integer	getCaptureInterval() Returns current delay between captures.
java.lang.Integer	getColorSpace() Returns current color space.
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	getPictureFormat() Returns current picture format.
java.lang.Integer	getResolution() Returns current resolution.
java.lang.String	getUsage(java.lang.String name) Gets the method usage string.
java.lang.Boolean	halfPress() Manually (un)subscribes to ALVideoDevice.
java.lang.Boolean	isHalfPressed() Returns True if the "half press" mode is on.
java.lang.Boolean	isHalfPressEnabled() Returns True if the "half press" mode is on.
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	setCameraID(java.lang.Integer cameraID) Sets camera ID.
void	setCaptureInterval(java.lang.Integer captureInterval) Sets delay between two captures.
void	setColorSpace(java.lang.Integer colorSpace) Sets color space.
void	setHalfPressEnabled(java.lang.Boolean enable) Enables or disables the half-press mode.
void	setPictureFormat(java.lang.String pictureFormat) Sets picture extension.
void	setResolution(java.lang.Integer resolution) Sets resolution.
void	stop(java.lang.Integer id) returns true if the method is currently running
java.lang.Object	takePicture(java.lang.String folderPath, java.lang.String fileName) Takes one picture.
java.lang.Object	takePicture(java.lang.String folderPath, java.lang.String fileName, java.lang.Boolean overwrite) Takes one picture.
java.lang.Object	takePictures(java.lang.Integer numberOfPictures, java.lang.String folderPath, java.lang.String fileName) Takes several pictures as quickly as possible
java.lang.Object	takePictures(java.lang.Integer numberOfPictures, java.lang.String folderPath, java.lang.String fileName, java.lang.Boolean overwrite) Takes several pictures as quickly as possible
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

ALPhotoCapture

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

Throws:

java.lang.Exception

Method Detail

getPictureFormat

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

Returns current picture format.

Returns:

Current picture format.

Throws:

CallError

java.lang.InterruptedException

isHalfPressed

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

Returns True if the "half press" mode is on.

Returns:

True or False.

Throws:

CallError

java.lang.InterruptedException

isHalfPressEnabled

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

Returns True if the "half press" mode is on.

Returns:

True or False.

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

setHalfPressEnabled

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

Enables or disables the half-press mode.

Parameters:

enable - True to enable, false to disable.

Throws:

CallError

java.lang.InterruptedException

halfPress

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

Manually (un)subscribes to ALVideoDevice.

Returns:

True if eveything went well, False otherwise.

Throws:

CallError

java.lang.InterruptedException

takePicture

public java.lang.Object takePicture(java.lang.String folderPath,
                                    java.lang.String fileName)
                             throws CallError,
                                    java.lang.InterruptedException

Takes one picture.

Parameters:

folderPath - Folder where the picture is saved.

fileName - Filename used to save the picture.

Returns:

Full file name of the picture saved on the disk: [filename]

Throws:

CallError

java.lang.InterruptedException

takePicture

public java.lang.Object takePicture(java.lang.String folderPath,
                                    java.lang.String fileName,
                                    java.lang.Boolean overwrite)
                             throws CallError,
                                    java.lang.InterruptedException

Takes one picture.

Parameters:

folderPath - Folder where the picture is saved.

fileName - Filename used to save the picture.

overwrite - If false and the filename already exists, an error is thrown.

Returns:

Full file name of the picture saved on the disk: [filename]

Throws:

CallError

java.lang.InterruptedException

takePictures

public java.lang.Object takePictures(java.lang.Integer numberOfPictures,
                                     java.lang.String folderPath,
                                     java.lang.String fileName)
                              throws CallError,
                                     java.lang.InterruptedException

Takes several pictures as quickly as possible

Parameters:

numberOfPictures - Number of pictures to take

folderPath - Folder where the pictures are saved.

fileName - Filename used to save the pictures.

Returns:

List of all saved files: [[filename1, filename2...]]

Throws:

CallError

java.lang.InterruptedException

takePictures

public java.lang.Object takePictures(java.lang.Integer numberOfPictures,
                                     java.lang.String folderPath,
                                     java.lang.String fileName,
                                     java.lang.Boolean overwrite)
                              throws CallError,
                                     java.lang.InterruptedException

Takes several pictures as quickly as possible

Parameters:

numberOfPictures - Number of pictures to take

folderPath - Folder where the pictures are saved.

fileName - Filename used to save the pictures.

overwrite - If false and the filename already exists, an error is thrown.

Returns:

List of all saved files: [[filename1, filename2...]]

Throws:

CallError

java.lang.InterruptedException

setCameraID

public void setCameraID(java.lang.Integer cameraID)
                 throws CallError,
                        java.lang.InterruptedException

Sets camera ID.

Parameters:

cameraID - ID of the camera to use.

Throws:

CallError

java.lang.InterruptedException

setResolution

public void setResolution(java.lang.Integer resolution)
                   throws CallError,
                          java.lang.InterruptedException

Sets resolution.

Parameters:

resolution - New frame resolution.

Throws:

CallError

java.lang.InterruptedException

setColorSpace

public void setColorSpace(java.lang.Integer colorSpace)
                   throws CallError,
                          java.lang.InterruptedException

Sets color space.

Parameters:

colorSpace - New color space.

Throws:

CallError

java.lang.InterruptedException

setCaptureInterval

public void setCaptureInterval(java.lang.Integer captureInterval)
                        throws CallError,
                               java.lang.InterruptedException

Sets delay between two captures.

Parameters:

captureInterval - New delay (in ms) between two pictures.

Throws:

CallError

java.lang.InterruptedException

setPictureFormat

public void setPictureFormat(java.lang.String pictureFormat)
                      throws CallError,
                             java.lang.InterruptedException

Sets picture extension.

Parameters:

pictureFormat - New extension used to save pictures.

Throws:

CallError

java.lang.InterruptedException

getCameraID

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

Returns current camera ID.

Returns:

Current camera ID.

Throws:

CallError

java.lang.InterruptedException

getResolution

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

Returns current resolution.

Returns:

Current frame resolution.

Throws:

CallError

java.lang.InterruptedException

getColorSpace

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

Returns current color space.

Returns:

Current color space.

Throws:

CallError

java.lang.InterruptedException

getCaptureInterval

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

Returns current delay between captures.

Returns:

Current delay (in ms) between two pictures.

Throws:

CallError

java.lang.InterruptedException