time.js

Methods

(static) createTimeRanges(start, end) → {TimeRange}

Create a TimeRange object which mimics an HTML5 TimeRanges instance.

Parameters:
NameTypeDescription
startnumber | Array.<Array>

The start of a single range (a number) or an array of ranges (an array of arrays of two numbers each).

endnumber

The end of a single range. Cannot be used with the array form of the start argument.

Returns:
Type: 
TimeRange

(static) formatTime(seconds, guide) → {string}

Delegates to either the default time formatting function or a custom function supplied via setFormatTime.

Formats seconds as a time string (H:MM:SS or M:SS). Supplying a guide (in seconds) will force a number of leading zeros to cover the length of the guide.

Parameters:
NameTypeDescription
secondsnumber

Number of seconds to be turned into a string

guidenumber

Number (in seconds) to model the string after

Returns:

Time formatted as H:MM:SS or M:SS

Type: 
string
Example
formatTime(125, 600) === "02:05"

(static) resetFormatTime()

Resets formatTime to the default implementation.

(static) setFormatTime(customImplementation)

Replaces the default formatTime implementation with a custom implementation.

Parameters:
NameTypeDescription
customImplementationfunction

A function which will be used in place of the default formatTime implementation. Will receive the current time in seconds and the guide (in seconds) as arguments.

Type Definitions

TimeRange

An object that contains ranges of time, which mimics TimeRanges.

Type:
  • Object
Properties
NameTypeDescription
lengthnumber

The number of time ranges represented by this object.

startmodule:time~TimeRangeIndex

Returns the time offset at which a specified time range begins.

endmodule:time~TimeRangeIndex

Returns the time offset at which a specified time range ends.

TimeRangeIndex(indexopt) → {number}

Returns the time for the specified index at the start or end of a TimeRange object.

Parameters:
NameTypeAttributesDefaultDescription
indexnumber<optional>
0

The range number to return the time for.

Deprecated
  • The index argument must be provided. In the future, leaving it out will throw an error.
Returns:

The time offset at the specified index.

Type: 
number