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

Developer

API Reference

ITRANSITIONMGR_GETTRANSPROPERTY()

Brew Release
Brew MP 1.0.2
See Also
- ITransitionMgr_Get()
Description
Retrieves some information from a transition in the manager. For example, it allows checking if a transition is queued, paused, and can retrieve other tracking values.
Params
pif
[in]:
Pointer to the ITransitionMgr interface object.
propId
[in]:
Specifies the class ID of the property
piTrans
[in]:
Specified which transition to query.
pVal
[out]:
Pointer to int array
pValLen
[in]:
Number of elements in the array.
pValLenReq
[out]:
Required array length.
Interface
Prototype
  •    AEERESULT ITransitionMgr_GetTransProperty(ITransitionMgr* pif,
                                                 AEECLSID propId,
                                                 IQI* piTrans,
                                                 int* pVal,
                                                 int  pValLen,
                                                 int* pValLenReq)
    
Return
  •    AEE_SUCCESS           : The property was successfully retrieved.
       AEE_EFAILED           : Property failed to be retrieved
       AEE_EBADPARM          : invalid location to store transition, null or too small
    
Side Effect
  • None.
Comments
Possible propid's ITransitionMgr_GETINFO_ISQUEUED: Checks if the transition is currently active in the manager ITransitionMgr_GETINFO_ISPAUSED: Checks if the transition is currently paused ITransitionMgr_GETINFO_ENDOFFSET: Expected end offset of the transition (only works for real-time transitions)