Struct 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

This function returns the current time value of the timeline associated with the effect instance.

Return:

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.

This function moves the timeline to the indicated frame and returns. Any side effects of the timeline change are also triggered and completed before this returns (for example instance changed actions and renders if the output of the effect is being viewed).

Return:

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.

This function

Return: