@auvious/media-tools / MediaEffect

Class: MediaEffect

Generic for input

Hierarchy

• MediaEffect

  ↳ AudioVisualizerEffect

Implements

• IMediaEffect

Table of contents

Constructors

• constructor

Properties

• events
• name

Methods

• emitOutput
• emitUnload
• onOutput
• onUnload
• setInput

Constructors

constructor

• new MediaEffect(): MediaEffect

Returns

MediaEffect

Properties

events

• Private events: Events<IMediaEffectEvents>

---

name

• Abstract name: string

distinct effect name

Implementation of

IMediaEffect.name

Methods

emitOutput

▸ emitOutput(stream): void

Parameters

Name	Type
stream	MediaStream

Returns

void

---

emitUnload

▸ emitUnload(): void

Returns

void

---

onOutput

▸ onOutput(callback): () => void

listen for output changes

Parameters

Name	Type
callback	(stream: MediaStream) => void

Returns

fn

▸ (): void

Returns

void

Implementation of

IMediaEffect.onOutput

---

onUnload

▸ onUnload(callback): () => void

listen for effect removal

Parameters

Name	Type
callback	() => void

Returns

fn

▸ (): void

Returns

void

Implementation of

IMediaEffect.onUnload

---

setInput

▸ setInput(stream?): void

Parameters

Name	Type
stream?	MediaStream

Returns

void

Implementation of

IMediaEffect.setInput