Vuo  1.2.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Macros | Typedefs | Functions
module.h File Reference

Description

Prototypes for node class, type, and library module implementations.

Macros

#define VuoModuleMetadata(...)   extern const char *moduleDetails; const char *moduleDetails = #__VA_ARGS__
 Name, version, and behavior information to be defined by node classes, port types, and library modules.
 
#define DISPATCH_RETURNS_RETAINED_BLOCK
 Disable DISPATCH_RETURNS_RETAINED_BLOCK, which emits warnings on Mac OS 10.10.
 

Typedefs

typedef void(* VuoCompositionFiniCallback )(void)
 Callback prototype for VuoAddCompositionFiniCallback().
 

Functions

char * VuoGetWorkingDirectory (void)
 Returns the directory that nodes should use to resolve relative paths.
 
pid_t VuoGetRunnerPid (void)
 Returns the process ID of the runner that started the composition.
 
void VuoStopComposition (void)
 Asynchronously stops the composition.
 
void VuoStopCurrentComposition (void)
 Asynchronously stops the composition.
 
void VuoAddCompositionFiniCallback (VuoCompositionFiniCallback fini)
 Registers a callback to be invoked when the composition is shutting down, after nodeInstanceFini() has been called for all nodes.
 
void VuoDisableTermination (void)
 Temporarily disables automatic termination.
 
void VuoEnableTermination (void)
 Resumes automatic termination after a call to VuoDisableTermination().
 
bool VuoIsTrial (void)
 Returns true if nodes should apply free trial restrictions.
 
bool VuoIsPro (void)
 Returns true if nodes/libraries should enable Pro features.
 

Macro Definition Documentation

#define DISPATCH_RETURNS_RETAINED_BLOCK

Disable DISPATCH_RETURNS_RETAINED_BLOCK, which emits warnings on Mac OS 10.10.

https://b33p.net/kosada/node/9139

Typedef Documentation

typedef void(* VuoCompositionFiniCallback)(void)

Callback prototype for VuoAddCompositionFiniCallback().

Function Documentation

void VuoAddCompositionFiniCallback ( VuoCompositionFiniCallback  fini)

Registers a callback to be invoked when the composition is shutting down, after nodeInstanceFini() has been called for all nodes.

VuoCompositionFiniCallbacks are not called during livecoding reloads.

void VuoDisableTermination ( void  )

Temporarily disables automatic termination.

When a composition is asked to shut down, a watchdog timer waits a few seconds then force-quits if it hasn't cleanly shut down by then. This disables that watchdog.

Call this before entering a section where it would be undesirable to have the composition automatically force-quit, such as when saving a movie file that needs to be finalized.

When the work is over, call VuoEnableTermination().

void VuoEnableTermination ( void  )

Resumes automatic termination after a call to VuoDisableTermination().

pid_t VuoGetRunnerPid ( void  )

Returns the process ID of the runner that started the composition.

char* VuoGetWorkingDirectory ( void  )

Returns the directory that nodes should use to resolve relative paths.

bool VuoIsPro ( void  )

Returns true if nodes/libraries should enable Pro features.

bool VuoIsTrial ( void  )

Returns true if nodes should apply free trial restrictions.

void VuoStopComposition ( void  )

Asynchronously stops the composition.

void VuoStopCurrentComposition ( void  )

Asynchronously stops the composition.

VuoStopComposition() is typically preferable to this function, since this function doesn't handle multiple compositions running in the process.