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...

String	addFolder (String &folderName, String &parentFolderPath)
	Adds a folder in the library. This function cannot be used in batch mode. More...

void	moveItems (StringList &srcItemPaths, String &dstFolderPath)
	Move items like folders or files to another location in the library. This function cannot be used in batch mode. More...

bool	renameItem (String &itemPath, String &newName)
	Rename a file or folder in the library. This function cannot be used in batch mode. More...

void	deleteItems (StringList &pathsOfItemsToRemove)
	Delete items from the library. This function cannot be used in batch mode. WARNING: If the item is a an actual folder in your filesystem that has been opened in the library, it will delete this item from your filesystem. More...

bool	itemExists (String &itemPath)
	Check item exists in the library. This function cannot be used in batch mode. More...

bool	openLibrary (String &filesystemPath)
	Open folder in the library. This function cannot be used in batch mode. More...

bool	closeLibrary (String &libraryRoot)
	close the library folder. This function cannot be used in batch mode. More...

Detailed Description

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

Member Function Documentation

◆ addFolder

String library::addFolder	(	String &	folderName,
		String &	parentFolderPath
	)

slot

Adds a folder in the library. This function cannot be used in batch mode.

Parameters

folderName	: The name of the new folder.
parentFolderPathInAudioBin	: The path of the parent folder, in the form of "folder1/folder2". The parent folder must exist.

Returns: Returns the name of the newly created folder, or an empty string if it was unsuccessful.

◆ closeLibrary

bool library::closeLibrary ( String & libraryRoot )

slot

close the library folder. This function cannot be used in batch mode.

Parameters

libraryRoot : The name of the root folder in the library to remove.

Returns: Returns true if closing the library folder was successful.

◆ deleteItems

void library::deleteItems ( StringList & pathsOfItemsToRemove )

slot

Delete items from the library. This function cannot be used in batch mode. WARNING: If the item is a an actual folder in your filesystem that has been opened in the library, it will delete this item from your filesystem.

Parameters

pathsOfItemsToRemove : Am array of the item paths to remove from the library, in the form of "folder1/folder2/file1". They can be files or folders.

◆ 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.

◆ itemExists

bool library::itemExists ( String & itemPath )

slot

Check item exists in the library. This function cannot be used in batch mode.

Parameters

itemPath : The path of the item in library, in the form of "folder1/folder2/file1". The item can be a file or folder.

Returns: Returns true if the if the item exists.

◆ moveItems

void library::moveItems	(	StringList &	srcItemPaths,
		String &	dstFolderPath
	)

slot

Move items like folders or files to another location in the library. This function cannot be used in batch mode.

Parameters

srcItemPaths	: An array of item paths to move, in the form of "folder1/folder2/file1". They can be files or folders. The source folders can only come from the Audio bin. The items must exist.
dstFolderPath	: The path of the folder in to move the item to, in the form of "folder1/folder2". The folder must exist.

◆ numberOfTemplatesSelected

int library::numberOfTemplatesSelected ( )

slot

Returns the number of files that are selected.

Returns: Returns the number of files that are selected.

◆ openLibrary

bool library::openLibrary ( String & filesystemPath )

slot

Open folder in the library. This function cannot be used in batch mode.

Parameters

filesystemPath : The path of the folder in the filesystem to open in the library.

Returns: Returns true if opening the folder in the library was successful.

◆ renameItem

bool library::renameItem	(	String &	itemPath,
		String &	newName
	)

slot

Rename a file or folder in the library. This function cannot be used in batch mode.

Parameters

itemPath	: The path of the item in library, in the form of "folder1/folder2/file1". The item can be a file or folder. The item must exist.
newName	: The new name of the item.

Returns: Returns true if renaming the item was successful.

Public Slots

Detailed Description

Member Function Documentation

◆ addFolder

◆ closeLibrary

◆ deleteItems

◆ getQuicktimeMovieForSelectedTpl

◆ getSelectedTemplate

◆ getThumbnailForSelectedTpl

◆ itemExists

◆ moveItems

◆ numberOfTemplatesSelected

◆ openLibrary

◆ renameItem