FxTemporalTransitionImageAPI

Introduction

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

Discussion

Usually the only plug-in that needs to use this host API is an FxTransition 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

-getTransitionInputImage:forInput:applyFilters:withImageType:withInfo:atTime:

Gets an image from the transition's A or B input.

-getTransitionInputImage:forInput:withFiltersApplied:withImageType:withInfo:atTime:

Gets an image from the transition's A or B input.

Gets an image from the transition's A or B input.

getTransitionInputImage:forInput:withFiltersApplied:withImageType:withInfo:atTime:

- (BOOL)getTransitionInputImage:(FxImage **)image forInput:(FxTransitionInput)whichInput applyFilters:(BOOL)applyFilters withImageType:(FxImageType)imageType withInfo:(FxRenderInfo)renderInfo atTime:(double)time; 

Parameters

image

Variable for a pointer to an FxBitmap or FxTexture. (NOTE: the object must be released by the sender when processing is complete.)

whichInput

Which transition input (kFxTransitionInput_A or kFxTransitionInput_B).

applyFilters

YES if leading filters are to be applied, NO for raw source footage.

imageType

Which subclass of FxImage to use (kFxImageType_Bitmap or kFxImageType_Texture).

renderInfo

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

time

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

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 an image from the transition's A or B input.

getTransitionInputImage:forInput:applyFilters:withImageType:withInfo:atTime:

- (BOOL)getTransitionInputImage:(FxImage **)image forInput:(FxTransitionInput)whichInput applyFilters:(BOOL)applyFilters withImageType:(FxImageType)imageType withInfo:(FxRenderInfo)renderInfo atTime:(double)time; 

Parameters

image

Variable for a pointer to an FxBitmap or FxTexture. (NOTE: the object must be released by the sender when processing is complete.)

whichInput

Which transition input (kFxTransitionInput_A or kFxTransitionInput_B).

applyFilters

YES if leading filters are to be applied, NO for raw source footage.

imageType

Which subclass of FxImage to use (kFxImageType_Bitmap or kFxImageType_Texture).

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.

Enumerations

private

enum { 
    kFxTransitionInput_A = 0, 
    kFxTransitionInput_B = 1 
};

Constants

kFxTransitionInput_A

The first transition input.

kFxTransitionInput_B

The second transition input.

Discussion

Constants used to identify one of the two inputs to a transition.

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