Legacy APIs

Older FxPlug 3 APIs

Topics

Host Capabilities

FxHostCapabilities

The FxHostCapabilities class is implemented by the plug-in and provides information about the host application’s environment.

Base Effect

FxBaseEffect

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

FxFilter

The FxFilter protocol defines the methods a filter plug-in must implement to render output.

FxGenerator

The FxGenerator protocol defines the methods a generator plug-in must implement to render output.

FxTransition

The FxTransition protocol defines the the methods a transition plug-in needs to implement.

Window

FxWindowAPI

The FxWindowAPI protocol defines a set of methods a host application implements that allows plug-in to create and destroy a window.

FxWindowHost

the FxWindowHost protocol must be implemented by a plug-in if it wishes to host windows in the applications user interface.

Appearance

FxAppearanceAPI

The FxAppearanceAPI protocol defines methods the host application provides to retrieve the current colors being used.

Host Resources

FxHostResourcesAPI

The FxHostResourcesAPI protocol defines methods that the host application implements to allocate and track resources.

FxHostResourcesClient

The FxHostResourcesClient protocol defines methods that plug-ins implement if they want the host application to request that the plug-in free memory in low-memory situations.

Render Progess & Notification

FxRenderNotificationAPI

The FxRenderNotificationAPI protocol defines a host method that allows the plug-in to force host application to re-render.

FxProgressAPI

The FxProgressAPI protocol defines the methods implemented by a host application that allow a plug-in to report progress and support user cancellation.

Enumerations

Temporal

FxTemporalImageAPI

The FxTemporalImageAPI protocol defines the methods the host application provides to access an input image at a specific time.

FxTemporalImageAPI_v2

The FxTemporalImageAPI_v2 protocol defines the methods the host application provides to access an input image at a specific time.

FxTemporalTransitionImageAPI

The FxTemporalTransitionImageAPI protocol defines the methods the host application provides to access an input image at a specific time from a transition.

FxTimeBase

Defines whether time bases are relative or absolute.

FxTransitionInput

These constants are used to identify one of the two inputs to a transition.

See Also

Legacy Plug-ins

Migrating FxPlug 3 Plug-ins to FxPlug 4

Update existing FxPlug 3 plug-ins to out-of-process FxPlug 4 plug-ins.

FxVersioningAPI

The FxVersioningAPI protocol defines the methods a host application implements for identifying the version of the plug-in that was used by a project when the project was first created.