diff --git a/engine/src/desktop/com/jme3/app/state/VideoRecorderAppState.java b/engine/src/desktop/com/jme3/app/state/VideoRecorderAppState.java index 7b7f35318..044709a17 100644 --- a/engine/src/desktop/com/jme3/app/state/VideoRecorderAppState.java +++ b/engine/src/desktop/com/jme3/app/state/VideoRecorderAppState.java @@ -24,7 +24,11 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * + * A Video recording AppState that records the screen output into an AVI file with + * M-JPEG content. The file should be playable on any OS in any video player.
+ * The video recording starts when the state is attached and stops when it is detached + * or the application is quit. You can set the fileName of the file to be written when the + * state is detached, else the old file will be overwritten. * @author normenhansen, Robert McIntyre */ public class VideoRecorderAppState extends AbstractAppState {