Methods

static createTimeRanges(start, end) → {module:time~TimeRange}

utils/time.js, line 141

Create a TimeRange object which mimics an HTML5 TimeRanges instance.

Parameters:

Name	Type	Description
start	number | Array.<Array>	The start of a single range (a number) or an array of ranges (an array of arrays of two numbers each).
end	number	The end of a single range. Cannot be used with the array form of the start argument.

Returns:

module:time~TimeRange

static formatTime(seconds, guide) → {string}

utils/time.js, line 235

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:

Name	Type	Description
seconds	number	Number of seconds to be turned into a string
guide	number	Number (in seconds) to model the string after

Returns:

string -

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

Example

formatTime(125, 600) === "02:05"

static resetFormatTime()

utils/time.js, line 213

Resets formatTime to the default implementation.

static setFormatTime(customImplementation)

utils/time.js, line 206

Replaces the default formatTime implementation with a custom implementation.

Parameters:

Name	Type	Description
customImplementation	function	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

utils/time.js, line 23

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

Properties:

Name	Type	Description
length	number	The number of time ranges represented by this object.
start	module:time~module:time~TimeRangeIndex	Returns the time offset at which a specified time range begins.
end	module:time~module:time~TimeRangeIndex	Returns the time offset at which a specified time range ends.

See:

• https://developer.mozilla.org/en-US/docs/Web/API/TimeRanges

TimeRangeIndex(indexopt) → {number}

utils/time.js, line 7

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

Parameters:

Name	Type	Attributes	Default	Description
index	number	<optional>	0	The range number to return the time for.

Returns:

number -

The time offset at the specified index.

Deprecated:

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