Skip to content

Commit d74da70

Browse files
authored
docs: clarify reason to opt into mp3 encoding with audio recorder (#2505)
1 parent b309e1a commit d74da70

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

docusaurus/docs/React/components/message-input-components/audio-recorder.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ The dialog can be customized by passing own component to `Channel` component con
5353

5454
## Custom encoding
5555

56-
By default, the recording is encoded into `audio/wav` format. In order to reduce the size and keep the inter-browser format compatibility, you can use an MP3 encoder that is based on [`lamejs` implementation](https://github.com/gideonstele/lamejs). Follow these steps to achieve the MP3 encoding capability.
56+
By default, the recording is encoded into `audio/wav` format. In order to reduce the size you can use MP3 encoder that is based on [`lamejs` implementation](https://github.com/gideonstele/lamejs). Follow these steps to achieve the MP3 encoding capability.
5757

5858
1. The library `@breezystack/lamejs` has to be installed as this is a peer dependency to `stream-chat-react`.
5959

docusaurus/docs/React/release-guides/upgrade-to-v12.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,10 +91,12 @@ const MessageInputUi2 = () => {
9191

9292
## Audio recordings transcoding
9393

94-
Until now, the audio recordings were transcoded to `audio/mp3` format for inter-browser compatibility and size reduction. However, as of the v12, the MIME type `audio/wav` will be the default. The MP3 encoder use is opt-in from now on.
94+
Until now the audio recordings were transcoded to audio/mp3. As of v12, the MIME-type audio/wav will be the default.
95+
You can still opt-in to MP3 and benefit from the reduced file size and bandwidth usage:
9596

9697
:::important
9798
**Action required**<br/>
99+
To opt into MP3 transcoding follow these steps:
98100

99101
1. The library `@breezystack/lamejs` has to be installed as this is a peer dependency to `stream-chat-react`.
100102

0 commit comments

Comments
 (0)