Class Video

Type-safe version of EventEmitter

Hierarchy (view full)

EventEmitter<VideoEventDataMap>
- Video

Index

Constructors

Properties

id src topics videoElement

Methods

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

Constructors

constructor

new Video(opt): Video
Parameters
- opt: IVideoOptions & {
  id: string;
  videoElement: HTMLVideoElement;
  }
Returns Video
Overrides EventEmitter.constructor
- Defined in packages/core/src/media/base-video.ts:50

Properties

id

id: string

src

src: string

topics

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

videoElement

videoElement: HTMLVideoElement

Methods

dispose

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

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

getElement

getElement(): HTMLVideoElement
Returns HTMLVideoElement
- Defined in packages/core/src/media/base-video.ts:307

getMuted

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

getPaused

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

getVideoContainer

getVideoContainer(): undefined | HTMLDivElement
Returns undefined | HTMLDivElement
- Defined in packages/core/src/media/base-video.ts:299

mute

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

off

off<K>(topic, listener?): void
移除监听事件
Type Parameters
- K extends keyof VideoEventDataMap
Parameters
- topic: K
- Optional listener: IListener<VideoEventDataMap[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 VideoEventDataMap
Parameters
- topic: K
- listener: IListener<VideoEventDataMap[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 VideoEventDataMap
Parameters
- topic: K
- listener: IListener<VideoEventDataMap[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-video.ts:277

play

play(src?): void
Parameters
- src: string = ''
Returns void
- Defined in packages/core/src/media/base-video.ts:152

remove

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

unmute

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

volume

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

Generated using TypeDoc