com.aldebaran.qi.helper.proxies

Class ALVideoRecorder

java.lang.Object

com.aldebaran.qi.helper.ALProxy

com.aldebaran.qi.helper.proxies.ALVideoRecorder

public class ALVideoRecorder
extends ALProxy

This module provides methods to record videos and store them on disk.

See Also:

NAOqi APIs for ALVideoRecorder

Field Summary

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

name, service

Constructor Summary

Constructors

Constructor and Description
ALVideoRecorder(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	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'

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

ALVideoRecorder

public ALVideoRecorder(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

startRecording

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

Starts recording a video. Please note that only one record at a time can be made.

Parameters:

folderPath - Folder where the video is saved.

fileName - Filename used to save the video.

Throws:

CallError

java.lang.InterruptedException

startRecording

public void startRecording(java.lang.String folderPath,
                           java.lang.String fileName,
                           java.lang.Boolean overwrite)
                    throws CallError,
                           java.lang.InterruptedException

Starts recording a video. Please note that only one record at a time can be made.

Parameters:

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.

Throws:

CallError

java.lang.InterruptedException

stopRecording

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

Stops a video record that was launched with startRecording(). The function returns the number of frames that were recorded, as well as the video absolute file name.

Returns:

Array of two elements [numRecordedFrames, recordAbsolutePath]

Throws:

CallError

java.lang.InterruptedException

isRecording

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

Are we currently recording a video

Returns:

True/False

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

setFrameRate

public void setFrameRate(java.lang.Float frameRate)
                  throws CallError,
                         java.lang.InterruptedException

Sets frame rate.

Parameters:

frameRate - New frame rate.

Throws:

CallError

java.lang.InterruptedException

setVideoFormat

public void setVideoFormat(java.lang.String videoFormat)
                    throws CallError,
                           java.lang.InterruptedException

Sets video format.

Parameters:

videoFormat - New video format.

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 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

getFrameRate

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

Returns current frame rate.

Returns:

Current frame rate.

Throws:

CallError

java.lang.InterruptedException

getVideoFormat

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

Returns current video format.

Returns:

Current video format.

Throws:

CallError

java.lang.InterruptedException