Object

TickTime

TickTime class

Properties

Name	Type	Access	Description
static	TickTime	readonly	Invalid Tick Time Constant
static	TickTime	readonly	Max Tick Time Constant
static	TickTime	readonly	Min Tick Time Constant
static	TickTime	readonly	One Hour Tick Time Constant
static	TickTime	readonly	One Second Tick Time Constant
static	TickTime	readonly	One Second Tick Time Constant
static	TickTime	readonly	Zero Tick Time Constant
	Number	readonly	Get the TickTime in seconds
	String	readonly	Get the TickTime in ticks as a string
	Number	readonly	Get the TickTime in ticks as a number

Methods

→ TickTime

Constructs a TickTime object

→ TickTime

Add another TickTime to this one and return it. This TickTime is not modified.

tickTime TickTime

→ TickTime

alignToFrame will return a TickTime that is aligned to the nearest frame boundary less than the given time for a given frame rate by rounding any fractional portion.

frameRate FrameRate

→ TickTime

AlignToNearestFrame will return a TickTime that is aligned to the nearest frame boundary greater than or less than the given time for a given frame rate by rounding any fractional portion.

frameRate FrameRate

static → TickTime

Constructs a TickTime object with a frame and a frame rate.

frameCount Number

frameRate FrameRate

static → TickTime

Constructs a TickTime object with seconds.

seconds Number

static → TickTime

Constructs a TickTime object with ticks as a string.

ticks String

static → TickTime

Constructs a TickTime object with ticks as a number.

ticksNumber Number

→ TickTime

Divide this TickTime by a divisor and return it. In case of a division by zero TIME_INVALID is returned. This TickTime is not modified.

divisor Number

→ Boolean

Returns true if the given TickTime is equal to the TickTime object

tickTime TickTime

→ TickTime

Multiply this TickTime with a factor and return it. This TickTime is not modified.

factor Number

→ TickTime

Subtract another TickTime from this one and return it. This TickTime is not modified.

tickTime TickTime

static → String

Convert a TickTime to a string using the current display format

tickTime TickTime

frameRate FrameRate

timeDisplay TimeDisplay

static → TickTime

Convert a timecode string to a TickTime using the current display format

timecode String

frameRate FrameRate

timeDisplay TimeDisplay

→ Number

Convert the TickTime to a frame number with respect to the provided frame rate.

frameRate FrameRate

Object of 7

Properties elsewhere that hold a TickTime.

TickTime.TIME_INVALID TickTime.TIME_MAX TickTime.TIME_MIN TickTime.TIME_ONE_HOUR TickTime.TIME_ONE_MINUTE TickTime.TIME_ONE_SECOND TickTime.TIME_ZERO

Parameter of 7

Method parameters that accept a TickTime.

TickTime.add(tickTime)TickTime.equals(tickTime)TickTime.subtract(tickTime)TickTime.timeToTimecode(tickTime)TimeRange.contains(time)TimeRange.createWithStartAndEnd(startTime)TimeRange.extend(time)

Return 12

Methods that return a TickTime.

TickTime.TickTime()TickTime.add()TickTime.alignToFrame()TickTime.alignToNearestFrame()TickTime.createWithFrameAndFrameRate()TickTime.createWithSeconds()TickTime.createWithTicks()TickTime.createWithTicksNumber()TickTime.divide()TickTime.multiply()TickTime.subtract()TickTime.timecodeToTime()