OfxTimeLineSuiteV1
-
struct OfxTimeLineSuiteV1
Suite to control timelines.
This suite is used to enquire and control a timeline associated with a plug-in instance.
This is an optional suite in the Image Effect API.
Public Members
-
OfxStatus (*getTime)(void *instance, double *time)
Get the time value of the timeline that is controlling to the indicated effect.
instance
is the instance of the effect changing the timeline, cast to a void *time
pointer through which the timeline value should be returned
- Return:
kOfxStatOK - the time enquiry was sucessful
kOfxStatFailed - the enquiry failed for some host specific reason
kOfxStatErrBadHandle - the effect handle was invalid
-
OfxStatus (*gotoTime)(void *instance, double time)
Move the timeline control to the indicated time.
instance
is the instance of the effect changing the timeline, cast to a void *time
is the time to change the timeline to. This is in the temporal coordinate system of the effect.
- Return:
kOfxStatOK - the time was changed sucessfully, will all side effects if the change completed
kOfxStatFailed - the change failed for some host specific reason
kOfxStatErrBadHandle - the effect handle was invalid
kOfxStatErrValue - the time was an illegal value
-
OfxStatus (*getTimeBounds)(void *instance, double *firstTime, double *lastTime)
Get the current bounds on a timeline.
instance
is the instance of the effect changing the timeline, cast to a void *firstTime
is the first time on the timeline. This is in the temporal coordinate system of the effect.lastTime
is last time on the timeline. This is in the temporal coordinate system of the effect.
- Return:
kOfxStatOK - the time enquiry was sucessful
kOfxStatFailed - the enquiry failed for some host specific reason
kOfxStatErrBadHandle - the effect handle was invalid
-
OfxStatus (*getTime)(void *instance, double *time)