Skip to content

Commit 6964714

Browse files
committed
Rename package references to @Audio scope in docs
1 parent 3e083f9 commit 6964714

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# audio-encode [![test](https://github.com/audiojs/audio-encode/actions/workflows/test.js.yml/badge.svg)](https://github.com/audiojs/audio-encode/actions/workflows/test.js.yml)
1+
# @audio/encode [![test](https://github.com/audiojs/audio-encode/actions/workflows/test.js.yml/badge.svg)](https://github.com/audiojs/audio-encode/actions/workflows/test.js.yml)
22

33
Encode raw audio samples to any format.<br>
44
JS / WASM – no ffmpeg, no native bindings, works in both node and browser.<br>
55
Small API, minimal size, near-native performance, stream encoding.
66

7-
[![npm install encode-audio](https://nodei.co/npm/encode-audio.png?mini=true)](https://npmjs.org/package/encode-audio/)
7+
[![npm install @audio/encode](https://nodei.co/npm/encode-audio.png?mini=true)](https://npmjs.org/package/@audio/encode/)
88

99
```js
10-
import encode from 'encode-audio';
10+
import encode from '@audio/encode';
1111

1212
const buf = await encode.wav(channelData, { sampleRate: 44100 });
1313
```
@@ -34,7 +34,7 @@ const buf = await encode.wav(channelData, { sampleRate: 44100 });
3434
Specify the format as method name. Input is _Float32Array[]_ (one per channel), a single _Float32Array_ (mono), or an [AudioBuffer](https://npmjs.com/package/audio-buffer).
3535

3636
```js
37-
import encode from 'encode-audio';
37+
import encode from '@audio/encode';
3838

3939
const wav = await encode.wav(channelData, { sampleRate: 44100 });
4040
const aiff = await encode.aiff(channelData, { sampleRate: 44100 });
@@ -55,7 +55,7 @@ const aac = await encode.aac(channelData, { sampleRate: 44100, bitrate: 128 });
5555
Call with just options (no data) to create a streaming encoder:
5656

5757
```js
58-
import encode from 'encode-audio';
58+
import encode from '@audio/encode';
5959

6060
const enc = await encode.mp3({ sampleRate: 44100, bitrate: 128 });
6161

@@ -71,7 +71,7 @@ const c = await enc(null); // end of stream — flush + free
7171
Pass an async iterable as data — returns an async generator:
7272

7373
```js
74-
import encode from 'encode-audio'
74+
import encode from '@audio/encode'
7575

7676
for await (let buf of encode.mp3(audioSource, { sampleRate: 44100, bitrate: 128 })) {
7777
// buf is Uint8Array
@@ -107,10 +107,10 @@ let bytes = await encode.flac(channelData, {
107107

108108
Tags work for `wav`, `mp3`, `flac`, `aiff`, `ogg` and `opus`. Cue `markers` and `regions` are `wav`-only. `opus` bakes tags into the OpusTags header at encode time (stays fully streaming); the others splice tags into the finished file — so passing `meta` to a **streaming/chunked** encode of `wav`/`mp3`/`flac`/`aiff`/`ogg` buffers the output and emits it on flush.
109109

110-
You can also tag already-encoded bytes via `encode-audio/meta`:
110+
You can also tag already-encoded bytes via `@audio/encode/meta`:
111111

112112
```js
113-
import { wav } from 'encode-audio/meta'
113+
import { wav } from '@audio/encode/meta'
114114

115115
let out = wav(bytes, {
116116
meta: { title: 'Hare Krishna', artist: 'Prabhupada', year: '1966' },

0 commit comments

Comments
 (0)