Enable audio recording for Maestro tests

Enable audio recording to capture the device’s sound in the session videos of Maestro tests on BrowserStack App Automate.

Audio recording adds sound to the session videos of your Maestro tests. Use it to check the sound your app plays, such as audiobooks, music, voice prompts, and alert sounds. When you turn on audio recording, BrowserStack records the device’s sound into each session video in the build.

Audio recording is off by default. Builds that don’t set the audio parameter record session videos without sound.

Supported devices

Audio recording works on the real devices listed in the following table:

Enable audio recording

Set the Boolean audio parameter to true in the REST API request that starts your Maestro build. The parameter works on both the Android and iOS build endpoints.

When BrowserStack rejects the build

BrowserStack returns an error as soon as you create the build. It rejects a build with audio set to true in the following cases:

• The build sets video to false, which turns off video recording.
• The build targets an Android device below Android 11.
• The build targets an iOS device below iOS 15.

Play and download videos with sound

After the build runs, open the session on the App Automate dashboard. The session video plays with sound and has mute and volume controls. Each flow links to its own part of the session video.

When you download a session video, the downloaded file includes the sound.

Related topics

• Enable video recording for Maestro tests
• Test audio injection with Maestro on BrowserStack
• Maestro builds API reference