Developer

API Reference

ITransitionMgr_SetRunMode()

Brew Release
Brew MP 1.0.2
See Also
- ITransitionMgr_SetProperty()
- ITransitionMgr_GetRunMode()
Description
This function is a ITransitionMgr_SetProperty shortcut used to set the run mode of the manager This mode is used to determine how the manager will be stepped. An active manager will be self-sufficient. Once started, it will setup a callback timer based on its step time. A passive manager acts like a transition in that it requires an external source calling its step function to advance. Note that only a passive manager can be set to keep transitions.
Parameters
  • pif
    []:
    Pointer to the ITransitionMgr interface object.
  • nVal
    []:
    integer value to be applied to the property
Prototype
   int ITransitionMgr_SetRunMode(ITransition2* pif, int nVal)
Return
   AEE_SUCCESS          - The requested property has been applied.
   AEE_EBADPARM         - The requested property could not be applied.
   AEE_ECLASSNOTSUPPORT - The requested property is not supported.
   AEE_ENOTALLOWED      - The requested property cannot be set at this point in time.
Side Effect
None
Comment
Run mode can be set to the following values: ITransitionMgr_PVAL_RUNMODE_PASSIVE: The manager will receive step calls from an outside source. ITransitionMgr_PVAL_RUNMODE_ACTIVE: The manager will set it's own callback timer.
  • Follow