# modulate-fm

> A wrapper around voice-activity-detection that emits voice audio as it captures it from the mic.

Latest version **1.0.1** (published 2021-08-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install modulate-fm
pnpm add modulate-fm
yarn add modulate-fm
bun add modulate-fm
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2021-08-10 |
| First published | 2020-02-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 17.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jim Kang |
| Maintainers | jimkang |
| Keywords | audio, browser, utility |

## Links

- npm: https://www.npmjs.com/package/modulate-fm
- Repository: https://github.com/jimkang/modulate-fm
- Issues: https://github.com/jimkang/modulate-fm/issues
- npm.io page: https://npm.io/package/modulate-fm

## Dependencies (2)

- [mic-to-buffer](https://npm.io/package/mic-to-buffer.md) ^1.1.0
- [audiobuffer-to-wav](https://npm.io/package/audiobuffer-to-wav.md) ^1.0.0

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2021-08-10
- 1.0.0 — 2020-02-03

## README

modulate-fm
==================

Given a [modulation index](https://www.electronics-notes.com/articles/radio/modulation/fm-frequency-modulation-index-deviation-ratio.php), a modulation frequency, a carrier oscillator, and an AudioContext, hooks up a modulator to the carrier and provides a function to play the sounds.

(Honestly not sure if this is a good abstraction right now.)

[Here's a demo.](https://jimkang.com/modulate-fm/)

Installation
------------

    npm install modulate-fm

Usage
-----

    var modulate = require('modulate-fm');
    var carrierOsc = ctx.createOscillator();
    carrierOsc.type = 'sawtooth';
    carrierOsc.frequency.value = carrierField.value;

    var playModulation = modulate({
      ctx,
      index: indexField.value,
      modFreq: modFreqField.value,
      carrierOsc
    });

    playModulation({ delaySeconds: 0, durationSeconds: 1 });

License
-------

The MIT License (MIT)

Copyright (c) 2020 Jim Kang

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the 'Software'), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

---
_Source: https://npm.io/package/modulate-fm · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._