FxTemporalImageAPI

Introduction

Defines the methods the host application provides to access an input image at a specific time.

Discussion

Usually the only plug-in that needs to use this host API is an FxFilter that does "retiming," i.e. a filter whose output depends on input frames at times other than the output time.


NOTE: A plug-in that uses this API should set the value for the kFxPropertyKey_MayRemapTime key, in the NSDictionary its -properties method returns.

Methods

-getInputBitmap:withInfo:atTime:

Gets a bitmap image from the immediate input, including leading filters.

-getInputTexture:withInfo:atTime:

Gets a texture image from immediate input, including leading filters.

-getSourceBitmap:withInfo:atTime:

Gets a bitmap image from source footage, ignoring leading filters.

-getSourceTexture:withInfo:atTime:

Gets a texture image from source footage, ignoring leading filters.

Gets a bitmap image from the immediate input, including leading filters.

- (BOOL)getInputBitmap:(FxBitmap **)image withInfo:(FxRenderInfo)renderInfo atTime:(double)time;

Parameters

image

Variable for a pointer to a bitmap. (NOTE: this bitmap must be released by the sender when processing is complete.)

renderInfo

Information about the requested image, including quality, scale, and bitdepth.

time

Specified time, expressed in canonical frames, to get the image.

Return Value

Returns YES if the input bitmap is retrieved successfully; 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.

Gets a texture image from immediate input, including leading filters.

- (BOOL)getInputTexture:(FxTexture **)image withInfo:(FxRenderInfo)renderInfo atTime:(double)time; 

Parameters

image

Variable for a pointer to a texture. (NOTE: this texture must be released by the sender when processing is complete.)

renderInfo

Information about the requested image, including quality, scale, and bitdepth.

time

Specified time, expressed in canonical frames, to get the image.

Return Value

Returns YES if the input texture is retrieved successfully; 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.

Gets a bitmap image from source footage, ignoring leading filters.

- (BOOL)getSourceBitmap:(FxBitmap **)image withInfo:(FxRenderInfo)renderInfo atTime:(double)time; 

Parameters

image

Variable for a pointer to a bitmap. (NOTE: this bitmap must be released by the sender when processing is complete).

renderInfo

Information about the requested image, including quality, scale, and bitdepth.

time

Specified time, expressed in canonical frames, to get the image.

Return Value

Returns YES if the input bitmap is retrieved successfully; 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.

Gets a texture image from source footage, ignoring leading filters.

- (BOOL)getSourceTexture:(FxTexture **)image withInfo:(FxRenderInfo)renderInfo atTime:(double)time; 

Parameters

image

Variable for a pointer to a texture. (NOTE: this texture must be released by the sender when processing is complete).

renderInfo

Information about the requested image, including quality, scale, and bitdepth.

time

Specified time, expressed in canonical frames, to get the image.

Return Value

Returns YES if the input texture is retrieved successfully; 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