ComponentParam

Since: 25.6

Properties

Name

Type

Access

Min Version

Description

displayName

string

25.6

Returns the display name of the component param

Instance Methods

areKeyframesSupported

Returns bool whether keyframes are supported for this component parameter

Since: 25.6

Returns: Promise<boolean>

createAddKeyframeAction

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

Since: 25.6

Returns: Action

Parameters

Name

Type

Description

inKeyFrame

Keyframe

createKeyframe

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

Since: 25.6

Returns: Keyframe

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

Returns an action which removes keyframe at specific time

Since: 25.6

Returns: Action

Parameters

Name

Type

Description

inTime

TickTime

UpdateUI

boolean

createRemoveKeyframeRangeAction

Returns an action which removes keyframe at specific time range

Since: 25.6

Returns: Action

Parameters

Name

Type

Description

inTime

TickTime

outTime

TickTime

UpdateUI

boolean

createSetInterpolationAtKeyframeAction

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

Since: 25.6

Returns: Action

Parameters

Name

Type

Description

inTime

TickTime

InterpolationMode

number

UpdateUI

boolean

createSetTimeVaryingAction

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

Since: 25.6

Returns: Action

Parameters

Name

Type

Description

inTimeVarying

boolean

createSetValueAction

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

Since: 25.6

Returns: Action

Parameters

Name

Type

Description

inKeyFrame

Keyframe

inSafeForPlayback

boolean

findNearestKeyframe

Find sthe nearest key for the given time

Since: 25.6

Returns: Keyframe

Parameters

Name

Type

Description

inTime

TickTime

outTime

TickTime

findNextKeyframe

find the next keyframe for the given time

Since: 25.6

Returns: Keyframe

Parameters

Name

Type

Description

inTime

TickTime

findPreviousKeyframe

find the previous keyframe for the given time

Since: 25.6

Returns: Keyframe

Parameters

Name

Type

Description

inTime

TickTime

getKeyframeListAsTickTimes

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

Since: 25.6

Returns: TickTime[]

getKeyframePtr

Get the Keyframe at the given tickTime postion

Since: 25.6

Returns: Keyframe

Parameters

Name

Type

Description

time

TickTime

getStartValue

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

Since: 25.6

Returns: Promise<Keyframe>

getValueAtTime

Gets the value of component Param at the given time

Since: 25.6

Returns: Promise<*number | string | boolean | PointF | Color*>

Parameters

Name

Type

Description

time

TickTime

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

isTimeVarying

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

Since: 25.6

Returns: boolean