Interface CamcorderAPI

All Known Implementing Classes:
CamcorderModule
public interface CamcorderAPI
Public API definition for the camcorder module, CamcorderModule.

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

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

  • Method Details

    • set_fps

      void set_fps(double fps)
      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.
      Parameters:
      fps - The target frame rate for the camcorder.

    • get_fps

      double get_fps()
      Get the current frame rate setting of the camcorder.
      Returns:
      The frame rate setting of the camcorder.

    • start

      void start()
      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.

    • start

      void start(String path)
      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 stop(), is:

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

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

      Parameters:
      path - Path to the camera file to play.

    • stop

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

    • play

      void play(String path)
      Play a .gsc camera path file and returns immediately. This method does not wait for the camera path file to finish playing.
      Parameters:
      path - The path to the camera file. Path is relative to the application's root directory or absolute.

    • play

      void play(String path, boolean sync)
      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.
      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.