VideoExport (Javadocs: VideoExport)

java.lang.Object
- com.hamoid.VideoExport

public class VideoExport
extends java.lang.Object

+Example

import com.hamoid.*;

VideoExport videoExport;

// Press 'q' to finish saving the movie and exit.

// In some systems, if you close your sketch by pressing ESC, 
// by closing the window, or by pressing STOP, the resulting 
// movie might be corrupted. If that happens to you, use
// videoExport.endMovie() like you see in this example.

// In other systems pressing ESC produces correct movies
// and .endMovie() is not necessary.

void setup() {
  size(600, 600);

  videoExport = new VideoExport(this);
  videoExport.startMovie();
}
void draw() {
  background(#224488);
  rect(frameCount * frameCount % width, 0, 40, height);

  videoExport.saveFrame();
}
void keyPressed() {
  if (key == 'q') {
    videoExport.endMovie();
    exit();
  }
}

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String VERSION

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`VERSION`

Constructor Summary

Constructors
Constructor and Description
`VideoExport(PApplet parent)` Constructor, usually called in the setup() method in your sketch to initialize and start the library.
`VideoExport(PApplet parent, java.lang.String outputFileName)` Constructor that allows specifying a movie file name.
`VideoExport(PApplet parent, java.lang.String outputFileName, PImage img)` Constructor that allows to set a PImage to export as video (advanced)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`dispose()` Called automatically by Processing to clean up before shut down
`void`	`endMovie()` Called to end exporting a movie before exiting our program, or before exporting a new movie.
`void`	`forgetFfmpegPath()` Makes the library forget about where the ffmpeg binary was located.
`int`	`getCurrentFrame()` Call this function to figure out how many frames your movie has so far.
`float`	`getCurrentTime()` You could use the returned value to display a time counter, a progress bar or to create periodic motion, for instance by feeding the returned value into the sin() function, and using the result to drive the position of an object.
`java.lang.String`	`getFfmpegPath()` Call this if you need to figure out the path to the ffmpeg program (advanced).
`void`	`onFfmpegSelected(java.io.File selection)` Called internally by the file selector when the user chooses the location of ffmpeg on the disk.
`void`	`saveFrame()` Adds one frame to the video file.
`void`	`setAudioFileName(java.lang.String audioFileName)`
`void`	`setDebugging(boolean saveDebugFile)` Call this method to specify if you want a debug text file saved together with the video file.
`void`	`setFfmpegAudioSettings(java.lang.String[] newSettings)` Advanced.
`void`	`setFfmpegPath(java.lang.String path)` Call this method if you know the path to ffmpeg on your computer (advanced).
`void`	`setFfmpegVideoSettings(java.lang.String[] newSettings)` Advanced.
`void`	`setFrameRate(float frameRate)` Set the frame rate of the produced video file.
`void`	`setGraphics(PImage img)` Set the PImage element.
`void`	`setLoadPixels(boolean doLoadPixels)` You can tell VideoExport not to call loadPixels() internally.
`void`	`setMovieFileName(java.lang.String newMovieFileName)` Allow setting a new movie name, in case we want to export several movies, one after the other.
`void`	`setQuality(int crf, int audioBitRate)` Set the quality of the produced video file.
`void`	`startMovie()`
`static java.lang.String`	`version()` Return the version of the library.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - VERSION
```
public static final java.lang.String VERSION
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - VideoExport
```
public VideoExport(PApplet parent)
```
    Constructor, usually called in the setup() method in your sketch to initialize and start the library.
    Using a default movie file name (processing-movie.mp4).
    
    Parameters:
    
    parent - Pass "this" when constructing a VideoExport instance
  - VideoExport
```
public VideoExport(PApplet parent,
                   java.lang.String outputFileName)
```
    Constructor that allows specifying a movie file name.
    Parameters:
    
    parent - Parent PApplet, normally "this" when called from setup()
    
    outputFileName - The name of the video file to produce, for instance "beauty.mp4"
    +Example
    import com.hamoid.*; VideoExport videoExport; // Press 'q' to finish saving the movie and exit. // In some systems, if you close your sketch by pressing ESC, // by closing the window, or by pressing STOP, the resulting // movie might be corrupted. If that happens to you, use // videoExport.endMovie() like you see in this example. // In other systems pressing ESC produces correct movies // and .endMovie() is not necessary. void setup() { size(600, 600); videoExport = new VideoExport(this); videoExport.startMovie(); } void draw() { background(#224488); rect(frameCount * frameCount % width, 0, 40, height); videoExport.saveFrame(); } void keyPressed() { if (key == 'q') { videoExport.endMovie(); exit(); } }
  - VideoExport
```
public VideoExport(PApplet parent,
                   java.lang.String outputFileName,
                   PImage img)
```
    Constructor that allows to set a PImage to export as video (advanced)
    Parameters:
    
    parent - Parent PApplet, normally "this" when called from setup()
    
    outputFileName - The name of the video file to produce, for instance "beauty.mp4"
    
    img - PImage object to export as video (can be a PGraphics, Movie, Capture...)
    +Example
    import com.hamoid.*; VideoExport videoExport; PGraphics pg; void setup() { size(600, 600); pg = createGraphics(640, 480); videoExport = new VideoExport(this, "pgraphics.mp4", pg); videoExport.startMovie(); } void draw() { background(0); text("exporting video " + frameCount, 50, 50); pg.beginDraw(); pg.background(#224488); pg.rect(pg.width * noise(frameCount * 0.01), 0, 40, pg.height); pg.endDraw(); videoExport.saveFrame(); } void keyPressed() { if (key == 'q') { videoExport.endMovie(); exit(); } }
- Method Detail
  - version
```
public static java.lang.String version()
```
    Return the version of the library.
    
    Returns:
    
    String
  - setMovieFileName
```
public void setMovieFileName(java.lang.String newMovieFileName)
```
    Allow setting a new movie name, in case we want to export several movies, one after the other.
    
    Parameters:
    
    newMovieFileName - String with file name of the new movie to create
  - setAudioFileName
```
public void setAudioFileName(java.lang.String audioFileName)
```
  - setGraphics
```
public void setGraphics(PImage img)
```
    Set the PImage element. Advanced use only. Optional.
    
    Parameters:
    
    img - A PImage object. Probably used for off-screen exporting..
  - setQuality
```
public void setQuality(int crf,
                       int audioBitRate)
```
    Set the quality of the produced video file. Optional.
    
    Parameters:
    
    crf - Video quality. A value between 0 (high compression) and 100 (high quality, lossless). Default is 70.
    
    audioBitRate - Audio quality (bit rate in kbps). 128 is the default. 192 is very good. More than 256 does not make sense. Higher numbers produce heavier files.
  - setFrameRate
```
public void setFrameRate(float frameRate)
```
    Set the frame rate of the produced video file. Optional.
    
    Parameters:
    
    frameRate - The frame rate at which the resulting video file should be played. The default is 30, which is the recommended for online video.
  - setLoadPixels
```
public void setLoadPixels(boolean doLoadPixels)
```
    You can tell VideoExport not to call loadPixels() internally. Use it only if you already call loadPixels() in your program. Useful to avoid calling it twice, which might hurt the performance a bit. Optional.
    
    Parameters:
    
    doLoadPixels - Set to false to disable the internal loadPixels() call.
  - setDebugging
```
public void setDebugging(boolean saveDebugFile)
```
    Call this method to specify if you want a debug text file saved together with the video file. The text file normally contains the output messages from ffmpeg, which may be useful for diagnosing problems. If video is being exported correctly you may want to call videoExport.setDebugging(false) to avoid creating unnecessary files. Optional.
    
    Parameters:
    
    saveDebugFile - Set to false to disable saving the ffmpeg output in a text file
  - setFfmpegVideoSettings
```
public void setFfmpegVideoSettings(java.lang.String[] newSettings)
```
    Advanced. You can use this if you want to change how ffmpeg behaves, for example to add filters, custom encodings, or anything else you could do with ffmpeg in the command line. See https://forum.processing.org/two/discussion/22139/video-export-library-0-1-9 To find the default values find CMD_ENCODE_VIDEO_DEFAULT in https://github.com/hamoid/video_export_processing/blob/master/src/com/hamoid/VideoExport.java
    
    Parameters:
    
    newSettings - An array with all the command line arguments to call to produce a video.
  - setFfmpegAudioSettings
```
public void setFfmpegAudioSettings(java.lang.String[] newSettings)
```
    Advanced. You can use this if you want to change how ffmpeg behaves, for example to add filters, custom encodings, or anything else you could do with ffmpeg in the command line. See https://forum.processing.org/two/discussion/22139/video-export-library-0-1-9 To find the default values find CMD_ENCODE_AUDIO_DEFAULT in https://github.com/hamoid/video_export_processing/blob/master/src/com/hamoid/VideoExport.java
    
    Parameters:
    
    newSettings - An array with all the command line arguments to call to produce a video.
  - saveFrame
```
public void saveFrame()
```
    Adds one frame to the video file. The frame will be the content of the display, or the content of a PImage if you specified one in the constructor.
  - getCurrentFrame
```
public int getCurrentFrame()
```
    Call this function to figure out how many frames your movie has so far.
    
    Returns:
    
    the number of frames added to the movie so far
  - getCurrentTime
```
public float getCurrentTime()
```
    You could use the returned value to display a time counter, a progress bar or to create periodic motion, for instance by feeding the returned value into the sin() function, and using the result to drive the position of an object.
    
    Returns:
    
    the duration of the movie (so far) in seconds
  - getFfmpegPath
```
public java.lang.String getFfmpegPath()
```
    Call this if you need to figure out the path to the ffmpeg program (advanced).
    
    Returns:
    
    the path to the ffmpeg program as a String
  - setFfmpegPath
```
public void setFfmpegPath(java.lang.String path)
```
    Call this method if you know the path to ffmpeg on your computer (advanced).
    
    Parameters:
    
    path -
  - forgetFfmpegPath
```
public void forgetFfmpegPath()
```
    Makes the library forget about where the ffmpeg binary was located. Useful if you moved ffmpeg to a different location. After calling this function the library will ask you again for the location of ffmpeg. Optional.
  - onFfmpegSelected
```
public void onFfmpegSelected(java.io.File selection)
```
    Called internally by the file selector when the user chooses the location of ffmpeg on the disk.
    
    Parameters:
    
    selection - (internal)
  - startMovie
```
public void startMovie()
```
  - endMovie
```
public void endMovie()
```
    Called to end exporting a movie before exiting our program, or before exporting a new movie.
  - dispose
```
public void dispose()
```
    Called automatically by Processing to clean up before shut down

Class VideoExport

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VERSION

Constructor Detail

VideoExport

VideoExport

VideoExport

Method Detail

version

setMovieFileName

setAudioFileName

setGraphics

setQuality

setFrameRate

setLoadPixels

setDebugging

setFfmpegVideoSettings

setFfmpegAudioSettings

saveFrame

getCurrentFrame

getCurrentTime

getFfmpegPath

setFfmpegPath

forgetFfmpegPath

onFfmpegSelected

startMovie

endMovie

dispose