annotate src/com/aurellem/capture/video/VideoRecorder.java @ 51:6a1b28f060e6

interface documentation
author Robert McIntyre <rlm@mit.edu>
date Sat, 03 Dec 2011 13:42:30 -0600
parents 784a3f4e6202
children 3dc1f15e1e13
rev   line source
rlm@39 1 package com.aurellem.capture.video;
rlm@39 2
rlm@39 3 import java.awt.image.BufferedImage;
rlm@39 4
rlm@39 5 public interface VideoRecorder{
rlm@39 6
rlm@39 7 /**
rlm@39 8 * Write this image to video, disk, etc.
rlm@39 9 * @param image the image to write
rlm@39 10 */
rlm@39 11 void record(BufferedImage image);
rlm@39 12
rlm@39 13 /**
rlm@39 14 * stop recording temporarally. The recording can be started again
rlm@39 15 * with start()
rlm@39 16 */
rlm@39 17 void pause();
rlm@39 18
rlm@39 19 /**
rlm@39 20 * start the recording.
rlm@39 21 */
rlm@39 22 void start();
rlm@39 23
rlm@39 24 /**
rlm@39 25 * closes the video file, writing appropriate headers, trailers, etc.
rlm@39 26 * After this is called, no more recording can be done.
rlm@39 27 */
rlm@39 28 void finish();
rlm@39 29 }