Name
hw_SetTimerAdapter -- install a timer adapter (V6.0)
Synopsis
int error = hw_SetTimerAdapter(hwPluginBase *self, ULONG flags,
                                   struct hwTagList *tags);
Function
This function can be used to activate a plugin that has the HWPLUG_CAPS_TIMERADAPTER capability flag set. This function must only be called from inside your RequirePlugin() implementation. If this function succeeds, Hollywood's inbuilt timer handler will be completely replaced by the timer handler provided by your plugin and Hollywood will call into your plugin whenever it needs to work with timers. In the first parameter, you have to pass a pointer to the hwPluginBase that Hollywood has passed to your plugin's InitPlugin() function. The second parameter must be set to a combination of flags. The following flags are currently defined:

HWSTAFLAGS_PERMANENT:
If this flag is set, the timer adapter will be made permanent. This means that other plugins won't be able to overwrite this timer adapter with their own one. If HWSTAFLAGS_PERMANENT is set, all subsequent calls to hw_SetTimerAdapter() will fail and your timer adapter will persist.

See Timer adapter plugins for information on how to write timer adapter plugins.

Designer compatibility
Unsupported

Inputs
self
hwPluginBase pointer passed to InitPlugin()
flags
combination of flags (see above)
tags
reserved for future use; set it to NULL for now
Results
error
error code or 0 for success
Show TOC