library Class Reference

The library JavaScript global object. Select templates, and generate thumbnails or movies for them. More...

Public Slots

int numberOfTemplatesSelected ()
 Returns the number of files that are selected. More...
 
String getSelectedTemplate (int i)
 Returns the path to the ith file that is selected. More...
 
bool getThumbnailForSelectedTpl (int idx, int res, String &dstPath)
 Generates the thumbnails for selected templates. More...
 
bool getQuicktimeMovieForSelectedTpl (int idx, int start, int end, int xRes, int yRes, String &userName, String &displayNode, String &dstPath, bool withSound)
 Generates the movies for selected templates. More...
 

Detailed Description

The library JavaScript global object. Select templates, and generate thumbnails or movies for them.

Member Function Documentation

◆ getQuicktimeMovieForSelectedTpl

bool library::getQuicktimeMovieForSelectedTpl ( int  idx,
int  start,
int  end,
int  xRes,
int  yRes,
String &  userName,
String &  displayNode,
String &  dstPath,
bool  withSound 
)
slot

Generates the movies for selected templates.

Parameters
idx: The index of the templates to generate QuickTime Movie(s) for.
start: The starting frame for the generated QuickTime Movie(s).
end: The ending frame for the generated QuickTime Movie(s).
xRes: Number of pixels in the x-axis.
yRes: Number of pixels in the y-axis.
userName: The desired user name.
displayNode: The display node.
dstPath: The destination path.
withSound: Whether or not the generated movie(s) will have sound.
Returns
Returns true if successful.

◆ getSelectedTemplate

String library::getSelectedTemplate ( int  i)
slot

Returns the path to the ith file that is selected.

Parameters
i: The index of the target file in the currently selected files.
Returns
Returns the path to the ith file that is selected.

◆ getThumbnailForSelectedTpl

bool library::getThumbnailForSelectedTpl ( int  idx,
int  res,
String &  dstPath 
)
slot

Generates the thumbnails for selected templates.

Parameters
idx: The index of the templates to generate thumbnails for.
res: The desired resolution of the thumbnails.
dstPath: The destination path for the generated thumbnails.
Returns
Returns true if successful.

◆ numberOfTemplatesSelected

int library::numberOfTemplatesSelected ( )
slot

Returns the number of files that are selected.

Returns
Returns the number of files that are selected.