React Audio Engine

Integração de React com Web Audio API.

:warning: Versionamento

Durante a versão 0.x.x, todas as breaking changes serão tratadas como minor e as demais mudanças como patch. A partir da versão 1.0.0, o versionamento seguirá normalmente seguindo a documentação em https://semver.org/.

Instalação

NPM: https://www.npmjs.com/package/react-audio-engine

Desenvolvimento

Setup

pnpm install

Demo

pnpm start:dev

Especificação

Stage

Raiz da árvore de áudio. Todas as cenas de áudio devem estar contidas em um Stage.

import { ATOM, ReactATOM, Scene } from 'react-audio-engine'

const stage = new ATOM.Stage();

ReactATOM.render(<Scene {...props} />, stage);

Scene

Responsável pela criação e gerenciamento dos contextos de áudio. Todos os demais módulos devem estar contidos em uma cena.

import { Scene, Track, Gain, BufferSource } from 'react-audio-engine'

function MyScene(props: { masterGain: number, buffer: ArrayBuffer }) {
  return (
    <Scene sampleRate={88200} latencyHint={Scene.LatencyCategory.PLAYBACK}>
      <Track>
        <BufferSource buffer={props.buffer}>
        <Gain level={props.masterGain}/>
      </Track>
    </Scene>
  )
}

Record

Semelhante à Scene, mas renderiza o áudio em memória o mais rapidamente possível.

import { Scene, Record, Track } from 'react-audio-engine'

function MyScene(props: { tracks: Track.Props[]; isSaving: boolean }) {
  const RecordOrScene = isSaving ? Record : Scene;

  return (
    <RecordOrScene>
      {props.tracks.map(<Track {...props}>...</Track>)}
    </RecordOrScene>
  );
}

Element

Responsável por renderizar os nós de áudio nativos. É uma classe abstrata cujo comportamento é implementado por todos os nós de áudio.

Os nós que concretizam Element são:

• Analyser
• BiquadFilter
• BufferSource
• ConstantSource
• Convolver
• Delay
• DynamicsCompressor
• Element
• Gain
• IIRFilter
• MediaElementSource
• MediaStreamDestination
• MediaStreamSource
• Oscillator
• Panner
• ScriptProcessor
• StereoPanner
• WaveShaper
• Worklet

Track

Conduz o sinal de áudio serialmente atráves dos módulos filhos. Sua entrada é a entrada do primeiro módulo filho e sua saída é a saída do último módulo filho.

Mixer

Combina o sinal de áudio paralelamente através dos módulos filhos. Sua a entrada é a combinação das entradas dos módulos filhos e sua saída é a combinação da saída dos módulos filhos.

Branch

Ramifica o sinal de áudio em um fluxo serial alternativo através dos módulos filhos cujo destino diverge do fluxo original (tendo BaseAudioContext.destination como destino se não fornecido explicitamente). É o comportamento implementado por todos os elementos.

Helpers

AudioView

Componente utilizado para facilitar a renderização de elementos de GUI e WebAudio de forma unificada, compartilhando o estado entre o áudio e a view. Possui dois métodos abstratos:

• renderAudio: utilizado para renderizar os elementos de áudio.
• renderView: utilizado para renderizar os elementos de GUI.

Se fornecido um stage via contexto, o componente usará o mesmo para renderizar o áudio. Senão, um stage será criado.

import React from 'react'
import ReactDOM from 'react-dom'
import { ATOM, AudioView, Scene } from 'react-audio-engine'

type Props = {}

interface State {
  sampleRate: number
}

class AppAudioView extends AudioView<Props, State> {
  renderAudio() {
    return (
      <Scene sampleRate={this.state.sampleRate}>
        ...
      </Scene>
    )
  }

  renderView() {
    return (
      <input
        value={this.state.sampleRate}
        onChange={event => this.setState({ sampleRate: Number(event.target.value) })}
      />
    )
  }
}

const stage = new ATOM.stage()
const root = document.getElementById('root')

ReactDOM.render(
  <AudioView.Context.Provider value={stage}>
    <AppAudioView/>
  </AudioView.Context.Provider>,
  root
)