Class Audio

Type-safe version of EventEmitter

Hierarchy (view full)

EventEmitter<AudioEventDataMap>
- Audio

Index

Constructors

Properties

Methods

dispose getElement getMuted getPaused mute off on once pause play remove unmute volume

Constructors

constructor

new Audio(opt): Audio
Parameters
- opt: IAudioOptions & {
  audioElement: HTMLAudioElement;
  id: string;
  }
Returns Audio
Overrides EventEmitter.constructor
- Defined in packages/core/src/media/base-audio.ts:24

Properties

id

id: string

src

src: string

topics

topics: Record<keyof AudioEventDataMap, ITopic<any>[]> = ...

Methods

dispose

dispose(): void
移除所有的监听事件

Returns void
Inherited from EventEmitter.dispose
- Defined in packages/core/src/misc/emitter.ts:142

getElement

getElement(): HTMLAudioElement
Returns HTMLAudioElement
- Defined in packages/core/src/media/base-audio.ts:135

getMuted

getMuted(): boolean
Returns boolean
- Defined in packages/core/src/media/base-audio.ts:108

getPaused

getPaused(): boolean
Returns boolean
- Defined in packages/core/src/media/base-audio.ts:101

mute

mute(): void
Returns void
- Defined in packages/core/src/media/base-audio.ts:122

off

off<K>(topic, listener?): void
移除监听事件
Type Parameters
- K extends keyof AudioEventDataMap
Parameters
- topic: K
- Optional listener: IListener<AudioEventDataMap[K]>
Returns void
Inherited from EventEmitter.off
- Defined in packages/core/src/misc/emitter.ts:84

on

on<K>(topic, listener, order?): {
unsub: (() => void);
}
添加事件监听器
Type Parameters
- K extends keyof AudioEventDataMap
Parameters
- topic: K
- listener: IListener<AudioEventDataMap[K]>
- Optional order: number
Returns {
unsub: (() => void);
}
- unsub: (() => void)
  - - (): void
    - Returns void
Inherited from EventEmitter.on
- Defined in packages/core/src/misc/emitter.ts:35

once

once<K>(topic, listener, order?): {
unsub: (() => void);
}
添加事件监听器，单个 listener 只执行1次
Type Parameters
- K extends keyof AudioEventDataMap
Parameters
- topic: K
- listener: IListener<AudioEventDataMap[K]>
- Optional order: number
Returns {
unsub: (() => void);
}
- unsub: (() => void)
  - - (): void
    - Returns void
Inherited from EventEmitter.once
- Defined in packages/core/src/misc/emitter.ts:46

pause

pause(): void
Returns void
- Defined in packages/core/src/media/base-audio.ts:94

play

play(src?, loop?): void
Parameters
- Optional src: string
- Optional loop: boolean
Returns void
- Defined in packages/core/src/media/base-audio.ts:51

remove

remove(): void
Returns void
- Defined in packages/core/src/media/base-audio.ts:139

unmute

unmute(): void
Returns void
- Defined in packages/core/src/media/base-audio.ts:128

volume

volume(v): void
Parameters
- v: number
Returns void
- Defined in packages/core/src/media/base-audio.ts:116

Generated using TypeDoc