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.

Sign up for GitHub

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

Jump to bottom

docs: Improve doc for 'AudioContextConfig.respectSilence' (#1490) #1500

Merged
merged 4 commits into from
May 14, 2023
Merged

docs: Improve doc for 'AudioContextConfig.respectSilence' (#1490) #1500

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
174d473
docs: Improve doc for AudioContextConfig.respectSilence (#1490)
wujek-srujek May 8, 2023
079ae20
Update packages/audioplayers_platform_interface/lib/src/api/audio_con…
Gustl22 May 10, 2023
bf3d8cf
Update packages/audioplayers_platform_interface/lib/src/api/audio_con…
Gustl22 May 10, 2023
adc8e62
Merge branch 'main' into docs/1490-respectSilence-docs
Gustl22 May 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions packages/audioplayers_platform_interface/lib/src/api/audio_context_config.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,12 @@ class AudioContextConfig {
/// thus is forbidden when [respectSilence] is set.
final bool duckAudio;

/// Whether the "silent" mode of the device should be respect.
/// By default (false), if the device is on silent mode, the audio will not be
/// played.
/// Whether the "silent" mode of the device should be respected.
Gustl22 marked this conversation as resolved.
Show resolved Hide resolved
///
/// When `false` (the default), audio will be played even if the device is in
wujek-srujek marked this conversation as resolved.
Show resolved Hide resolved
/// silent mode.
///
/// When `true` and the device is in silent mode, audio will not be played.
Gustl22 marked this conversation as resolved.
Show resolved Hide resolved
///
/// On Android, this will mandate the `USAGE_NOTIFICATION_RINGTONE` usage
/// type.
Expand Down