Class: TransitionNode

TransitionNode()

new TransitionNode()

Initialise an instance of a TransitionNode. You should not instantiate this directly, but use VideoContest.createTransitonNode().

Source:

Methods

clearTransition(propertyName, time) → {Boolean}

Clear a transistion on the passed property that the specified time lies within.

Parameters:
Name Type Description
propertyName String

The name of the property to clear a transition on.

time number

A time which lies within the property you're trying to clear.

Source:
Returns:

returns True if a transition is removed, false otherwise.

Type
Boolean

clearTransition(propertyName, time) → {Boolean}

Clear a transistion on the passed property that the specified time lies within.

Parameters:
Name Type Description
propertyName String

The name of the property to clear a transition on.

time number

A time which lies within the property you're trying to clear.

Source:
Returns:

returns True if a transition is removed, false otherwise.

Type
Boolean

clearTransitions(propertyName)

Clear all transistions on the passed property. If no property is defined clear all transitions on the node.

Parameters:
Name Type Description
propertyName String

The name of the property to clear transitions on, if undefined clear all transitions on the node.

Source:

clearTransitions(propertyName)

Clear all transistions on the passed property. If no property is defined clear all transitions on the node.

Parameters:
Name Type Description
propertyName String

The name of the property to clear transitions on, if undefined clear all transitions on the node.

Source:

transition(startTime, endTime, currentValue, targetValue, propertyName) → {Boolean}

Create a transition on the timeline.

Parameters:
Name Type Default Description
startTime number

The time at which the transition should start (relative to currentTime of video context).

endTime number

The time at which the transition should be completed by (relative to currentTime of video context).

currentValue number

The value to start the transition at.

targetValue number

The value to transition to by endTime.

propertyName String mix

The name of the property to clear transitions on, if undefined default to "mix".

Source:
Returns:

returns True if a transition is successfully added, false otherwise.

Type
Boolean

transition(startTime, endTime, currentValue, targetValue, propertyName) → {Boolean}

Create a transition on the timeline.

Parameters:
Name Type Default Description
startTime number

The time at which the transition should start (relative to currentTime of video context).

endTime number

The time at which the transition should be completed by (relative to currentTime of video context).

currentValue number

The value to start the transition at.

targetValue number

The value to transition to by endTime.

propertyName String mix

The name of the property to clear transitions on, if undefined default to "mix".

Source:
Returns:

returns True if a transition is successfully added, false otherwise.

Type
Boolean

transitionAt(startTime, endTime, currentValue, targetValue, propertyName) → {Boolean}

Create a transition on the timeline at an absolute time.

Parameters:
Name Type Default Description
startTime number

The time at which the transition should start (relative to time 0).

endTime number

The time at which the transition should be completed by (relative to time 0).

currentValue number

The value to start the transition at.

targetValue number

The value to transition to by endTime.

propertyName String mix

The name of the property to clear transitions on, if undefined default to "mix".

Source:
Returns:

returns True if a transition is successfully added, false otherwise.

Type
Boolean

transitionAt(startTime, endTime, currentValue, targetValue, propertyName) → {Boolean}

Create a transition on the timeline at an absolute time.

Parameters:
Name Type Default Description
startTime number

The time at which the transition should start (relative to time 0).

endTime number

The time at which the transition should be completed by (relative to time 0).

currentValue number

The value to start the transition at.

targetValue number

The value to transition to by endTime.

propertyName String mix

The name of the property to clear transitions on, if undefined default to "mix".

Source:
Returns:

returns True if a transition is successfully added, false otherwise.

Type
Boolean

TransitionNode()

new TransitionNode()

Initialise an instance of a TransitionNode. You should not instantiate this directly, but use VideoContest.createTransitonNode().

Source:

Methods

clearTransition(propertyName, time) → {Boolean}

Clear a transistion on the passed property that the specified time lies within.

Parameters:
Name Type Description
propertyName String

The name of the property to clear a transition on.

time number

A time which lies within the property you're trying to clear.

Source:
Returns:

returns True if a transition is removed, false otherwise.

Type
Boolean

clearTransition(propertyName, time) → {Boolean}

Clear a transistion on the passed property that the specified time lies within.

Parameters:
Name Type Description
propertyName String

The name of the property to clear a transition on.

time number

A time which lies within the property you're trying to clear.

Source:
Returns:

returns True if a transition is removed, false otherwise.

Type
Boolean

clearTransitions(propertyName)

Clear all transistions on the passed property. If no property is defined clear all transitions on the node.

Parameters:
Name Type Description
propertyName String

The name of the property to clear transitions on, if undefined clear all transitions on the node.

Source:

clearTransitions(propertyName)

Clear all transistions on the passed property. If no property is defined clear all transitions on the node.

Parameters:
Name Type Description
propertyName String

The name of the property to clear transitions on, if undefined clear all transitions on the node.

Source:

transition(startTime, endTime, currentValue, targetValue, propertyName) → {Boolean}

Create a transition on the timeline.

Parameters:
Name Type Default Description
startTime number

The time at which the transition should start (relative to currentTime of video context).

endTime number

The time at which the transition should be completed by (relative to currentTime of video context).

currentValue number

The value to start the transition at.

targetValue number

The value to transition to by endTime.

propertyName String mix

The name of the property to clear transitions on, if undefined default to "mix".

Source:
Returns:

returns True if a transition is successfully added, false otherwise.

Type
Boolean

transition(startTime, endTime, currentValue, targetValue, propertyName) → {Boolean}

Create a transition on the timeline.

Parameters:
Name Type Default Description
startTime number

The time at which the transition should start (relative to currentTime of video context).

endTime number

The time at which the transition should be completed by (relative to currentTime of video context).

currentValue number

The value to start the transition at.

targetValue number

The value to transition to by endTime.

propertyName String mix

The name of the property to clear transitions on, if undefined default to "mix".

Source:
Returns:

returns True if a transition is successfully added, false otherwise.

Type
Boolean

transitionAt(startTime, endTime, currentValue, targetValue, propertyName) → {Boolean}

Create a transition on the timeline at an absolute time.

Parameters:
Name Type Default Description
startTime number

The time at which the transition should start (relative to time 0).

endTime number

The time at which the transition should be completed by (relative to time 0).

currentValue number

The value to start the transition at.

targetValue number

The value to transition to by endTime.

propertyName String mix

The name of the property to clear transitions on, if undefined default to "mix".

Source:
Returns:

returns True if a transition is successfully added, false otherwise.

Type
Boolean

transitionAt(startTime, endTime, currentValue, targetValue, propertyName) → {Boolean}

Create a transition on the timeline at an absolute time.

Parameters:
Name Type Default Description
startTime number

The time at which the transition should start (relative to time 0).

endTime number

The time at which the transition should be completed by (relative to time 0).

currentValue number

The value to start the transition at.

targetValue number

The value to transition to by endTime.

propertyName String mix

The name of the property to clear transitions on, if undefined default to "mix".

Source:
Returns:

returns True if a transition is successfully added, false otherwise.

Type
Boolean