Class PreciseAudioEvent

An event triggered by a PreciseAudio object.

Package: @synesthesia-project/precise-audio

Constructors

PreciseAudioEvent(EventTypes, PreciseAudio)

Declaration

new PreciseAudioEvent(eventType: EventTypes, target: PreciseAudio)

Parameters

Type	Name	Description
EventTypes	eventType
PreciseAudio	target

Properties

AT_TARGET

Declaration

AT_TARGET: number

Property Value

Type	Description
number

bubbles

Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise.

Declaration

bubbles: boolean

Property Value

Type	Description
boolean

BUBBLING_PHASE

Declaration

BUBBLING_PHASE: number

Property Value

Type	Description
number

cancelable

Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method.

Declaration

cancelable: boolean

Property Value

Type	Description
boolean

cancelBubble

Declaration

cancelBubble: boolean

Property Value

Type	Description
boolean

CAPTURING_PHASE

Declaration

CAPTURING_PHASE: number

Property Value

Type	Description
number

composed

Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise.

Declaration

composed: boolean

Property Value

Type	Description
boolean

currentTarget

Declaration

PreciseAudio currentTarget

Property Value

Type	Description
PreciseAudio

defaultPrevented

Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.

Declaration

defaultPrevented: boolean

Property Value

Type	Description
boolean

Event

Declaration

static Event: Object

Property Value

Type	Description
Object

eventPhase

Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.

Declaration

eventPhase: number

Property Value

Type	Description
number

isTrusted

Returns true if event was dispatched by the user agent, and false otherwise.

Declaration

isTrusted: boolean

Property Value

Type	Description
boolean

NONE

Declaration

NONE: number

Property Value

Type	Description
number

returnValue

Declaration

returnValue: boolean

Property Value

Type	Description
boolean

srcElement

Declaration

srcElement: EventTarget | null

Property Value

Type	Description
EventTarget | null

target

Declaration

PreciseAudio target

Property Value

Type	Description
PreciseAudio

timeStamp

Returns the event's timestamp as the number of milliseconds measured relative to the time origin.

Declaration

timeStamp: number

Property Value

Type	Description
number

type

Returns the type of event, e.g. "click", "hashchange", or "submit".

Declaration

type: string

Property Value

Type	Description
string

Methods

composedPath()

Returns the invocation target objects of event's path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root's mode is "closed" that are not reachable from event's currentTarget.

Declaration

function composedPath()

Returns

Type	Description
EventTarget[]

initEvent(string, boolean, boolean)

Declaration

function initEvent(type: string, bubbles?: boolean, cancelable?: boolean)

Parameters

Type	Name	Description
string	type
boolean	bubbles
boolean	cancelable

preventDefault()

If invoked when the cancelable attribute value is true, and while executing a listener for the event with passive set to false, signals to the operation that caused event to be dispatched that it needs to be canceled.

Declaration

function preventDefault()

stopImmediatePropagation()

Invoking this method prevents event from reaching any registered event listeners after the current one finishes running and, when dispatched in a tree, also prevents event from reaching any other objects.

Declaration

function stopImmediatePropagation()

stopPropagation()

When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object.

Declaration

function stopPropagation()