https://github.com/splitinfinities/web-audio-wc
Provides Web Audio web components.
https://github.com/splitinfinities/web-audio-wc
Last synced: 3 months ago
JSON representation
Provides Web Audio web components.
- Host: GitHub
- URL: https://github.com/splitinfinities/web-audio-wc
- Owner: splitinfinities
- License: mit
- Created: 2017-10-01T01:28:47.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-04-16T13:34:25.000Z (about 7 years ago)
- Last Synced: 2024-04-23T22:38:05.266Z (about 1 year ago)
- Language: TypeScript
- Size: 2.34 MB
- Stars: 9
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
- awesome-stenciljs - Web Audio - audio>`, `<web-audio-source>`, `<web-audio-effect>`, `<web-audio-visualizer>`, `<web-audio-sequencer>`, and `<web-audio-debugger>`. (List of Awesome Components Made using StencilJS / Individual Components)
README
# Web Audio as HTML
Web Audio's API can often get a little daunting. This package provides HTML tags that simplify web audio and make wrapping sources in effects super simple!
## API
#### ``
More to come...
#### ``
More to come...
#### ``
More to come...
#### ``
More to come...
#### ``
More to come...
#### ``
More to come...
#### ``
More to come...
#### `Midi controller support`
More to come...
## Examples
- Simplest "click to play" example https://codepen.io/splitinfinities/pen/pWpvbe
- Creating a sequencer https://codepen.io/splitinfinities/pen/Ewoaoe
- Effects and contextual hooks https://codepen.io/splitinfinities/pen/qPpEYv
- Midi controllers: https://codepen.io/splitinfinities/pen/VMyYoY
- Sequencer and callbacks with GSAP https://codepen.io/splitinfinities/pen/zEjKPN
## Developing
To start building on to this package, clone this repo to a new directory:
```bash
git clone https://github.com/splitinfinities/web-audio-wc.git web-audio-wc
cd web-audio-wc
git remote rm origin
```
and run:
```bash
npm install
npm start
```
To watch for file changes during develop, run:
```bash
npm run dev
```
To build the component for production, run:
```bash
npm run build
```
Need help? Check out Stencil's docs [here](https://stenciljs.com/docs/my-first-component).
## Using this component
### Script tag
- [Publish to NPM](https://docs.npmjs.com/getting-started/publishing-npm-packages)
- Put a script tag similar to this `` in the head of your index.html
- Then you can use the element anywhere in your template, JSX, html etc
### Node Modules
- Run `npm install web-audio-wc --save`
- Put a script tag similar to this `