mirror of
https://github.com/ggerganov/ggwave.git
synced 2026-02-06 16:47:59 +08:00
bac95c8113
* Add rxDurationFrames api getter * Fixed comment --------- Co-authored-by: Vittorio Palmisano <vittorio.palmisano@ringcentral.com>
ggwave
Tiny data-over-sound library.
- Audible and ultrasound transmissions available
- Bandwidth of 8-16 bytes/s (depending on the transmission protocol)
- Robust FSK modulation
- Reed-Solomon based error correction
Example Usage
var factory = require('ggwave')
factory().then(function(ggwave) {
// create ggwave instance with default parameters
var parameters = ggwave.getDefaultParameters();
parameters.operatingMode |= ggwave.GGWAVE_OPERATING_MODE_USE_DSS;
var instance = ggwave.init(parameters);
console.log('instance: ' + instance);
var payload = 'hello js';
// generate audio waveform for string "hello js"
var waveform = ggwave.encode(instance, payload, ggwave.ProtocolId.GGWAVE_PROTOCOL_AUDIBLE_FAST, 10);
// decode the audio waveform back to text
var res = ggwave.decode(instance, waveform);
if (new TextDecoder("utf-8").decode(res) != payload) {
process.exit(1);
}
});