Class AsyncMedia`Abstract`

A base class that can be listened to, and dispatch events.

Hierarchy (view full)

Notifier<BackingMediaEventType>
- AsyncMedia
  - EffectMedia
  - TextMedia

Index

Constructors

Properties

currentFrame height listeners presentationHash width

Methods

addEventListener dispatchEvent dispatchToListener removeEventListener

Constructors

constructor

new AsyncMedia(): AsyncMedia
Returns AsyncMedia
Inherited from Notifier.constructor

Properties

`Abstract` `Readonly`currentFrame

currentFrame: null | FastCanvasImageSource

`Abstract` `Readonly`height

height: number

`Protected` `Readonly`listeners

listeners: ConcurrentCollection<Listener<BackingMediaEventType>> = ...

`Abstract` `Readonly`presentationHash

presentationHash: number

`Abstract` `Readonly`width

width: number

Methods

addEventListener

addEventListener(listener): void
Listen to events from this helper. Duplicate listeners allowed.
Parameters
- listener: Listener<BackingMediaEventType>
Returns void
Inherited from Notifier.addEventListener
- Defined in src/helpers/Notifier.ts:19

`Protected`dispatchEvent

dispatchEvent(event): void
Dispatch an event to all listeners.
Parameters
- event: BackingMediaEventType
Returns void
Inherited from Notifier.dispatchEvent
- Defined in src/helpers/Notifier.ts:46

`Protected`dispatchToListener

dispatchToListener(event, listener): void
Dispatch an event to a specific listener. Listener does not have to be added
Parameters
- event: BackingMediaEventType
- listener: Listener<BackingMediaEventType>
Returns void
Inherited from Notifier.dispatchToListener
- Defined in src/helpers/Notifier.ts:37

removeEventListener

removeEventListener(listener): boolean
Stop listening to events from this helper. If a duplicate listener is removed, only one is removed.
Parameters
- listener: Listener<BackingMediaEventType>
Returns boolean
True if a listener was removed, false otherwise.
Inherited from Notifier.removeEventListener
- Defined in src/helpers/Notifier.ts:29