libmodule.c File Reference

Description

Implementations of functions available to modules (nodes, types, libraries).

Copyright

Copyright © 2012–2017 Kosada Incorporated. This code may be modified and distributed under the terms of the MIT License. For more information, see http://vuo.org/license.

Functions
static void *	copyCompositionStateFromThreadLocalStorage (void)
	Wrapper for vuoCopyCompositionStateFromThreadLocalStorage().
const char *	VuoGetWorkingDirectory (void)
	Returns the POSIX path that this composition 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.

Variables
dispatch_once_t	VuoGetWorkingDirectoryOnce = 0
	Ensures the bulk of VuoGetWorkingDirectory only executes once.

Function Documentation

static void* copyCompositionStateFromThreadLocalStorage ( void  )

static

Wrapper for vuoCopyCompositionStateFromThreadLocalStorage().

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.

const char* VuoGetWorkingDirectory

(

void

)

Returns the POSIX path that this composition should use to resolve relative paths.

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

The returned string remains owned by this function; the caller should not modify or free it.

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.

Variable Documentation

dispatch_once_t VuoGetWorkingDirectoryOnce = 0

Ensures the bulk of VuoGetWorkingDirectory only executes once.

This is a public symbol so TestVuoUrl can reset it.