Important: This documentation covers Yarn 1 (Classic).

For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

x-oscilloscope

stagas32MIT2.0.1

Audio oscilloscope visualizer Web Component

webaudio, oscilloscope, visualizer, web component, custom element, dsp, ui

readme

x-oscilloscope

Audio oscilloscope visualizer Web Component

`npm i x-oscilloscope` `pnpm add x-oscilloscope` `yarn add x-oscilloscope`

Examples

<summary># web</summary>

Try it live

<summary># view source</summary> example/web.ts

import { fetchAudioBuffer } from 'webaudio-tools'
import { OscilloscopeElement } from 'x-oscilloscope'

customElements.define('x-oscilloscope', OscilloscopeElement)
document.body.innerHTML = `
<div id="demo" style="display:inline-flex;height:80px;">
  <x-oscilloscope autoresize divider=4></x-oscilloscope>
</div>
`

const ctx = new AudioContext({ sampleRate: 44100, latencyHint: 0.08 })

const analyser = ctx.createAnalyser()
analyser.fftSize = 8192
analyser.smoothingTimeConstant = 0
analyser.maxDecibels = 0
analyser.minDecibels = -100

// @ts-ignore
const url = new URL('alpha_molecule.ogg', import.meta.url).toString()

fetchAudioBuffer(ctx, url).then(audioBuffer => {
  const source = ctx.createBufferSource()
  source.buffer = audioBuffer
  source.loop = true
  source.connect(ctx.destination)
  source.start(0, 83)
  source.connect(analyser)
  ;(document.querySelector('x-oscilloscope') as OscilloscopeElement).analyser =
    analyser
})

window.onclick = () => ctx.state !== 'running' ? ctx.resume() : ctx.suspend()
if (ctx.state !== 'running')
  document.body.appendChild(new Text('click to start/stop'))
// requestAnimationFrame <- for shoty

API

<summary># OscilloscopeElement </summary> src/x-oscilloscope.tsx#L10

<summary># constructor() </summary>

<summary># new OscilloscopeElement() </summary>

OscilloscopeElement

<summary># $ </summary> src/work/stagas/sigl/dist/types/sigl.d.ts#L25

Context<OscilloscopeElement & JsxContext<OscilloscopeElement> & Omit<{

<summary># ctor </summary>

Class<T>

<T>(ctor) =>

CleanClass

<summary># ctx </summary>

T | Class<T>

<T>(ctx) =>

Wrapper

__module

<summary># Boolean </summary> src/work/stagas/sigl/dist/types/index.d.ts#L9

undefined | boolean

<summary># Number </summary> src/work/stagas/sigl/dist/types/index.d.ts#L8

undefined | number

<summary># String </summary> src/work/stagas/sigl/dist/types/index.d.ts#L7

undefined | string

"transition"

<summary># Plot = ... </summary> src/x-oscilloscope.tsx#L20

Component<PlotElement, HTMLElement>

<summary># analyser </summary> src/x-oscilloscope.tsx#L18

AnalyserNode

<summary># analyserData </summary> src/x-oscilloscope.tsx#L19

Float32Array

<summary># autoResize = true </summary> src/x-oscilloscope.tsx#L11

boolean

<summary># background = '#123' </summary> src/x-oscilloscope.tsx#L14

string

<summary># color = '#1ff' </summary> src/x-oscilloscope.tsx#L15

string

<summary># context </summary> src/work/stagas/sigl/dist/types/sigl.d.ts#L26

ContextClass<OscilloscopeElement & JsxContext<OscilloscopeElement> & Omit<{

<summary># ctor </summary>

Class<T>

<T>(ctor) =>

CleanClass

<summary># ctx </summary>

T | Class<T>

<T>(ctx) =>

Wrapper

__module

<summary># Boolean </summary> src/work/stagas/sigl/dist/types/index.d.ts#L9

undefined | boolean

<summary># Number </summary> src/work/stagas/sigl/dist/types/index.d.ts#L8

undefined | number

<summary># String </summary> src/work/stagas/sigl/dist/types/index.d.ts#L7

undefined | string

"transition"

<summary># dispatch </summary> src/work/stagas/sigl/dist/types/events.d.ts#L4

Dispatch<

<summary># (name, detail, init) </summary>

<summary># name </summary>

Event | Narrow<K, string>

<summary># detail </summary>

<summary># init </summary>

CustomEventInit<any>

<K, E>(name, detail, init) =>

any

<summary># divider = 1 </summary> src/x-oscilloscope.tsx#L16

number

<summary># draw </summary> src/x-oscilloscope.tsx#L23

<summary># () </summary>

() =>

void

<summary># height = 50 </summary> src/x-oscilloscope.tsx#L13

number

<summary># host </summary> src/work/stagas/sigl/dist/types/sigl.d.ts#L24

OscilloscopeElement

<summary># loop </summary> src/x-oscilloscope.tsx#L24

{

<summary># start() </summary>

start() =>

void

<summary># stop() </summary>

stop() =>

void

<summary># onmounted </summary>

EventHandler<OscilloscopeElement, CustomEvent<any>>

<summary># onunmounted </summary>

EventHandler<OscilloscopeElement, CustomEvent<any>>

<summary># plotData = ... </summary> src/x-oscilloscope.tsx#L21

Float32Array

<summary># stabilizer = ... </summary> src/x-oscilloscope.tsx#L22

Stabilizer

<summary># width = 150 </summary> src/x-oscilloscope.tsx#L12

number

<summary># created(ctx) </summary>

<summary># ctx </summary>

Context<OscilloscopeElement & JsxContext<OscilloscopeElement> & Omit<{

<summary># ctor </summary>

Class<T>

<T>(ctor) =>

CleanClass

<summary># ctx </summary>

T | Class<T>

<T>(ctx) =>

Wrapper

__module

<summary># Boolean </summary> src/work/stagas/sigl/dist/types/index.d.ts#L9

undefined | boolean

<summary># Number </summary> src/work/stagas/sigl/dist/types/index.d.ts#L8

undefined | number

<summary># String </summary> src/work/stagas/sigl/dist/types/index.d.ts#L7

undefined | string

"transition"

created(ctx) =>

void

<summary># mounted($) </summary> src/x-oscilloscope.tsx#L41

<summary># $ </summary>

Context<OscilloscopeElement & JsxContext<OscilloscopeElement> & Omit<{

<summary># ctor </summary>

Class<T>

<T>(ctor) =>

CleanClass

<summary># ctx </summary>

T | Class<T>

<T>(ctx) =>

Wrapper

__module

<summary># Boolean </summary> src/work/stagas/sigl/dist/types/index.d.ts#L9

undefined | boolean

<summary># Number </summary> src/work/stagas/sigl/dist/types/index.d.ts#L8

undefined | number

<summary># String </summary> src/work/stagas/sigl/dist/types/index.d.ts#L7

undefined | string

"transition"

mounted($) =>

void

<summary># on(name) </summary>

<summary># name </summary>

on<K>(name) =>

On

Fn

EventHandler

OscilloscopeElement

LifecycleEvents

Off

<summary># start() – Start displaying the spectrum.</summary> src/x-oscilloscope.tsx#L31

start() =>

void

<summary># stop() – Stop displaying the spectrum.</summary> src/x-oscilloscope.tsx#L37

stop() =>

void

<summary># toJSON() </summary>

toJSON() =>

Pick

OscilloscopeElement

OscilloscopeElement

Credits

sigl by stagas – Web framework
x-plot by stagas – A Web Component that plots zoomable and pannable waveforms.

Contributing

Fork or edit and submit a PR.

All contributions are welcome!

License

MIT © 2022 stagas