org.openimaj.video

Class VideoPlayer<T extends Image<?,T>>

java.lang.Object

org.openimaj.video.VideoDisplay<T>

org.openimaj.video.VideoPlayer<T>

Type Parameters:

T - The type of the video frame

All Implemented Interfaces:

Runnable, VideoDisplayStateListener

public class VideoPlayer<T extends Image<?,T>>
extends VideoDisplay<T>
implements VideoDisplayStateListener

This class is an extension of the VideoDisplay class that provides GUI elements for starting, stopping, pausing and rewinding video.

The class relies on the underlying VideoDisplay to actually provide the main functionality for video playing and indeed still allows its methods to be used. This class then provides a simple API for starting, pausing and stopping video.

Unlike VideoDisplay, the VideoPlayer class does not create a frame when the createVideoPlayer(Video) methods are called. Use the showFrame() method to produce a visible frame.

Version:

$Author$, $Revision$, $Date$

Author:

David Dupplaw (dpd@ecs.soton.ac.uk)

Created:

10 Aug 2012

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	VideoPlayer.VideoPlayerComponent The video player components encapsulates the buttons and their functionalities, as well as animating buttons, etc.

Nested classes/interfaces inherited from class org.openimaj.video.VideoDisplay

VideoDisplay.BasicVideoTimeKeeper, VideoDisplay.EndAction, VideoDisplay.Mode

Constructor Summary

Constructors

Modifier	Constructor and Description
	VideoPlayer(Video<T> v) Create the video player to play the given video.
	VideoPlayer(Video<T> v, AudioStream audio) Create the video player to play the given video.
protected	VideoPlayer(Video<T> v, AudioStream audio, DisplayUtilities.ImageComponent screen) Created the video player for the given video on the given image component.

Method Summary

Modifier and Type	Method and Description
static <T extends Image<?,T>> VideoPlayer<T>	createVideoPlayer(Video<T> video) Creates a new video player in a new thread and starts it running (initially in pause mode).
static <T extends Image<?,T>> VideoPlayer<T>	createVideoPlayer(Video<T> video, AudioStream audio) Creates a new video player in a new thread and starts it running (initially in pause mode).
JPanel	getVideoPlayerPanel() Returns a JPanel video player which can be incorporated into other GUIs.
void	pause() Pause the video
void	play() Play the video.
void	setButtons(String[] buttons) Set the buttons to show on this video player.
JFrame	showFrame() Shows the video player in a frame.
void	stepBack() Step back a frame.
void	stepForward() Step forward a frame.
void	stop() Stop the video
void	videoPaused(VideoDisplay<?> v) Called when the video display is paused.
void	videoPlaying(VideoDisplay<?> v) Called when the video display is set to play.
void	videoStateChanged(VideoDisplay.Mode mode, VideoDisplay<?> v) Called when the video display's state changes.
void	videoStopped(VideoDisplay<?> v) Called when the video display is stopped.

Methods inherited from class org.openimaj.video.VideoDisplay

addVideoDisplayStateListener, addVideoListener, addVideoPositionListener, changeVideo, close, createOffscreenVideoDisplay, createVideoDisplay, createVideoDisplay, createVideoDisplay, createVideoDisplay, createVideoDisplay, createVideoDisplay, createVideoDisplay, createVideoDisplay, displayMode, fireBeforeUpdate, fireStateChanged, fireVideoEndEvent, fireVideoStartEvent, fireVideoUpdate, getDisplayFPS, getDroppedFrameCount, getMode, getPosition, getScreen, getVideo, isCalculateFPS, isPaused, isStopped, processEndAction, removeVideoDisplayStateListener, removeVideoPositionListener, resetDroppedFrameCount, run, seek, setCalculateFPS, setEndAction, setMode, setPosition, setTimeKeeper, togglePause

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VideoPlayer

public VideoPlayer(Video<T> v)

Create the video player to play the given video.

Parameters:

v - The video to play

VideoPlayer

public VideoPlayer(Video<T> v,
                   AudioStream audio)

Create the video player to play the given video.

Parameters:

v - The video to play

audio - The audio to play

VideoPlayer

protected VideoPlayer(Video<T> v,
                      AudioStream audio,
                      DisplayUtilities.ImageComponent screen)

Created the video player for the given video on the given image component.

Parameters:

v - The video

audio - The audio

screen - The screen to draw the video to.

Method Detail

createVideoPlayer

public static <T extends Image<?,T>> VideoPlayer<T> createVideoPlayer(Video<T> video)

Creates a new video player in a new thread and starts it running (initially in pause mode).

Parameters:

video - The video

Returns:

The video player

createVideoPlayer

public static <T extends Image<?,T>> VideoPlayer<T> createVideoPlayer(Video<T> video,
                                                                      AudioStream audio)

Creates a new video player in a new thread and starts it running (initially in pause mode).

Parameters:

video - The video

audio - The udio

Returns:

The video player

showFrame

public JFrame showFrame()

Shows the video player in a frame. If a frame already exists it will be made visible.

Returns:

Returns the frame shown

getVideoPlayerPanel

public JPanel getVideoPlayerPanel()

Returns a JPanel video player which can be incorporated into other GUIs.

Returns:

A VideoPlayer in a JPanel

play

public void play()

Play the video.

stop

public void stop()

Stop the video

pause

public void pause()

Pause the video

stepBack

public void stepBack()

Step back a frame.

stepForward

public void stepForward()

Step forward a frame.

videoStopped

public void videoStopped(VideoDisplay<?> v)

Called when the video display is stopped.

Specified by:

videoStopped in interface VideoDisplayStateListener

Parameters:

v - The video display that was stopped.

See Also:

VideoDisplayStateListener.videoStopped(org.openimaj.video.VideoDisplay)

videoPlaying

public void videoPlaying(VideoDisplay<?> v)

Called when the video display is set to play.

Specified by:

videoPlaying in interface VideoDisplayStateListener

Parameters:

v - The video display that was set to play.

See Also:

VideoDisplayStateListener.videoPlaying(org.openimaj.video.VideoDisplay)

videoPaused

public void videoPaused(VideoDisplay<?> v)

Called when the video display is paused.

Specified by:

videoPaused in interface VideoDisplayStateListener

Parameters:

v - The video display that was paused.

See Also:

VideoDisplayStateListener.videoPaused(org.openimaj.video.VideoDisplay)

videoStateChanged

public void videoStateChanged(VideoDisplay.Mode mode,
                              VideoDisplay<?> v)

Called when the video display's state changes.

Specified by:

videoStateChanged in interface VideoDisplayStateListener

Parameters:

mode - The mode the video display changed to

v - The video display whose state changed.

See Also:

VideoDisplayStateListener.videoStateChanged(org.openimaj.video.VideoDisplay.Mode, org.openimaj.video.VideoDisplay)

setButtons

public void setButtons(String[] buttons)

Set the buttons to show on this video player. Available buttons are:

• play
• stop
• pause
• stepBack
• stepForward

Buttons not from this list will be ignored.

The order of the array will determine the order of the buttons shown on the player.

Parameters:

buttons - The buttons to show on the player.