ComponentParam

Properties

Name

Type

Access

Min Version

Description

displayName

string

25.0

Returns the display name of the component param

Instance Methods

areKeyframesSupported

25.0

boolean

Returns bool whether keyframes are supported for this component parameter

createAddKeyframeAction

25.0

Action

Creates and returns an action object which can be used to add a keyframe component

Parameters

Name

Type

Description

inKeyFrame

Keyframe

createKeyframe

25.0

Keyframe

Creates and returns a keyframe initialised with the ComponentParam's type and passed in value. This throws if the passed in value is not compatible with the component param type

Parameters

Name

Type

Description

inValue

number or string or boolean or PointF or Color

Input could be number, string, boolean, PointF, or Color depend on effect param type

createRemoveKeyframeAction

25.0

Action

Returns an action which removes keyframe at specific time

Parameters

Name

Type

Description

inTime

TickTime

UpdateUI

boolean

createRemoveKeyframeRangeAction

25.0

Action

Returns an action which removes keyframe at specific time range

Parameters

Name

Type

Description

inTime

TickTime

outTime

TickTime

UpdateUI

boolean

createSetInterpolationAtKeyframeAction

25.0

Action

Returns an action which sets the interpolation mode of keyframe at the given time

Parameters

Name

Type

Description

inTime

TickTime

InterpolationMode

number

UpdateUI

boolean

createSetTimeVaryingAction

25.0

Action

Creates and returns an action object to set the component to be time varying

Parameters

Name

Type

Description

inTimeVarying

boolean

createSetValueAction

25.0

Action

Creates and returns an action object which can be used to set the value of a non-time varying component

Parameters

Name

Type

Description

inKeyFrame

Keyframe

inSafeForPlayback

boolean

findNearestKeyframe

25.0

Keyframe

Find sthe nearest key for the given time

Parameters

Name

Type

Description

inTime

TickTime

outTime

TickTime

findNextKeyframe

25.0

Keyframe

find the next keyframe for the given time

Parameters

Name

Type

Description

inTime

TickTime

findPreviousKeyframe

25.0

Keyframe

find the previous keyframe for the given time

Parameters

Name

Type

Description

inTime

TickTime

getKeyframeListAsTickTimes

25.0

TickTime[]

Get a list of tickTime for the keyframes of this component param

getKeyframePtr

25.0

Keyframe

Get the Keyframe at the given tickTime postion

Parameters

Name

Type

Description

time

TickTime

getStartValue

25.0

Keyframe

Returned promise will be fullfilled with the start value (keyframe) of the component param

getValueAtTime

25.0

number | string | boolean | PointF | Color

Gets the value of component Param at the given time

Parameters

Name

Type

Description

time

TickTime

The time at which to get the value of the component param

isTimeVarying

25.0

boolean

Returns true if the parameter value varies over time (for the duration of the item)