API Reference | developer.brewmp.com API Reference | developer.brewmp.com

Developer

API Reference

ITRANSITIONMGR_ADD()

Brew Release
Brew MP 1.0.2
See Also
- ITransitionMgr_Stop()
Description
Adds a transition to the manager. In order to properly sequence multiple transitions to create some special effect, it is recommended that all required transitions be added to a manager before it is started or inserted within another active transition manager. The offset is defined in terms of the manager's current time. Therefore, adding a transition with an offset of "0" within a running manager will queue the transition to be played on the next step. Similarly an offset of "1000" will result in the transition being played 1 second in the future.
Params
pif
[in]:
Pointer to the ITransitionMgr interface object.
nAddType
[in]:
Specifies what kind of add to perform.
piNewTrans
[in]:
Specifies the Transition object being added.
piRefTrans
[in]:
Specified the reference transition.
nOffset
[in]:
Specifies the starting offset within the transition schedule.
Interface
Prototype
  •    AEERESULT ITransitionMgr_Add(ITransitionMgr* pif,
                                    int nAddType,
                                    IQI* piNewTrans,
                                    IQI* piRefTrans,
                                    int nOffset)
    
Return
  •    AEE_SUCCESS           : The manager added the transition successfully.
       AEE_ERESOURCENOTFOUND : The reference transition does not exist in the manager.
       AEE_ENOMEMORY         : Not enough memory to create the tracking structure
       AEE_EFAILED           : The manager failed to query the transition
    
Side Effect
  • None.
Comments
Possible add types ITransitionMgr_ADD_INSERTATOFFSET : Add transition at a specific offset ITransitionMgr_ADD_APPENDTOMGR : Append transition to end of manager queue ITransitionMgr_ADD_APPENDTOTRANS : Insert transition after the reference transition