The provides a powerful and versatile system for controlling audio on the Web, allowing developers to choose audio sources, add effects to audio, create audio visualizations, apply spatial effects (such as panning) and much more. Web Audio API It can be used for sophisticated web-based games or interactive applications which include the capabilities of modern game audio engines as well as some of the mixing, processing, and filtering tasks found in modern desktop audio production applications; and it can be a very good complement to the more advanced graphics features offered by . developing WebGL All this awesome (pun intended), although, on iOS devices there is a slight : the Web Audio requires sounds to be triggered from an explicit user action, such as a tap, before any sound can be played on a web page. sounds caveat API The reason why iOS devices impose this user-gesture restriction is because they want to preserve a pleasant user experience by preventing ads or videos from playing sounds before user actually interacts with the content, and also to save battery life since playing audio does require additional processing power. Within Web Audio API everything happens inside of an , an audio-processing graph built from audio nodes linked together, which controls both the creation of the nodes it contains and the execution of the audio processing, or decoding. [AudioContext](https://developer.mozilla.org/en-US/docs/Web/API/AudioContext) On iOS devices this context is initially suspended (“locked”) and in order to enable sounds on a web page we need to get it out of the suspended state, or “unlock” it, within first user interaction. to this issue proposed creating an empty sound on the fly and playing it back once user interacts with the page. Earlier solution The reason why this approach works is because before actually playing the audio. playing an audio source within a locked audio context sets it into [running](https://github.com/WebKit/webkit/blob/750df37180842038b25fc9efe18fc40053785e24/Source/WebCore/Modules/webaudio/AudioContext.cpp#L978) state Let’s start putting some code together in order to try and come up with a simpler solution. First we need to instantiate an audio context to be able to do any audio manipulation: Then right after we create an audio context we should check its property.If the state is equal to we might be dealing with an iOS device: state suspended Some desktop browsers like leave an audio context in state right after instantiating it, so in order to make sure we are really dealing with an iOS device we need to check if touch events are available as well: Firefox Quantum suspended If the audio context is suspended we can call its method to set it into state: [resume](https://developer.mozilla.org/en-US/docs/Web/API/BaseAudioContext/resume)() running Now, you might be thinking “ well, it can’t be this simple…” …and you are right 😔. This code needs to be run within a user interaction in order to actually work. So we are going to wrap it up in a function and add that function as a touch event listener. In order to try and unlock audio context as soon as possible we will run our code on the first event that occurs anywhere on the page: [touchstart](https://developer.mozilla.org/en-US/docs/Web/Events/touchstart) One issue with this approach is that with some iOS versions . trying to unlock Web Audio on [touchstart](https://bugs.webkit.org/show_bug.cgi?id=149367#c7) event doesn’t work could be the beginning of a scroll gesture, and playing audio during this gesture could be completely undesirable from a user's perspective. touchstart So to take this into account we also need to try to unlock Web Audio from within event as well as on the initial event: [touchend](https://developer.mozilla.org/en-US/docs/Web/Events/touchend) touchstart Once the audio context has been unlocked we would want to remove touch event listeners since we don’t need them anymore. For this we need to figure out when the audio context was actually unlocked. Technique used in an earlier solution to determine this was to query the attribute of the sound, that was created on the fly, shortly after starting its playback. Doing it directly after wouldn’t work since starting a sound is an asynchronous action so querying had to be done from a timeout callback. Then, if the sound was in or , you could assume that the context was unlocked. playbackState PLAYING_STATE FINISHED_STATE This approach might still work in some cases but it is far from simple and introduces a compatibility issue since . [playbackState](https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API/Porting_webkitAudioContext_code_to_standards_based_AudioContext#Removal_of_AudioBufferSourceNode.playbackState_and_OscillatorNode.playbackState) is no longer supported by the official Web Audio API specification One neat thing is that method of the audio context actually returns a object. When that promise resolves we are certain that audio context has been unlocked and that we can remove touch event listeners: resume [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) And there you go: a bulletproof way of unlocking Web Audio on iOS devices! Let’s make a few more adjustments to make this piece of code reusable. First, let’s wrap it all in a function: And finally let’s provide some useful info like if there was an actual need to unlock Web Audio or if an error occurred and what was the reason for it. We can do this by wrapping everything inside of a and returning it from our function: Promise Now you can use this function anywhere in your code like this: Conclusion There you go, an easy and effective way to unlock Web Audio API on iOS devices! I’ve created an called that exposes this method and makes it easy to use in your own projects. Just pass your instance to it and you’re good to go! npm package web-audio-touch-unlock AudioContext You can try it out yourself . here Cheers! Tap anywhere to unlock…

Apple

Mozilla

Too Long; Didn't Read

In your car, at home, or at work — Bosch technology shapes many areas of life.

Unlocking Web Audio — the smarter way

Too Long; Didn't Read

Companies Mentioned

Pavle Goloskokovic

About Author

TOPICS

THIS ARTICLE WAS FEATURED IN...

Unlocking Web Audio — the smarter way

Too Long; Didn't Read

Companies Mentioned

Pavle Goloskokovic

About Author

TOPICS

THIS ARTICLE WAS FEATURED IN...

RELATED STORIES