API Reference / Sound

# Class: Sound

# Hierarchy

Media

↳ Sound

# Table of contents

# Constructors

constructor

# Properties

# Accessors

# Methods

# Constructors

# constructor

• new Sound(stage, url?)

# Parameters

Name	Type
`stage`	`Stage`
`url?`	`string`

# Overrides

Media.constructor

# Defined in

media/Sound.ts:13 (opens new window)

# Properties

# $boundOnError

• Protected Readonly $boundOnError: (e: ErrorEvent) => void

# Type declaration

▸ (e): void

# Parameters

Name	Type
`e`	`ErrorEvent`

# Returns

void

# Inherited from

Media.$boundOnError

# Defined in

media/Media.ts:13 (opens new window)

# $boundOnLoad

• Protected Readonly $boundOnLoad: () => void

# Type declaration

▸ (): void

# Returns

void

# Inherited from

Media.$boundOnLoad

# Defined in

media/Media.ts:12 (opens new window)

# $boundOnTouch

• Protected Readonly $boundOnTouch: () => void

# Type declaration

▸ (): void

# Returns

void

# Defined in

media/Sound.ts:11 (opens new window)

# $element

• Protected Readonly $element: HTMLAudioElement

# Overrides

Media.$element

# Defined in

media/Sound.ts:10 (opens new window)

# $emittingType

• Protected $emittingType: string = null

# Inherited from

Media.$emittingType

# Defined in

event/EventEmitter.ts:6 (opens new window)

# $errored

• Protected $errored: boolean = false

# Inherited from

Media.$errored

# Defined in

media/Media.ts:10 (opens new window)

# $events

• Protected $events: Object = {}

# Inherited from

Media.$events

# Defined in

event/EventEmitter.ts:5 (opens new window)

# $loaded

• Protected $loaded: boolean = false

# Inherited from

Media.$loaded

# Defined in

media/Media.ts:9 (opens new window)

# $loops

• Protected $loops: number = 1

# Defined in

media/Sound.ts:7 (opens new window)

# $paused

• Protected $paused: boolean = true

# Defined in

media/Sound.ts:9 (opens new window)

# $removedListeners

• Protected $removedListeners: Listener[] = []

# Inherited from

Media.$removedListeners

# Defined in

event/EventEmitter.ts:7 (opens new window)

# $stage

• Protected Readonly $stage: Stage

# Inherited from

Media.$stage

# Defined in

media/Media.ts:11 (opens new window)

# $startTime

• Protected $startTime: number = 0

# Defined in

media/Sound.ts:8 (opens new window)

# Accessors

# element

• get element(): HTMLAudioElement

# Returns

HTMLAudioElement

# Overrides

Media.element

# Defined in

media/Sound.ts:30 (opens new window)

# paused

• get paused(): boolean

# Returns

boolean

# Defined in

media/Sound.ts:55 (opens new window)

# url

• get url(): string

# Returns

string

# Overrides

Media.url

# Defined in

media/Sound.ts:34 (opens new window)

• set url(url): void

# Parameters

Name	Type
`url`	`string`

# Returns

void

# Overrides

Media.url

# Defined in

media/Sound.ts:38 (opens new window)

# volume

• get volume(): number

# Returns

number

# Defined in

media/Sound.ts:47 (opens new window)

• set volume(volume): void

# Parameters

Name	Type
`volume`	`number`

# Returns

void

# Defined in

media/Sound.ts:51 (opens new window)

# Methods

# $checkOnTouch

▸ Protected $checkOnTouch(): void

# Returns

void

# Defined in

media/Sound.ts:74 (opens new window)

# $checkStatus

▸ Protected $checkStatus(): void

# Returns

void

# Defined in

media/Sound.ts:79 (opens new window)

# $onEnded

▸ Protected $onEnded(): void

# Returns

void

# Defined in

media/Sound.ts:95 (opens new window)

# $onError

▸ Protected $onError(): void

# Returns

void

# Inherited from

Media.$onError

# Defined in

media/Media.ts:56 (opens new window)

# $onLoad

▸ Protected $onLoad(): void

# Returns

void

# Overrides

Media.$onLoad

# Defined in

media/Sound.ts:125 (opens new window)

# $onRemovedFromStage

▸ Protected $onRemovedFromStage(): void

# Returns

void

# Defined in

media/Sound.ts:119 (opens new window)

# $onTickerPause

▸ Protected $onTickerPause(): void

# Returns

void

# Defined in

media/Sound.ts:107 (opens new window)

# $onTickerResume

▸ Protected $onTickerResume(): void

# Returns

void

# Defined in

media/Sound.ts:113 (opens new window)

# $onTouch

▸ Protected $onTouch(): void

# Returns

void

# Defined in

media/Sound.ts:89 (opens new window)

# emit

▸ emit(event): boolean

# Parameters

Name	Type
`event`	`Event`

# Returns

boolean

# Inherited from

Media.emit

# Defined in

event/EventEmitter.ts:42 (opens new window)

▸ emit(type, ...args): boolean

# Parameters

Name	Type
`type`	`string`
`...args`	`any`[]

# Returns

boolean

# Inherited from

Media.emit

# Defined in

event/EventEmitter.ts:43 (opens new window)

# hasEventListener

▸ hasEventListener(type): boolean

# Parameters

Name	Type
`type`	`string`

# Returns

boolean

# Inherited from

Media.hasEventListener

# Defined in

event/EventEmitter.ts:80 (opens new window)

# off

▸ off(type, listener?): Sound

# Parameters

Name	Type
`type`	`string`
`listener?`	`Listener`

# on

▸ on(type, listener): Sound

# Parameters

Name	Type
`type`	`string`
`listener`	(...`args`: `any`[]) => `void`

# Returns

Sound

# Inherited from

Media.on

# Defined in

media/Media.ts:36 (opens new window)

# once

▸ once(type, listener): Sound

# Parameters

Name	Type
`type`	`string`
`listener`	`Listener`

# Returns

Sound

# Inherited from

Media.once

# Defined in

event/EventEmitter.ts:33 (opens new window)

# play

▸ play(startTime?, loops?): Sound

# Parameters

Name	Type	Default value
`startTime`	`number`	`0`
`loops`	`number`	`1`

# Returns

Sound

# Defined in

media/Sound.ts:59 (opens new window)

# removeAllListeners

▸ removeAllListeners(): Sound

# Returns

Sound

# Inherited from

Media.removeAllListeners

# Defined in

event/EventEmitter.ts:85 (opens new window)

# stop

▸ stop(): Sound

# Returns

Sound

# Defined in

media/Sound.ts:68 (opens new window)