Vuo  1.0.1
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Typedefs | Functions
VuoMovie.h File Reference

Description

VuoMovie interface.

Typedefs

typedef void * VuoMovie
 An object for controlling and extracting information from video.
 

Functions

VuoMovie VuoMovie_make (const char *path)
 VuoMovie_make: Creates a new VuoMovieDecoder object and returns itself.
 
bool VuoMovie_getNextVideoFrame (VuoMovie movie, VuoImage *image, double *nextFrame)
 VuoMovie_getNextFrame gets the next full frame's image and presentation timestamp (in seconds).
 
bool VuoMovie_getPreviousVideoFrame (VuoMovie movie, VuoImage *image, double *nextFrame)
 Returns the frame prior to the internal currently queued frame, and the presentation timestamp associated.
 
bool VuoMovie_seekToSecond (VuoMovie movie, double second)
 Seeks the video to the specified second.
 
double VuoMovie_getCurrentSecond (VuoMovie movie)
 Returns the last successfully decoded timestamp.
 
double VuoMovie_getDuration (VuoMovie movie)
 Returns the duration of the movie in seconds.
 
bool VuoMovie_getInfo (const char *path, double *duration)
 Given a path, this will open and close a video stream and return the duration.
 
bool VuoMovie_containsAudio (VuoMovie movie)
 Returns true if audio channels are present in file, false if not.
 
bool VuoMovie_getNextAudioSample (VuoMovie movie, VuoList_VuoAudioSamples audioSamples, double *frameTimestampInSeconds)
 Return the next available chunk of audio samples.
 

Typedef Documentation

typedef void* VuoMovie

An object for controlling and extracting information from video.

Function Documentation

bool VuoMovie_containsAudio ( VuoMovie  movie)

Returns true if audio channels are present in file, false if not.

double VuoMovie_getCurrentSecond ( VuoMovie  movie)

Returns the last successfully decoded timestamp.

double VuoMovie_getDuration ( VuoMovie  movie)

Returns the duration of the movie in seconds.

bool VuoMovie_getInfo ( const char *  path,
double *  duration 
)

Given a path, this will open and close a video stream and return the duration.

bool VuoMovie_getNextAudioSample ( VuoMovie  movie,
VuoList_VuoAudioSamples  audioSamples,
double *  frameTimestampInSeconds 
)

Return the next available chunk of audio samples.

If none are available, return false.

bool VuoMovie_getNextVideoFrame ( VuoMovie  movie,
VuoImage image,
double *  nextFrame 
)

VuoMovie_getNextFrame gets the next full frame's image and presentation timestamp (in seconds).

Will return true if next frame is found and false if not.

bool VuoMovie_getPreviousVideoFrame ( VuoMovie  movie,
VuoImage image,
double *  nextFrame 
)

Returns the frame prior to the internal currently queued frame, and the presentation timestamp associated.

VuoMovie VuoMovie_make ( const char *  path)

VuoMovie_make: Creates a new VuoMovieDecoder object and returns itself.

Parameters
pathAn absolute path to the video file to open.
Returns
A new VuoMovie object, which may be used to control playback of the film. If the video file fails to open for any reason, this returns NULL.
bool VuoMovie_seekToSecond ( VuoMovie  movie,
double  second 
)

Seeks the video to the specified second.