CuePoint

Defined in: core/source/cuepoint.ts:6

A CuePoint represents a configurable object for sources that support cue points. Check getCuePoints() and other related methods of #core/ISourcePlayback#getCuePoints getCuePoints.

Constructors

Constructor

new CuePoint(time, action): CuePoint

Defined in: core/source/cuepoint.ts:10

Parameters

time

number

action

string

Returns

CuePoint

Properties

CUT

static CUT: string = 's'

Defined in: core/source/cuepoint.ts:69

---

PAUSE

static PAUSE: string = 'p'

Defined in: core/source/cuepoint.ts:67

---

RESUME

static RESUME: string = 'r'

Defined in: core/source/cuepoint.ts:68

Methods

getAction()

getAction(): string

Defined in: core/source/cuepoint.ts:58

return: string

Gets the action to be performed on the cue point, which may be any of the following: CuePoint.PAUSE, CuePoint.RESUME, CuePoint.CUT.

Returns

string

---

getTime()

getTime(): number

Defined in: core/source/cuepoint.ts:48

return: number

Gets the time in seconds corresponding to this cue point, with precision up to 100ns.

Returns

number

---

setAction()

setAction(action): void

Defined in: core/source/cuepoint.ts:34

param: string

Sets the action to be performed on the cue point. Choose any of the following values: CuePoint.PAUSE, CuePoint.RESUME, CuePoint.CUT.

Parameters

action

string

Returns

void

---

setTime()

setTime(time): void

Defined in: core/source/cuepoint.ts:24

param: number

Sets this cue point’s time in seconds, with precision up to 100ns.

Parameters

time

number

Returns

void

---

toString()

toString(): string

Defined in: core/source/cuepoint.ts:15

Returns

string

---

_fromString()

static _fromString(value): CuePoint

Defined in: core/source/cuepoint.ts:62

Parameters

value

string

Returns

CuePoint