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)
 set 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)
 set the desired last frame. This will affect the number of frames that will be extracted by 'doImport()' default value: 0 which mean that all frames are imported More...
 
void setAudioFile (String audioFilename)
 set 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 ()
 perform the import - no progress bar. More...
 
int numberOfImages ()
 return the number of imported images from the last import. More...
 
String image (int index)
 return the complete filename for the imported image 'index' from the last import. More...
 
bool isAudioFileCreated ()
 return 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

perform the import - no progress bar.

◆ image

String MovieImport::image ( int  index)
slot

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

◆ isAudioFileCreated

bool MovieImport::isAudioFileCreated ( )
slot

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

◆ numberOfImages

int MovieImport::numberOfImages ( )
slot

return the number of imported images from the last import.

◆ setAudioFile

void MovieImport::setAudioFile ( String  audioFilename)
slot

set 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'

◆ setImageFolder

void MovieImport::setImageFolder ( String  folder)
slot

defines where to store the extracted images.

◆ setImagePrefix

void MovieImport::setImagePrefix ( String  prefix)
slot

defines which prefix to use to save the images.

◆ setMovieFilename

void MovieImport::setMovieFilename ( String  filename)
slot

defines the input movie filename.

◆ setStartFrame

void MovieImport::setStartFrame ( int  startFrame)
slot

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

◆ setStopFrame

void MovieImport::setStopFrame ( int  stopFrame)
slot

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