AudioVisualizerEffect

@auvious/media-tools / AudioVisualizerEffect

Class: AudioVisualizerEffect

Generic for input

Hierarchy

• MediaEffect

  ↳ AudioVisualizerEffect

Table of contents

Constructors

• constructor

Properties

• analyser
• audioCtx
• audioSize
• audioTex
• audioTextureSize
• canvas
• colorPrimary
• colorSecondary
• fftSize
• frameId
• freqData
• gl
• isWebGL2
• name
• program
• smoothing
• sourceNode
• startTime
• streamIn
• uColor1Loc
• uColor2Loc

Methods

• dispose
• drawFrame
• emitOutput
• emitUnload
• hexToRgb
• initWebGL
• onOutput
• onUnload
• reset
• resizeCanvas
• resizeHandler
• setInput
• setupAudio
• syncAudioTexture
• teardownAudio
• updateAudioTexture
• updateColors

Constructors

constructor

• new AudioVisualizerEffect(options)

Parameters

Name	Type
options	AudioVisualizerOptions

Overrides

MediaEffect.constructor

Properties

analyser

• Private analyser: null | AnalyserNode = null

---

audioCtx

• Private audioCtx: null | AudioContext = null

---

audioSize

• Private audioSize: number = 512

---

audioTex

• Private audioTex: null | WebGLTexture = null

---

audioTextureSize

• Private audioTextureSize: number = 0

---

canvas

• Private canvas: HTMLCanvasElement

---

colorPrimary

• Private colorPrimary: string = "#4ca2ff"

---

colorSecondary

• Private colorSecondary: string = "#ff00ff"

---

fftSize

• Private fftSize: number

---

frameId

• Private frameId: number = 0

---

freqData

• Private freqData: null | Uint8Array = null

---

gl

• Private gl: null | WebGL2RenderingContext | WebGLRenderingContext = null

---

isWebGL2

• Private isWebGL2: boolean = false

---

name

• name: string = "auvious.audio-visualizer"

distinct effect name

Overrides

MediaEffect.name

---

program

• Private program: null | WebGLProgram = null

---

smoothing

• Private smoothing: number

---

sourceNode

• Private sourceNode: null | MediaStreamAudioSourceNode = null

---

startTime

• Private startTime: number

---

streamIn

• Private Optional streamIn: MediaStream

---

uColor1Loc

• Private uColor1Loc: null | WebGLUniformLocation = null

---

uColor2Loc

• Private uColor2Loc: null | WebGLUniformLocation = null

Methods

dispose

▸ dispose(): void

Returns

void

---

drawFrame

▸ Private drawFrame(): void

Returns

void

---

emitOutput

▸ Protected emitOutput(stream): void

Parameters

Name	Type
stream	MediaStream

Returns

void

Inherited from

MediaEffect.emitOutput

---

emitUnload

▸ Protected emitUnload(): void

Returns

void

Inherited from

MediaEffect.emitUnload

---

hexToRgb

▸ Private hexToRgb(hex): [number, number, number]

Parameters

Name	Type
hex	string

Returns

[number, number, number]

---

initWebGL

▸ Private initWebGL(): void

Returns

void

---

onOutput

▸ onOutput(callback): () => void

listen for output changes

Parameters

Name	Type
callback	(stream: MediaStream) => void

Returns

fn

▸ (): void

Returns

void

Inherited from

MediaEffect.onOutput

---

onUnload

▸ onUnload(callback): () => void

listen for effect removal

Parameters

Name	Type
callback	() => void

Returns

fn

▸ (): void

Returns

void

Inherited from

MediaEffect.onUnload

---

reset

▸ reset(): void

Returns

void

---

resizeCanvas

▸ Private resizeCanvas(): void

Returns

void

---

resizeHandler

▸ Private resizeHandler(): void

Returns

void

---

setInput

▸ setInput(stream?): void

Parameters

Name	Type
stream?	MediaStream

Returns

void

Overrides

MediaEffect.setInput

---

setupAudio

▸ Private setupAudio(stream): void

Parameters

Name	Type
stream	MediaStream

Returns

void

---

syncAudioTexture

▸ Private syncAudioTexture(): void

Returns

void

---

teardownAudio

▸ Private teardownAudio(): void

Returns

void

---

updateAudioTexture

▸ Private updateAudioTexture(): void

Returns

void

---

updateColors

▸ updateColors(colorPrimary, colorSecondary): void

Parameters

Name	Type
colorPrimary	string
colorSecondary	string

Returns

void