ofBaseVideoPlayer
firstFrame( )
void firstFrame()Set the playhead position to the first frame.
This is functionally equivalent to setFrame(0) or setPosition(0.0).
getCurrentFrame( )
int getCurrentFrame()Get the current playhead position as a frame number.
Returns: The current playhead position as a frame number.
getDuration( )
float getDuration()Get the duration of the loaded video in seconds.
Returns: The duration of the loaded video in seconds.
getHeight( )
float getHeight()Get the height in pixels of the loaded video.
Returns: The height in pixels of the loaded video or 0 if none is loaded.
getIsMovieDone( )
bool getIsMovieDone()Returns true if the loaded video has finished playing.
Returns: True if the loaded video has finished playing.
getLoopState( )
ofLoopType getLoopState()Get the current loop state of the video.
See also: ::ofLoopType
getPosition( )
float getPosition()Get the current playhead position of the loaded video.
This value is a normalized floating point value between 0.0 and 1.0 that represents the position of the playhead. 0.0 maps to the first frame of the loaded video and 1.0 maps to the last frame of the loaded video.
Returns: A value between 0.0 and 1.0 representing playhead position.
getSpeed( )
float getSpeed()Get the playback speed of the video player.
When the loop state is OF_LOOP_NONE or OF_LOOP_NORMAL, positive speed will scale a forward playback rate while a negative speed will scale a a backward playback rate. When the loop state is OF_LOOP_PALINDROME, the direction of playback will change each loop, but the playback rate will still be scaled by the absolute value of the speed.
Returns: The playback speed of the video player.
getTexturePtr( )
ofTexture * getTexturePtr()Get a pointer to the video texture used internally if it exists.
If the video player implementation supports direct-to-texture rendering, this method will return a pointer to the internal texture. If direct-to-texture rendering is not supported, nullptr is returned.
Returns: A valid pointer to the internal texture, otherwise a nullptr.
getTotalNumFrames( )
int getTotalNumFrames()Get the total number of frames in the currently loaded video.
Returns: The total number of frames in the currently loaded video.
getWidth( )
float getWidth()Get the width in pixels of the loaded video.
Returns: The width in pixels of the loaded video or 0 if none is loaded.
isInitialized( )
bool isInitialized()Returns true if a video is loaded.
This is helpful when loading a video with loadAsync(). This is also an alias of isLoaded().
See also: loadAsync()
Returns: True if a video is loaded.
isLoaded( )
bool isLoaded()Returns true if a video is loaded.
This is helpful when loading a video with loadAsync(). This is also an alias of isInitialized().
See also: loadAsync()
Returns: True if a video is loaded.
isPaused( )
bool isPaused()Returns true if the video is paused.
Returns: True if the video is paused.
isPlaying( )
bool isPlaying()Returns true if the loaded video is playing.
Returns: True if the loaded video is playing.
load( ... )
bool load(string name)Load a video resource by name.
The list of supported video types and sources (e.g. rtsp:// sources) is implementation dependent.
Parameters:
name The name of the video resource to load.
Returns: True if the video was loaded successfully.
See also: loadAsync()
loadAsync( ... )
void loadAsync(string name)Asynchronously load a video resource by name.
The list of supported video types and sources (e.g. rtsp:// sources) is implementation dependent.
When this method is used to load a video resouce, users can determine when the video is loaded by calling isLoaded().
Parameters:
name The name of the video resource to load.
See also: isLoaded()
nextFrame( )
void nextFrame()Advance the playhead forward one frame.
This allows the user to advance through the video manually one frame at a time without calling play().
play( )
void play()Play the video from the current playhead position.
See also: getPosition()
See also: setPostion()
previousFrame( )
void previousFrame()Advance the playhead backward one frame.
This allows the user to advance backward through the video manually one frame at a time without calling play().
setFrame( ... )
void setFrame(int frame)Set the current frame by frame number.
Similar to setPosition(), but accepts a frame number instead of a normalized floating point value. Frame count begins with the first frame as 0 and the last frame as getTotalNumFrames() - 1.
Parameters:
frame The frame number to set the new playhead to.
setLoopState( ... )
void setLoopState(ofLoopType state)Set the video loop state.
Parameters:
state The loop state of the video.
See also: ::ofLoopType
setPaused( ... )
void setPaused(bool bPause)Set the paused state of the video.
Parameters:
bPause True to pause the video, false to play.
setPosition( ... )
void setPosition(float pct)Set the position of the playhead.
This value is a normalized floating point value between 0.0 and 1.0 that represents the position of the playhead. 0.0 maps to the first frame of the loaded video and 1.0 maps to the last frame of the loaded video.
Parameters:
pct A value between 0.0 and 1.0 representing playhead position.
setSpeed( ... )
void setSpeed(float speed)Set the video playback speed.
When the loop state is OF_LOOP_NONE or OF_LOOP_NORMAL, positive speed will scale a forward playback rate while a negative speed will scale a a backward playback rate. When the loop state is OF_LOOP_PALINDROME, the direction of playback will change each loop, but the playback rate will still be scaled by the absolute value of the speed.
To play a video forward at normal speed, set the loop state to OF_LOOP_NONE or OF_LOOP_NORMAL and a speed of 1.0. To double the playback rate, set the speed to 2.0. To play a video backward, set the speed to a negative number. A speed 0.25 will play the video at 1/4 the the normal rate and a rate of 0.0 will effectively stop playback.
Parameters:
speed The desired playback speed of the video.
setVolume( ... )
void setVolume(float volume)Set the volume of the video player.
This value is a normalized floating point value between 0.0 and 1.0 that represents the video player volume. 0.0 maps to silence and 1.0 maps to maximum volume.
Parameters:
volume A value between 0.0 and 1.0 representing volume.
stop( )
void stop()Pause and reset the playhead position to the first frame.
~ofBaseVideoPlayer( )
~ofBaseVideoPlayer()Destroys the ofBaseVideoPlayer.