Class CamcorderModule

java.lang.Object

gaiasky.script.v2.impl.APIModule

gaiasky.script.v2.impl.CamcorderModule

All Implemented Interfaces:

CamcorderAPI

public class CamcorderModule
extends APIModule
implements CamcorderAPI

The camcorder module contains methods and calls related to the camera path subsystem and the camcorder, which enables capturing and playing back camera path files.

Field Summary

Fields inherited from class APIModule

api, em, logger, me, name

Modifier and Type	Field	Description
protected final APIv2	api	Reference to API object.
protected final EventManager	em	Reference to event manager.
protected final Logger.Log	logger
protected final APIModule	me	Reference to self.
protected final String	name	Module name.

Constructor Summary

Constructors

Constructor	Description
CamcorderModule(EventManager em, APIv2 api, String name)	Create a new module with the given attributes.

Method Summary

Modifier and Type	Method	Description
double	get_fps()	Get the current frame rate setting of the camcorder.
void	play(String path)	Play a .gsc camera path file and returns immediately.
void	play(String path, boolean sync)	Runs a .gsc camera path file and returns immediately.
void	set_fps(double fps)	Set the target frame rate of the camcorder.
void	start()	Start recording the camera path to an auto-generated file in the default camera directory (BaseModule.get_camcorder_dir()).
void	start(String path)	Start recording a camera path with the given filename.
void	stop()	Stop the current camera recording.

Methods inherited from class APIModule

dispose

Modifier and Type	Method	Description
void	dispose()	Method called whenever the module is disposed.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CamcorderModule

public CamcorderModule(EventManager em,
 APIv2 api,
 String name)

Create a new module with the given attributes.

Parameters:

api - Reference to the API class.

name - Name of the module.

Method Details

set_fps

public void set_fps(double fps)

Description copied from interface: CamcorderAPI

Set the target frame rate of the camcorder. This artificially sets the frame rate (inverse of frame time) of Gaia Sky to this value while the camera is recording and playing. Make sure to use the right FPS setting during playback.

Specified by:

set_fps in interface CamcorderAPI

Parameters:

fps - The target frame rate for the camcorder.

get_fps

public double get_fps()

Description copied from interface: CamcorderAPI

Get the current frame rate setting of the camcorder.

Specified by:

get_fps in interface CamcorderAPI

Returns:

The frame rate setting of the camcorder.

start

public void start()

Description copied from interface: CamcorderAPI

Start recording the camera path to an auto-generated file in the default camera directory (BaseModule.get_camcorder_dir()). This command has no effect if the camera is already being recorded.

Specified by:

start in interface CamcorderAPI

start

public void start(String path)

Description copied from interface: CamcorderAPI

Start recording a camera path with the given filename. The filename is without extension or path. The final path with the camera file, after invoking CamcorderAPI.stop(), is:

BaseModule.get_camcorder_dir() + "/" + filename + ".gsc"

This command has no effect if the camera is already being recorded.

Specified by:

start in interface CamcorderAPI

Parameters:

path - Path to the camera file to play.

stop

public void stop()

Description copied from interface: CamcorderAPI

Stop the current camera recording. This command has no effect if the camera was not being recorded.

Specified by:

stop in interface CamcorderAPI

play

public void play(String path,
 boolean sync)

Description copied from interface: CamcorderAPI

Runs a .gsc camera path file and returns immediately. This function accepts a boolean indicating whether to wait for the camera path file to finish or not.

Specified by:

play in interface CamcorderAPI

Parameters:

path - The path to the camera file. Path is relative to the application's root directory or absolute.

sync - If true, the call is synchronous and waits for the camera file to finish. Otherwise, it returns immediately.

play

public void play(String path)

Description copied from interface: CamcorderAPI

Play a .gsc camera path file and returns immediately. This method does not wait for the camera path file to finish playing.

Specified by:

play in interface CamcorderAPI

Parameters:

path - The path to the camera file. Path is relative to the application's root directory or absolute.