Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adds upgrade guide draft (frame->span + stream open) #664

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

dvdsk
Copy link
Collaborator

@dvdsk dvdsk commented Dec 22, 2024

We will point users who upgrade to the next rodio release to this document. It will help them upgrade (and save us a lot of confused users and issues).

I do not think I have missed anything. I suggest we merge this and then every PR that introduces a breaking change updates this document. I have already done that for still open PR #663.

UPGRADE.md Outdated
## OutputStream
- The outputstream is now more configurable. Where you used `OutputStream::try_default()` you have a choice:
- *(recommended)* Get an error when the default stream could not be opened: `OutputStreamBuilder::open_default_stream()?`
- Keep the old behavior using: `OutputStreamBuilder::open_stream_or_fallback()`, which tries to open the default (audio) stream trying others when the default stream could not be opened.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am always forgetting to mention this, but there is also a change in the fallback logic. Previous version either probed default settings of all devices or all settings of the default device. Current implementation tries all the combinations. I hope that does not break anything.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll update the guide 👍

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

take a look, if this is not right please let me know what you would write instead.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants