Protocol

FxKeyframeAPI

The FxKeyframeAPI protocol defines the host application’s methods that allow plug-ins to set and retrieve keyframes for the parameters they have.

Declaration

@protocol FxKeyframeAPI

Overview

Using the FxKeyframeAPI plug-ins can query the host application to find out whether keyframes exist and if so, how many there are, what times they are placed at, and what values parameters have at those keyframes. It also allows plug-ins to create new keyframes with the desired value at any given time.

This protocol was introduced in FxPlug SDK 2.0.

Topics

Modifying Keyframes

- addKeyframe:toParam:andChannel:

Adds a keyframe at the given time

Required.

- channelCount:forParam:

Returns the number of channels in a parameter.

Required.

- keyframeCount:forParam:andChannel:

Returns the number of keyframes for a parameter's channel.

Required.

- keyframeInfo:atOrAfter:fromParam:andChannel:

Returns the info about the nearest next keyframe.

Required.

- keyframeInfo:atOrBefore:fromParam:andChannel:

Returns the info about the nearest previous keyframe.

Required.

- keyframeInfo:forParam:channel:andIndex:

Returns the keyframe info for the keyframe at a given index.

Required.

- param:channel:hasKeyframe:atTime:

Tells whether there is a keyframe at a given time.

Required.

- removeAllKeyframesForParam:andChannel:

Remove all keyframes from the given parameter's channel.

Required.

- removeKeyframeAtIndex:fromParam:andChannel:

Remove all keyframes from the given parameter's channel.

Required.

- setKeyframe:withInfo:forParam:andChannel:

Sets the keyframe at the given index to have the given info

Required.

Constants

FxKeyframeInfo

Contains information about a single keyframe.

FxInitKeyframeInfo Macro

This macro ensures that the key frame info structure is properly initialized for the current version of the plug-in.

Keyframe Version Information

Specifies the version of the keyframe info. .

Relationships

Inherited By