MovieImport Class Reference

The MovieImport JavaScript global object. Import a QuickTime movie in the current scene. More...

Public Slots
void	setMovieFilename (String filename)
	Defines the input movie filename. More...
void	setImageFolder (String folder)
	Defines where to store the extracted images. More...
void	setImagePrefix (String prefix)
	Defines which prefix to use to save the images. More...
void	setStartFrame (int startFrame)
	Sets the start frame (frame are 1 bound). The default value is 1. This will affect the 'doImport()' command where only these frames are considered. More...
void	setStopFrame (int stopFrame)
	Sets the desired last frame. This will affect the number of frames that will be extracted by the 'doImport()' default value: 0 which mean that all frames are imported. More...
void	setAudioFile (String audioFilename)
	Sets the expected audio filename. must be wav format (as this is currently the only one supported) sound filename can be left empty. if so, there will not be any file created. More...
bool	doImport ()
	Performs the import - no progress bar. More...
int	numberOfImages ()
	Returns the number of imported images from the last import. More...
String	image (int index)
	Returns the complete filename for the imported image 'index' from the last import. More...
bool	isAudioFileCreated ()
	Returns true if a sound file was created at the given filename. More...

Detailed Description

The MovieImport JavaScript global object. Import a QuickTime movie in the current scene.

This object is used to import a QuickTime movie in the scene. First the user needs to set up the importing parameters using the functions: setMovieFilename, setImageFolder, setImagePrefix and setAudioFile. Then call doImport and after that, the user can iterate over the number of images, the current image filename and whether an audio file was created or not.

Member Function Documentation

doImport

bool MovieImport::doImport ( )

slot

Performs the import - no progress bar.

Returns

Returns true if import is successful.

image

String MovieImport::image ( int  index )

slot

Returns the complete filename for the imported image 'index' from the last import.

Parameters

index

: The index of the desired image from the last import.

Returns

Returns the complete filename for the imported image 'index' from the last import.

isAudioFileCreated

bool MovieImport::isAudioFileCreated ( )

slot

Returns true if a sound file was created at the given filename.

Returns

Returns true if a sound file was created at the given filename.

numberOfImages

int MovieImport::numberOfImages ( )

slot

Returns the number of imported images from the last import.

Returns

Returns the number of imporated images from the last import.

setAudioFile

void MovieImport::setAudioFile ( String  audioFilename )

slot

Sets the expected audio filename. must be wav format (as this is currently the only one supported) sound filename can be left empty. if so, there will not be any file created.

The audio created will contains the sound covered by the range defined by 'startFrame' to 'stopFrame'.

Parameters

audioFilename

: The expected audio filename.

setImageFolder

void MovieImport::setImageFolder ( String  folder )

slot

Defines where to store the extracted images.

Parameters

folder

: The folder to store extracted images.

setImagePrefix

void MovieImport::setImagePrefix ( String  prefix )

slot

Defines which prefix to use to save the images.

Parameters

prefix

: The prefix to use to save the images.

setMovieFilename

void MovieImport::setMovieFilename ( String  filename )

slot

Defines the input movie filename.

Parameters

filename

: The input movie filename.

setStartFrame

void MovieImport::setStartFrame ( int  startFrame )

slot

Sets the start frame (frame are 1 bound). The default value is 1. This will affect the 'doImport()' command where only these frames are considered.

Parameters

startFrame

: The frame to start from.

setStopFrame

void MovieImport::setStopFrame ( int  stopFrame )

slot

Sets the desired last frame. This will affect the number of frames that will be extracted by the 'doImport()' default value: 0 which mean that all frames are imported.

Parameters

stopFrame

: The frame to stop at.