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

Documentation for AudioContextConfig.respectSilence is backwards? #1490

Closed
2 tasks done
wujek-srujek opened this issue May 6, 2023 · 3 comments · Fixed by #1500
Closed
2 tasks done

Documentation for AudioContextConfig.respectSilence is backwards? #1490

wujek-srujek opened this issue May 6, 2023 · 3 comments · Fixed by #1500
Labels
AudioContext Concerning the AudioContext bug docs Concerning the documentation

Comments

@wujek-srujek
Copy link
Contributor

wujek-srujek commented May 6, 2023

Checklist

  • I read the troubleshooting guide before raising this issue
  • I made sure that the issue I am raising doesn't already exist

Current bug behaviour

The docs for respectSilence at

/// By default (false), if the device is on silent mode, the audio will not be
/// played.
sound backwards: the property named respectSilence, whose default value is false (i.e. it DOES NOT respect silence) should result in the audio being played even in silent mode of the device; the docs state the contrary.
Or maybe the property name is incorrect?

Working on PR

yeah (if it means updating the docs)

@Gustl22
Copy link
Collaborator

Gustl22 commented May 8, 2023

Yes I think the explanation is a bit confusing, see also the test description:

/// Android and iOS only: Play the same sound twice with a different audio

Maybe sth like this (?)

By default (false), means the audio will be played, even if the device is on silent mode.

If enabled and the device is on silent mode, the audio will not be played:

@Gustl22 Gustl22 added AudioContext Concerning the AudioContext docs Concerning the documentation labels May 8, 2023
@wujek-srujek
Copy link
Contributor Author

Yes, this makes perfect sense to me now. Should I create a PR or are you on it already? (I suppose that you fixing the docs will be much less work than you reviewing the PR by my?)

@Gustl22
Copy link
Collaborator

Gustl22 commented May 8, 2023

Just go on, we love Merge requests from the community :)

Gustl22 pushed a commit that referenced this issue May 14, 2023
)

# Description

Improves documentation for `AudioContextConfig.respectSilence`. It
should now be easier to understand what it does.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
AudioContext Concerning the AudioContext bug docs Concerning the documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants