Protocol

FxTimingAPI_v3

The FxTimingAPI_v3 protocol defines the methods implemented by the host application that allows a plug-in to query the timing properties of its input image or images, image parameters, effect, timeline, and in/out points.

Declaration

@protocol FxTimingAPI_v3

Overview

This protocol is only available to FxPlug 3 plug-ins.

Topics

Accessing Timing Values

- frameDuration:

Returns the frame duration.

Required.

- sampleDuration:

Returns the sample duration.

Required.

- startFxTimeForEffect:

Returns the start time of the given effect.

Required.

- durationFxTimeForEffect:

Returns the duration of the given effect.

Required.

- startFxTimeOfInputAToTransition:

Returns the start time of the given transition's image input A clip.

Required.

- startFxTimeOfInputBToTransition:

Returns the start time of the given transition's image input B clip.

Required.

- durationFxTimeOfInputAToTransition:

Returns the duration of the given transition's image input A clip.

Required.

- durationFxTimeOfInputBToTransition:

Returns the duration of the given transition's image input B clip.

Required.

- startFxTimeOfInputToFilter:

Returns the start time of the given filter's image input clip.

Required.

- durationFxTimeOfInputToFilter:

Returns the duration of the given filter's image input clip.

Required.

- startFxTime:ofImageParam:

Returns the start time of the clip assigned to the given image parameter.

Required.

- durationFxTime:ofImageParm:

Returns the duration of the clip assigned to the given image parameter.

Required.

- inPointFxTimeOfTimelineForEffect:

Returns the In Point of the timeline on which the given effect has been applied.

Required.

- outPointFxTimeOfTimelineForEffect:

Returns the Out Point of the timeline on which the given effect has been applied.

Required.

- timelineFxTime:fromInputTime:

Returns the timeline frames, converted from the input time.

Required.

- timelineFxTime:fromInputATime:

Returns the timeline frames, converted from the input A time.

Required.

- timelineFxTime:fromInputBTime:

Returns the timeline frames, converted from the input B time.

Required.

- timelineFxTime:fromImageTime:forParmId:

Returns the timeline frames, converted from the specified image parameter time.

Required.

- inputFxTime:fromTimelineTime:

Returns the input time, converted from timeline frames.

Required.

- inputAFxTime:fromTimelineTime:

Returns the input A time, converted from timeline frames.

Required.

- inputBFxTime:fromTimelineTime:

Returns the input B time, converted from timeline frames.

Required.

- imageFxTime:forParmId:fromTimelineTime:

Returns the image time, converted from the specified image parameter’s timeline frames.

Required.

Relationships

Inherits From

See Also

Legacy Versions

FxTimingAPI

The FxTimingAPI protocol defines the methods provided by the host application to allow a plug-in to query the timing properties of its input image or images, image parameters, effect, timeline, and in/out points.

FxTimingAPI_v2

The FxTimingAPI_v2 protocol defines the method implemented by the host application that allows a plug-in to query the timing properties of its input image or images, image parameters, effect, timeline, and in/out points.