Skip to content

Commit 824ae0c

Browse files
committed
Update readmes
1 parent 6d26cd6 commit 824ae0c

6 files changed

Lines changed: 25 additions & 25 deletions

File tree

packages/decode-aac/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
# decode-aac
1+
# @audio/decode-aac
22

33
Decode AAC/M4A audio to PCM float samples. FAAD2 compiled to WASM — works in Node.js and browsers, no native dependencies.
44

55
## Install
66

77
```
8-
npm i @audio/aac-decode
8+
npm i @audio/decode-aac
99
```
1010

1111
## Usage
1212

1313
```js
14-
import decode from '@audio/aac-decode'
14+
import decode from '@audio/decode-aac'
1515

1616
// M4A or raw ADTS — auto-detected
1717
let { channelData, sampleRate } = await decode(uint8array)
@@ -22,7 +22,7 @@ let { channelData, sampleRate } = await decode(uint8array)
2222
### Streaming
2323

2424
```js
25-
import { decoder } from '@audio/aac-decode'
25+
import { decoder } from '@audio/decode-aac'
2626

2727
let dec = await decoder()
2828
let { channelData, sampleRate } = dec.decode(chunk)

packages/decode-aiff/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
# decode-aiff
1+
# @audio/decode-aiff
22

33
Decode AIFF and AIFF-C audio to PCM float samples.<br>
44
Part of [audio-decode](https://github.com/audiojs/audio-decode).
55

66
## Install
77

88
```
9-
npm i @audio/aiff-decode
9+
npm i @audio/decode-aiff
1010
```
1111

1212
## Usage
1313

1414
```js
15-
import decode from '@audio/aiff-decode'
15+
import decode from '@audio/decode-aiff'
1616

1717
let { channelData, sampleRate } = await decode(aiffBuffer)
1818
// channelData: Float32Array[] (one per channel)
@@ -22,7 +22,7 @@ let { channelData, sampleRate } = await decode(aiffBuffer)
2222
### Streaming
2323

2424
```js
25-
import { decoder } from '@audio/aiff-decode'
25+
import { decoder } from '@audio/decode-aiff'
2626

2727
let dec = await decoder()
2828
let result = dec.decode(chunk)

packages/decode-amr/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# decode-amr
1+
# @audio/decode-amr
22

33
Decode AMR-NB and AMR-WB audio to PCM float samples. [opencore-amr](https://sourceforge.net/projects/opencore-amr/) compiled to WASM — works in Node.js and browsers.
44

@@ -7,13 +7,13 @@ Part of [audio-decode](https://github.com/audiojs/audio-decode).
77
## Install
88

99
```
10-
npm i @audio/amr-decode
10+
npm i @audio/decode-amr
1111
```
1212

1313
## Usage
1414

1515
```js
16-
import decode from '@audio/amr-decode'
16+
import decode from '@audio/decode-amr'
1717

1818
// AMR-NB or AMR-WB — auto-detected from file header
1919
let { channelData, sampleRate } = await decode(amrBuffer)
@@ -24,7 +24,7 @@ let { channelData, sampleRate } = await decode(amrBuffer)
2424
### Streaming
2525

2626
```js
27-
import { decoder } from '@audio/amr-decode'
27+
import { decoder } from '@audio/decode-amr'
2828

2929
let dec = await decoder()
3030
let result = dec.decode(chunk)

packages/decode-caf/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# decode-caf
1+
# @audio/decode-caf
22

33
Decode Core Audio Format (CAF) audio to PCM float samples.
44

@@ -7,21 +7,21 @@ Part of [audio-decode](https://github.com/audiojs/audio-decode).
77
## Install
88

99
```
10-
npm i @audio/caf-decode
10+
npm i @audio/decode-caf
1111
```
1212

1313
## Usage
1414

1515
```js
16-
import decode from '@audio/caf-decode'
16+
import decode from '@audio/decode-caf'
1717

1818
let { channelData, sampleRate } = await decode(cafBuffer)
1919
```
2020

2121
### Streaming
2222

2323
```js
24-
import { decoder } from '@audio/caf-decode'
24+
import { decoder } from '@audio/decode-caf'
2525

2626
let dec = await decoder()
2727
let result = dec.decode(chunk)

packages/decode-webm/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# decode-webm
1+
# @audio/decode-webm
22

33
Decode WebM audio (Opus and Vorbis) to PCM float samples. EBML demuxer in pure JS, codec decoding via WASM.
44

@@ -7,21 +7,21 @@ Part of [audio-decode](https://github.com/audiojs/audio-decode).
77
## Install
88

99
```
10-
npm i @audio/webm-decode
10+
npm i @audio/decode-webm
1111
```
1212

1313
## Usage
1414

1515
```js
16-
import decode from '@audio/webm-decode'
16+
import decode from '@audio/decode-webm'
1717

1818
let { channelData, sampleRate } = await decode(webmBuffer)
1919
```
2020

2121
### Streaming
2222

2323
```js
24-
import { decoder } from '@audio/webm-decode'
24+
import { decoder } from '@audio/decode-webm'
2525

2626
let dec = await decoder()
2727
let result = await dec.decode(chunk)

packages/decode-wma/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# decode-wma
1+
# @audio/decode-wma
22

33
Decode WMA audio to PCM float samples. ASF demuxer in pure JS, WMA decoding via [RockBox](https://www.rockbox.org/) fixed-point decoder compiled to WASM (70 KB).
44

@@ -7,21 +7,21 @@ Part of [audio-decode](https://github.com/audiojs/audio-decode).
77
## Install
88

99
```
10-
npm i @audio/wma-decode
10+
npm i @audio/decode-wma
1111
```
1212

1313
## Usage
1414

1515
```js
16-
import decode from '@audio/wma-decode'
16+
import decode from '@audio/decode-wma'
1717

1818
let { channelData, sampleRate } = await decode(wmaBuffer)
1919
```
2020

2121
### Streaming
2222

2323
```js
24-
import { decoder } from '@audio/wma-decode'
24+
import { decoder } from '@audio/decode-wma'
2525

2626
let dec = await decoder()
2727
let result = dec.decode(chunk)
@@ -31,7 +31,7 @@ dec.free()
3131
### ASF demuxer only
3232

3333
```js
34-
import { demuxASF } from '@audio/wma-decode'
34+
import { demuxASF } from '@audio/decode-wma'
3535

3636
let { channels, sampleRate, bitRate, packets } = demuxASF(buffer)
3737
```

0 commit comments

Comments
 (0)