Change audioSession to public access level - #87
Open
Gad101 wants to merge 1 commit into
Open
Conversation
The doc comment on `SoundEffect.audioSession` instructs apps to set it:
/// ```
/// #if targetEnvironment(simulator)
/// SoundEffect.audioSession = AVAudioSession.sharedInstance()
/// #endif
/// ```
but the property has no access modifier, so it defaults to "internal" and the documented usage fails to compile from outside the package:
error: 'audioSession' is inaccessible due to 'internal' protection level SoundEffect.audioSession =AVAudioSession.sharedInstance()
This makes it impossible to opt sound effects out of the default ".ambient" / plain `CHHapticEngine()` behavior.
e.g. an app whose audio uses a `.playback` session (playing through the silent switch) has no way to make Pow sound
effects match, even though the API for it is already documented.
Fix:
Add `public` to the property declaration, this makes the
existing documentation correct.
|
I am running into the same problem |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem:
The doc comment on
SoundEffect.audioSessioninstructs apps to set it:but the property has no access modifier, so it defaults to "internal" and the documented usage fails to compile from outside the package:
error: 'audioSession' is inaccessible due to 'internal' protection level SoundEffect.audioSession =AVAudioSession.sharedInstance()
This makes it impossible to opt sound effects out of the default ".ambient" / plain
CHHapticEngine()behavior.e.g. an app whose audio uses a
.playbacksession (playing through the silent switch) has no way to make Pow sound effects match, even though the API for it is already documented.Fix:
Add
publicto the property declaration, this makes the existing documentation correct.