Protocol

FxBaseEffect

The FxBaseEffect protocol defines the methods that all plug-ins need to implement.

Declaration

@protocol FxBaseEffect

Overview

All FxPlug-ins must implement the FxBaseEffect protocol. It is the protocol from which the FxFilter, FxGenerator, and FxTransition protocols all derive.

It defines the basic functionality that a plug-in must implement, such as creating parameters for the user to interact with, and informing the host which features the plug-in has, or needs, from the host. In addition, it allows the plug-in to update one or more parameters whenever another parameter is changed.

Topics

Specifying Parameter Values

- addParameters

Adds parameters to the host application that the plug-in requires.

Required.

- parameterChanged:

Reports a change to a plug-in parameter value made by the end user.

- variesOverTime

Specifies whether a plug-in produces different images (animation) over time using the same set of parameters.

Required.

- finishInitialSetup:

Allows the filter to do any setup between the time it was added to the timeline and the first time it renders.

- properties

Defines the plug-in's properties.

Required.

- numberOfFramesToScheduleAtRenderTime:forParam:

Allows the filter to tell the host application how many frames it will need from an image well parameter at a given render time.

- schedule:frames:forParam:forRenderAtTime:

Allows the filter to tell the host application which frames it will need from an image well parameter at a given render time.

- dynamicPropertiesAtTime:withError:

Allows a plug-in to change its properties at runtime based on its parameters or other factors.

Constants

Properties Dictionary Keys

These constants specify some of the supported keys in the dictionary specified by properties.

Relationships