ADC Home > Reference Library > Reference > Apple Applications > Final Cut Pro/Final Cut Express > FxPlug Reference

FxLayerInfoAPI

Declared In:

Introduction

Defines the functions the host application provides to get information about the layer where an effect is currently applied.

Methods

-getLayerGlobalOffsetX:OffsetY:atTime:: Requests the offset of the bottom left corner of the layer where an effect is applied.

getLayerGlobalOffsetX:OffsetY:atTime:

Requests the offset of the bottom left corner of the layer where an effect is applied.

- (BOOL)getLayerGlobalOffsetX:(double *)offsetX OffsetY:(double *)offsetY atTime:(double)time;

Parameters

offsetX: Pointer for the X offset of the layer.
offsetY: Pointer for the Y offset of the layer.
time: The time to get this information, expressed in canonical frames.

Return Value

Returns YES if the application successfully provides the layer information; NO otherwise.

Discussion

Depending on the host application, the time value may be relative to the start of the timeline or to the start of the clip. See the header file FxPlug/FxHostCapabilities.h.

Did this document help you?

Yes: Tell us what works for you.

It’s good, but: Report typos, inaccuracies, and so forth.

It wasn’t helpful: Tell us what would have helped.

Last Updated: 2008-06-05