Name
GetPlugins -- get information about available plugins (V5.3)
Synopsis
t = GetPlugins()
Function
This function returns a table that contains information about all available plugins. You will get one subtable for each plugin that has been loaded. Use ListItems() to find out how many plugin subtables are in the table. Each subtable will contain the following fields:

Name:
Name of the plugin.

Version:
Version number of plugin.

Revision:
Revision number of plugin.

Capabilities:
Bitmask describing the Hollywood capabilities that this plugin extends. This will be a combination of the following capabilities:

 
#PLUGINCAPS_CONVERT
#PLUGINCAPS_LIBRARY
#PLUGINCAPS_IMAGE
#PLUGINCAPS_ANIM
#PLUGINCAPS_SOUND
#PLUGINCAPS_VECTOR
#PLUGINCAPS_VIDEO
#PLUGINCAPS_SAVEIMAGE
#PLUGINCAPS_SAVEANIM
#PLUGINCAPS_SAVESAMPLE
#PLUGINCAPS_REQUIRE
#PLUGINCAPS_DISPLAYADAPTER
#PLUGINCAPS_TIMERADAPTER
#PLUGINCAPS_REQUESTERADAPTER
#PLUGINCAPS_FILEADAPTER
#PLUGINCAPS_DIRADAPTER
#PLUGINCAPS_AUDIOADAPTER

Author:
Author of the plugin.

Description:
Description of the plugin.

Copyright:
Copyright string of the plugin.

URL:
URL of the plugin's homepage (where to get updates, etc.)

Date:
Compilation date of plugin.

Settings:
Fully qualified path to settings tool of the plugin.

HelpFile:
Fully qualified path to the help file of the plugin.

Path:
Fully qualified path to the plugin's binary code.

FileTypes:
This item contains a subtable that contains tables describing all file formats that this plugin makes available. This is for example useful for adapting your file requesters to contain additional extensions that are supported by plugins. For every new file type there will be a table with the following fields initialized:

Type:
Set to the type of the file format. This will be one of the following constants:

 
#FILETYPE_IMAGE
#FILETYPE_ANIM
#FILETYPE_SOUND
#FILETYPE_VIDEO

Name:
Set to a string describing the name of the file format, e.g. "TIFF".

Extensions:
Set to a string containing all extensions used by this file format. The extensions are separated by the "|" character and do not contain a dot, e.g. "tif|tiff".

MIMEType:
Set to a string that describes the MIME of the file format. This can also be empty.

Flags:
Set to a bitmask combination that describes the capabilities of this file type. The following flags are currently defined:

#FILETYPEFLAGS_SAVE:
If this flag is set, the entry describes a file type that this plugin can save. The FormatID tag will contain the constant used to refer to this plugin file type saver in that case.

#FILETYPEFLAGS_ALPHA:
Indicates that this file type supports alpha channel loading or saving (depending on whether #FILETYPEFLAGS_SAVE is set).

#FILETYPEFLAGS_QUALITY:
Only used for #FILETYPE_IMAGE or #FILETYPE_ANIM with save mode enabled. In that case this flag indicates that the image/anim saver supports different quality levels (ranging from 0 to 100).

#FILETYPEFLAGS_FPS:
Only used for #FILETYPE_ANIM with save mode enabled. In that case this flag indicates that the anim saver supports different frames per second settings.

FormatID:
If #FILETYPEFLAGS_SAVE is set in Flags, this tag will contain the constant identifier that has to be passed to the respective save function in order to use this file type saver. For example, for files of type #FILETYPE_IMAGE FormatID contains the identifier that has to be passed to SaveBrush().

ModuleName:
Contains the plugin's module name. This is equal to the plugin's file name minus the file extension. The module name of the plugin is unique among all loaded plugins. Hollywood will never load two plugins with the same module name. (V6.0)

Disabled:
Tells you whether or not this plugin is currently disabled because of a call to DisablePlugin(). (V6.0)

Inputs
none

Results
t
table containing information about the plugins loaded

Show TOC