Movie (Processing video library 3.0.2 API)

java.lang.Object
- processing.core.PImage
- - processing.video.Movie

All Implemented Interfaces:

Cloneable, processing.core.PConstants
```
public class Movie
extends processing.core.PImage
implements processing.core.PConstants
```
( begin auto-generated from Movie.xml ) Datatype for storing and playing movies in Apple's QuickTime format. Movies must be located in the sketch's data directory or an accessible place on the network to load without an error. ( end auto-generated )

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`available`
`protected Object`	`bufferSink`
`protected int`	`bufHeight`
`protected int`	`bufWidth`
`protected String`	`copyMask`
`protected int[]`	`copyPixels`
`protected Object`	`eventHandler`
`String`	`filename`
`protected boolean`	`firstFrame`
`float`	`frameRate`
`protected Method`	`movieEventMethod`
`protected org.gstreamer.Buffer`	`natBuffer`
`protected org.gstreamer.elements.BufferDataAppSink`	`natSink`
`protected boolean`	`newFrame`
`protected boolean`	`outdatedPixels`
`protected boolean`	`paused`
`org.gstreamer.elements.PlayBin2`	`playbin`
`protected boolean`	`playing`
`protected float`	`rate`
`protected boolean`	`repeat`
`protected org.gstreamer.elements.RGBDataAppSink`	`rgbSink`
`protected boolean`	`seeking`
`protected Method`	`sinkCopyMethod`
`protected Method`	`sinkDisposeMethod`
`protected Method`	`sinkGetMethod`
`protected boolean`	`sinkReady`
`protected Method`	`sinkSetMethod`
`static String[]`	`supportedProtocols`
`protected boolean`	`useBufferSink`
`protected float`	`volume`

Fields inherited from class processing.core.PImage
ALPHA_MASK, BLUE_MASK, format, GREEN_MASK, height, loaded, modified, mx1, mx2, my1, my2, parent, pixelDensity, pixelHeight, pixels, pixelWidth, RED_MASK, saveImageFormats, width

Fields inherited from interface processing.core.PConstants
ADD, ALPHA, ALT, AMBIENT, ARC, ARGB, ARROW, BACKSPACE, BASELINE, BEVEL, BEZIER_VERTEX, BLEND, BLUR, BOTTOM, BOX, BREAK, BURN, CENTER, CHATTER, CHORD, CLAMP, CLOSE, CODED, COMPLAINT, CONTROL, CORNER, CORNERS, CROSS, CURVE_VERTEX, CUSTOM, DARKEST, DEG_TO_RAD, DELETE, DIAMETER, DIFFERENCE, DILATE, DIRECTIONAL, DISABLE_ASYNC_SAVEFRAME, DISABLE_BUFFER_READING, DISABLE_DEPTH_MASK, DISABLE_DEPTH_SORT, DISABLE_DEPTH_TEST, DISABLE_KEY_REPEAT, DISABLE_NATIVE_FONTS, DISABLE_OPENGL_ERRORS, DISABLE_OPTIMIZED_STROKE, DISABLE_STROKE_PERSPECTIVE, DISABLE_STROKE_PURE, DISABLE_TEXTURE_MIPMAPS, DODGE, DOWN, DXF, ELLIPSE, ENABLE_ASYNC_SAVEFRAME, ENABLE_BUFFER_READING, ENABLE_DEPTH_MASK, ENABLE_DEPTH_SORT, ENABLE_DEPTH_TEST, ENABLE_KEY_REPEAT, ENABLE_NATIVE_FONTS, ENABLE_OPENGL_ERRORS, ENABLE_OPTIMIZED_STROKE, ENABLE_STROKE_PERSPECTIVE, ENABLE_STROKE_PURE, ENABLE_TEXTURE_MIPMAPS, ENTER, EPSILON, ERODE, ESC, EXCLUSION, FX2D, GIF, GRAY, GROUP, HALF_PI, HAND, HARD_LIGHT, HINT_COUNT, HSB, IMAGE, INVERT, JAVA2D, JPEG, LANDSCAPE, LEFT, LIGHTEST, LINE, LINE_LOOP, LINE_STRIP, LINES, LINUX, MACOSX, MAX_FLOAT, MAX_INT, MIN_FLOAT, MIN_INT, MITER, MODEL, MODELVIEW, MOVE, MULTIPLY, NORMAL, OPAQUE, OPEN, OPENGL, ORTHOGRAPHIC, OTHER, OVERLAY, P2D, P3D, PATH, PDF, PERSPECTIVE, PI, PIE, platformNames, POINT, POINTS, POLYGON, PORTRAIT, POSTERIZE, PROBLEM, PROJECT, PROJECTION, QUAD, QUAD_BEZIER_VERTEX, QUAD_STRIP, QUADRATIC_VERTEX, QUADS, QUARTER_PI, RAD_TO_DEG, RADIUS, RECT, REPEAT, REPLACE, RETURN, RGB, RIGHT, ROUND, SCREEN, SHAPE, SHIFT, SOFT_LIGHT, SPAN, SPHERE, SPOT, SQUARE, SUBTRACT, SVG, TAB, TARGA, TAU, TEXT, THIRD_PI, THRESHOLD, TIFF, TOP, TRIANGLE, TRIANGLE_FAN, TRIANGLE_STRIP, TRIANGLES, TWO_PI, UP, VERTEX, WAIT, WHITESPACE, WINDOWS, X, Y, Z

Constructor Summary

Constructors
Constructor and Description

Movie(processing.core.PApplet parent, String filename)
Creates an instance of GSMovie loading the movie from filename.

Constructors
Constructor and Description
`Movie(processing.core.PApplet parent, String filename)` Creates an instance of GSMovie loading the movie from filename.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`available()` ( begin auto-generated from Movie_available.xml ) Returns "true" when a new movie frame is available to read.
`void`	`dispose()` Disposes all the native resources associated to this movie.
`void`	`disposeBuffer(Object buf)` NOTE: This is not official API and may/will be removed at any time.
`float`	`duration()` ( begin auto-generated from Movie_duration.xml ) Returns the length of the movie in seconds.
`protected void`	`eosEvent()`
`protected void`	`finalize()` Finalizer of the class.
`void`	`frameRate(float ifps)` ( begin auto-generated from Movie_frameRate.xml ) Sets how often frames are read from the movie.
`int`	`get(int x, int y)`
`protected void`	`getImpl(int sourceX, int sourceY, int sourceWidth, int sourceHeight, processing.core.PImage target, int targetX, int targetY)`
`protected void`	`getSinkMethods()`
`protected float`	`getSourceFrameRate()` Get the original framerate of the source video.
`protected int`	`getSourceHeight()` Get the height of the source video.
`protected int`	`getSourceWidth()` Get the width of the source video.
`boolean`	`hasBufferSink()` NOTE: This is not official API and may/will be removed at any time.
`protected void`	`initCopyMask()`
`protected void`	`initGStreamer(processing.core.PApplet parent, String filename)`
`protected void`	`initSink()`
`protected void`	`invokeEvent(int w, int h, org.gstreamer.Buffer buffer)`
`protected void`	`invokeEvent(int w, int h, IntBuffer buffer)`
`void`	`jump(float where)` ( begin auto-generated from Movie_jump.xml ) Jumps to a specific location within a movie.
`void`	`loadPixels()`
`void`	`loop()` ( begin auto-generated from Movie_loop.xml ) Plays a movie continuously, restarting it when it's over.
`void`	`noLoop()` ( begin auto-generated from Movie_noLoop.xml ) If a movie is looping, calling noLoop() will cause it to play until the end and then stop on the last frame.
`void`	`pause()` ( begin auto-generated from Movie_pause.xml ) Pauses a movie during playback.
`void`	`play()` ( begin auto-generated from Movie_play.xml ) Plays a movie one time and stops at the last frame.
`void`	`post()`
`void`	`read()` ( begin auto-generated from Movie_read.xml ) Reads the current frame of the movie.
`void`	`setBufferSink(Object sink)` Sets the object to use as destination for the frames read from the stream.
`void`	`setBufferSink(Object sink, String mask)` Sets the object to use as destination for the frames read from the stream.
`protected void`	`setEventHandlerObject(Object obj)` Uses a generic object as handler of the movie.
`void`	`speed(float irate)` ( begin auto-generated from Movie_speed.xml ) Sets the relative playback speed of the movie.
`void`	`stop()` ( begin auto-generated from Movie_stop.xml ) Stops a movie from continuing.
`float`	`time()` ( begin auto-generated from Movie_time.xml ) Returns the location of the playback head in seconds.
`void`	`volume(float v)` Change the volume.

Methods inherited from class processing.core.PImage
blend, blend, blendColor, blurAlpha, blurARGB, blurRGB, buildBlurKernel, checkAlpha, clone, copy, copy, copy, dilate, erode, filter, filter, get, get, getImage, getModifiedX1, getModifiedX2, getModifiedY1, getModifiedY2, getNative, init, init, isLoaded, isModified, loadTIFF, mask, mask, opaque, resize, save, saveImageIO, saveTGA, saveTIFF, set, set, setImpl, setLoaded, setLoaded, setModified, setModified, updatePixels, updatePixels

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

- Field Detail
  - supportedProtocols
```
public static String[] supportedProtocols
```
  - frameRate
```
public float frameRate
```
  - filename
```
public String filename
```
  - playbin
```
public org.gstreamer.elements.PlayBin2 playbin
```
  - playing
```
protected boolean playing
```
  - paused
```
protected boolean paused
```
  - repeat
```
protected boolean repeat
```
  - rate
```
protected float rate
```
  - bufWidth
```
protected int bufWidth
```
  - bufHeight
```
protected int bufHeight
```
  - volume
```
protected float volume
```
  - movieEventMethod
```
protected Method movieEventMethod
```
  - eventHandler
```
protected Object eventHandler
```
  - available
```
protected boolean available
```
  - sinkReady
```
protected boolean sinkReady
```
  - newFrame
```
protected boolean newFrame
```
  - rgbSink
```
protected org.gstreamer.elements.RGBDataAppSink rgbSink
```
  - copyPixels
```
protected int[] copyPixels
```
  - firstFrame
```
protected boolean firstFrame
```
  - seeking
```
protected boolean seeking
```
  - useBufferSink
```
protected boolean useBufferSink
```
  - outdatedPixels
```
protected boolean outdatedPixels
```
  - bufferSink
```
protected Object bufferSink
```
  - sinkCopyMethod
```
protected Method sinkCopyMethod
```
  - sinkSetMethod
```
protected Method sinkSetMethod
```
  - sinkDisposeMethod
```
protected Method sinkDisposeMethod
```
  - sinkGetMethod
```
protected Method sinkGetMethod
```
  - copyMask
```
protected String copyMask
```
  - natBuffer
```
protected org.gstreamer.Buffer natBuffer
```
  - natSink
```
protected org.gstreamer.elements.BufferDataAppSink natSink
```
- Constructor Detail
  - Movie
```
public Movie(processing.core.PApplet parent,
             String filename)
```
    Creates an instance of GSMovie loading the movie from filename.
    
    Parameters:
    
    parent - PApplet
    
    filename - String
- Method Detail
  - dispose
```
public void dispose()
```
    Disposes all the native resources associated to this movie. NOTE: This is not official API and may/will be removed at any time.
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Finalizer of the class.
    
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable
  - frameRate
```
public void frameRate(float ifps)
```
    ( begin auto-generated from Movie_frameRate.xml ) Sets how often frames are read from the movie. Setting the fps parameter to 4, for example, will cause 4 frames to be read per second. ( end auto-generated )
    
    Parameters:
    
    ifps - speed of the movie in frames per second
  - speed
```
public void speed(float irate)
```
    ( begin auto-generated from Movie_speed.xml ) Sets the relative playback speed of the movie. The rate parameters sets the speed where 2.0 will play the movie twice as fast, 0.5 will play at half the speed, and -1 will play the movie in normal speed in reverse. ( end auto-generated )
    
    Parameters:
    
    irate - speed multiplier for movie playback
  - duration
```
public float duration()
```
    ( begin auto-generated from Movie_duration.xml ) Returns the length of the movie in seconds. If the movie is 1 minute and 20 seconds long the value returned will be 80.0. ( end auto-generated )
  - time
```
public float time()
```
    ( begin auto-generated from Movie_time.xml ) Returns the location of the playback head in seconds. For example, if the movie has been playing for 4 seconds, the number 4.0 will be returned. ( end auto-generated )
  - jump
```
public void jump(float where)
```
    ( begin auto-generated from Movie_jump.xml ) Jumps to a specific location within a movie. The parameter where is in terms of seconds. For example, if the movie is 12.2 seconds long, calling jump(6.1) would go to the middle of the movie. ( end auto-generated )
    
    Parameters:
    
    where - position to jump to specified in seconds
  - available
```
public boolean available()
```
    ( begin auto-generated from Movie_available.xml ) Returns "true" when a new movie frame is available to read. ( end auto-generated )
  - play
```
public void play()
```
    ( begin auto-generated from Movie_play.xml ) Plays a movie one time and stops at the last frame. ( end auto-generated )
  - loop
```
public void loop()
```
    ( begin auto-generated from Movie_loop.xml ) Plays a movie continuously, restarting it when it's over. ( end auto-generated )
  - noLoop
```
public void noLoop()
```
    ( begin auto-generated from Movie_noLoop.xml ) If a movie is looping, calling noLoop() will cause it to play until the end and then stop on the last frame. ( end auto-generated )
  - pause
```
public void pause()
```
    ( begin auto-generated from Movie_pause.xml ) Pauses a movie during playback. If a movie is started again with play(), it will continue from where it was paused. ( end auto-generated )
  - stop
```
public void stop()
```
    ( begin auto-generated from Movie_stop.xml ) Stops a movie from continuing. The playback returns to the beginning so when a movie is played, it will begin from the beginning. ( end auto-generated )
  - read
```
public void read()
```
    ( begin auto-generated from Movie_read.xml ) Reads the current frame of the movie. ( end auto-generated )
  - volume
```
public void volume(float v)
```
    Change the volume. Values are from 0 to 1.
    
    Parameters:
    
    float - v
  - loadPixels
```
public void loadPixels()
```
    Overrides:
    
    loadPixels in class processing.core.PImage
  - get
```
public int get(int x,
               int y)
```
    Overrides:
    
    get in class processing.core.PImage
  - getImpl
```
protected void getImpl(int sourceX,
                       int sourceY,
                       int sourceWidth,
                       int sourceHeight,
                       processing.core.PImage target,
                       int targetX,
                       int targetY)
```
    Overrides:
    
    getImpl in class processing.core.PImage
  - initGStreamer
```
protected void initGStreamer(processing.core.PApplet parent,
                             String filename)
```
  - setEventHandlerObject
```
protected void setEventHandlerObject(Object obj)
```
    Uses a generic object as handler of the movie. This object should have a movieEvent method that receives a GSMovie argument. This method will be called upon a new frame read event.
  - initSink
```
protected void initSink()
```
  - invokeEvent
```
protected void invokeEvent(int w,
                           int h,
                           IntBuffer buffer)
```
  - invokeEvent
```
protected void invokeEvent(int w,
                           int h,
                           org.gstreamer.Buffer buffer)
```
  - eosEvent
```
protected void eosEvent()
```
  - getSourceHeight
```
protected int getSourceHeight()
```
    Get the height of the source video. Note: calling this method repeatedly can slow down playback performance.
    
    Returns:
    
    int
  - getSourceFrameRate
```
protected float getSourceFrameRate()
```
    Get the original framerate of the source video. Note: calling this method repeatedly can slow down playback performance.
    
    Returns:
    
    float
  - getSourceWidth
```
protected int getSourceWidth()
```
    Get the width of the source video. Note: calling this method repeatedly can slow down playback performance.
    
    Returns:
    
    int
  - setBufferSink
```
public void setBufferSink(Object sink)
```
    Sets the object to use as destination for the frames read from the stream. The color conversion mask is automatically set to the one required to copy the frames to OpenGL. NOTE: This is not official API and may/will be removed at any time.
    
    Parameters:
    
    Object - dest
  - setBufferSink
```
public void setBufferSink(Object sink,
                          String mask)
```
    Sets the object to use as destination for the frames read from the stream. NOTE: This is not official API and may/will be removed at any time.
    
    Parameters:
    
    Object - dest
    
    String - mask
  - hasBufferSink
```
public boolean hasBufferSink()
```
    NOTE: This is not official API and may/will be removed at any time.
  - disposeBuffer
```
public void disposeBuffer(Object buf)
```
    NOTE: This is not official API and may/will be removed at any time.
  - getSinkMethods
```
protected void getSinkMethods()
```
  - initCopyMask
```
protected void initCopyMask()
```
  - post
```
public void post()
```

Class Movie

Field Summary

Fields inherited from class processing.core.PImage

Fields inherited from interface processing.core.PConstants

Constructor Summary

Method Summary

Methods inherited from class processing.core.PImage

Methods inherited from class java.lang.Object

Field Detail

supportedProtocols

frameRate

filename

playbin

playing

paused

repeat

rate

bufWidth

bufHeight

volume

movieEventMethod

eventHandler

available

sinkReady

newFrame

rgbSink

copyPixels

firstFrame

seeking

useBufferSink

outdatedPixels

bufferSink

sinkCopyMethod

sinkSetMethod

sinkDisposeMethod

sinkGetMethod

copyMask

natBuffer

natSink

Constructor Detail

Movie

Method Detail

dispose

finalize

frameRate

speed

duration

time

jump

available

play

loop

noLoop

pause

stop

read

volume

loadPixels

get

getImpl

initGStreamer

setEventHandlerObject

initSink

invokeEvent

invokeEvent

eosEvent

getSourceHeight

getSourceFrameRate

getSourceWidth

setBufferSink

setBufferSink

hasBufferSink

disposeBuffer

getSinkMethods

initCopyMask

post