public class ALPhotoCapture extends ALProxy
Constructor and Description |
---|
ALPhotoCapture(Session session) |
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'
|
call, connect, connect, disconnect, getNaoqiType, getService, isProxyReady, setService
public ALPhotoCapture(Session session) throws java.lang.Exception
java.lang.Exception
public java.lang.String getPictureFormat() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.Boolean isHalfPressed() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.Boolean isHalfPressEnabled() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.Boolean isStatsEnabled() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public void clearStats() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.Boolean isTraceEnabled() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public void exit() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.String version() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.Boolean ping() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.util.List<java.lang.String> getMethodList() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.Object getMethodHelp(java.lang.String methodName) throws CallError, java.lang.InterruptedException
methodName
- The name of the method.CallError
java.lang.InterruptedException
public java.lang.Object getModuleHelp() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.Boolean wait(java.lang.Integer id, java.lang.Integer timeoutPeriod) throws CallError, java.lang.InterruptedException
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.CallError
java.lang.InterruptedException
public java.lang.Boolean isRunning(java.lang.Integer id) throws CallError, java.lang.InterruptedException
id
- The ID of the method that was returned when calling the method using 'post'CallError
java.lang.InterruptedException
public void stop(java.lang.Integer id) throws CallError, java.lang.InterruptedException
id
- the ID of the method to wait forCallError
java.lang.InterruptedException
public java.lang.String getBrokerName() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.String getUsage(java.lang.String name) throws CallError, java.lang.InterruptedException
name
- The name of the method.CallError
java.lang.InterruptedException
public void setHalfPressEnabled(java.lang.Boolean enable) throws CallError, java.lang.InterruptedException
enable
- True to enable, false to disable.CallError
java.lang.InterruptedException
public java.lang.Boolean halfPress() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.Object takePicture(java.lang.String folderPath, java.lang.String fileName) throws CallError, java.lang.InterruptedException
folderPath
- Folder where the picture is saved.fileName
- Filename used to save the picture.CallError
java.lang.InterruptedException
public java.lang.Object takePicture(java.lang.String folderPath, java.lang.String fileName, java.lang.Boolean overwrite) throws CallError, java.lang.InterruptedException
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.CallError
java.lang.InterruptedException
public java.lang.Object takePictures(java.lang.Integer numberOfPictures, java.lang.String folderPath, java.lang.String fileName) throws CallError, java.lang.InterruptedException
numberOfPictures
- Number of pictures to takefolderPath
- Folder where the pictures are saved.fileName
- Filename used to save the pictures.CallError
java.lang.InterruptedException
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
numberOfPictures
- Number of pictures to takefolderPath
- 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.CallError
java.lang.InterruptedException
public void setCameraID(java.lang.Integer cameraID) throws CallError, java.lang.InterruptedException
cameraID
- ID of the camera to use.CallError
java.lang.InterruptedException
public void setResolution(java.lang.Integer resolution) throws CallError, java.lang.InterruptedException
resolution
- New frame resolution.CallError
java.lang.InterruptedException
public void setColorSpace(java.lang.Integer colorSpace) throws CallError, java.lang.InterruptedException
colorSpace
- New color space.CallError
java.lang.InterruptedException
public void setCaptureInterval(java.lang.Integer captureInterval) throws CallError, java.lang.InterruptedException
captureInterval
- New delay (in ms) between two pictures.CallError
java.lang.InterruptedException
public void setPictureFormat(java.lang.String pictureFormat) throws CallError, java.lang.InterruptedException
pictureFormat
- New extension used to save pictures.CallError
java.lang.InterruptedException
public java.lang.Integer getCameraID() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.Integer getResolution() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.Integer getColorSpace() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
Aldebaran SDK for Java
Copyright 2006-2015 Aldebaran Robotics. All Rights Reserved.