public class ALVideoRecorder extends ALProxy
Constructor and Description |
---|
ALVideoRecorder(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 |
getColorSpace()
Returns current color space.
|
java.lang.Integer |
getFrameRate()
Returns current frame rate.
|
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.Integer |
getResolution()
Returns current resolution.
|
java.lang.String |
getUsage(java.lang.String name)
Gets the method usage string.
|
java.lang.String |
getVideoFormat()
Returns current video format.
|
java.lang.Boolean |
isRecording()
Are we currently recording a video
|
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 |
setColorSpace(java.lang.Integer colorSpace)
Sets color space.
|
void |
setFrameRate(java.lang.Float frameRate)
Sets frame rate.
|
void |
setResolution(java.lang.Integer resolution)
Sets resolution.
|
void |
setVideoFormat(java.lang.String videoFormat)
Sets video format.
|
void |
startRecording(java.lang.String folderPath,
java.lang.String fileName)
Starts recording a video.
|
void |
startRecording(java.lang.String folderPath,
java.lang.String fileName,
java.lang.Boolean overwrite)
Starts recording a video.
|
void |
stop(java.lang.Integer id)
returns true if the method is currently running
|
java.lang.Object |
stopRecording()
Stops a video record that was launched with startRecording().
|
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 ALVideoRecorder(Session session) throws java.lang.Exception
java.lang.Exception
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 startRecording(java.lang.String folderPath, java.lang.String fileName) throws CallError, java.lang.InterruptedException
folderPath
- Folder where the video is saved.fileName
- Filename used to save the video.CallError
java.lang.InterruptedException
public void startRecording(java.lang.String folderPath, java.lang.String fileName, java.lang.Boolean overwrite) throws CallError, java.lang.InterruptedException
folderPath
- Folder where the video is saved.fileName
- Filename used to save the video.overwrite
- If false and the filename already exists, an exception is thrown.CallError
java.lang.InterruptedException
public java.lang.Object stopRecording() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.Boolean isRecording() throws CallError, java.lang.InterruptedException
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 setFrameRate(java.lang.Float frameRate) throws CallError, java.lang.InterruptedException
frameRate
- New frame rate.CallError
java.lang.InterruptedException
public void setVideoFormat(java.lang.String videoFormat) throws CallError, java.lang.InterruptedException
videoFormat
- New video format.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
public java.lang.Integer getFrameRate() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
Aldebaran SDK for Java
Copyright 2006-2015 Aldebaran Robotics. All Rights Reserved.