Module Metadata

Description

Name, version, and behavior information to be defined by node classes, port types, and library modules.

Macros
#define	VuoModuleDetails(...)   const char *moduleDetails = #__VA_ARGS__
	Name, version, and behavior information to be defined by node classes, port types, and library modules.

Macro Definition Documentation

#define VuoModuleDetails

(

...

)

const char *moduleDetails = #__VA_ARGS__

Name, version, and behavior information to be defined by node classes, port types, and library modules.

Example:

VuoModuleDetails({
                     "name" : "Display Console Window",
                     "description" : "<p>Opens a window that displays console output ...</p>",
                     "keywords" : [ "print", "log" ],
                     "version" : "1.0.0",
                     "dependencies" : [ "VuoWindow" ],
                     "node": {
                         "isInterface" : true
                     }
                 });

Pass a JSON specification that contains metadata about the node class, port type, or library module.

For any type of module, the keys in the JSON specification must include:

• "name" — A human-readable name for the module. It can be overridden by the user.

For any type of module, the keys in the JSON specification may optionally include:

• "description" — A description of the module's purpose. It may be formatted as plain text or HTML.
• "keywords" — A list of words related to the module's name. This list is used when searching for node classes in the Vuo Editor's Node Library.
• "version" — A version number for the module. It should use the Semantic Versioning (SemVer) scheme.
• "dependencies" — A list of libraries that this module depends upon.

For node classes, the keys in the JSON specification may optionally include "node". Its keys may optionally include:

• "isInterface" — True if this node class sends data to or receives data from somewhere external to the composition (e.g., input device, file, network). False by default.

See Also

Developing a Node Class

Developing a Port Type

Developing a Library Module