Skip to content

Commit dd2a49b

Browse files
committed
docs: mention change to Symphonia in upgrade guide
1 parent 7e9f6ab commit dd2a49b

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

UPGRADE.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,16 @@ This guide will help you update your code when upgrading from older versions of
33
# rodio 0.20.1 or earlier to current GitHub version
44

55
## Features
6-
- If you use disable the rodio features with `default_features = false` in
7-
`Cargo.toml` you need to add a new feature `playback`.
6+
- If you use disable the rodio features with `default_features = false` in `Cargo.toml` you need to
7+
add a new feature `playback`.
8+
- The default decoders have changed to Symphonia, which itself is licensed under MPL. If you want
9+
to revert to the old decoders, you need to enable the `claxon`, `hound` and `lewton` features in `Cargo.toml` for respectively FLAC, WAV and Ogg Vorbis.
810

911
## Source implementations
1012
- Source had a required method `current_frame_len`. In the latest version of rodio *frame* has been renamed to *span*. You will need to change every occurrence of `current_frame_len` to `current_span_len`.
1113

1214
## OutputStream
13-
- The outputstream is now more configurable. Where you used `OutputStream::try_default()` you have a choice:
15+
- The output stream is now more configurable. Where you used `OutputStream::try_default()` you have a choice:
1416
- *(recommended)* Get an error when the default stream could not be opened: `OutputStreamBuilder::open_default_stream()?`
1517
- Stay close to the old behavior using:
1618
`OutputStreamBuilder::open_stream_or_fallback()`, which tries to open the

0 commit comments

Comments
 (0)