The Get Time Domain Action
Prev   Chapter 13. Actions Passed to An Image Effect   Next

The Get Time Domain Action 

	#include "ofxImageEffect.h"
	#define kOfxImageEffectActionGetTimeDomain                "OfxImageEffectActionGetTimeDomain"
Arguments

  • handle handle to the instance, cast to an OfxImageEffectHandle ,
  • inArgs is redundant and is null
  • outArgs has the following property

Description

This action allows a host to ask an effect what range of frames it can produce images over. Only effects instantiated in the General Context can have this called on them. In all other the host is in strict control over the temporal duration of the effect.

Preconditions

  • kOfxActionCreateInstance has been called on the instance
  • the effect instance has been created in the general effect context

Return Values

  • kOfxStatOK, the action was trapped and the kOfxImageEffectPropFrameRange was set in the outArgs property set
  • kOfxStatReplyDefault, the action was not trapped and the host should use the default value
  • kOfxStatErrMemory, in which case the action may be called again after a memory purge
  • kOfxStatFailed, something wrong, but no error code appropriate, plugin to post message
  • kOfxStatErrFatal

Default Action

The default is,

  • the union of all the frame ranges of the non optional input clips,
  • infinite if there are no non optional input clips.

Prev   Up   Next
The Get Clip Preferences Action  Home  Chapter 14. Actions Passed to an Interact