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

Audio capture accessibility updates #3043

Merged
merged 2 commits into from
Dec 12, 2024
Merged
Changes from all commits
Commits
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
27 changes: 17 additions & 10 deletions docs/mobile-apps/features/audio-capture.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@

Now you can start your automated testing session. Your audio recording will be captured and be part of the video recording on the Test Results page.

### Using Audio Streaming during a Live Testing session on Real Devices
### Using Live Audio Streaming during a Live Testing session on Real Devices

<p><small><span className="sauceGreen">Real Devices Only</span></small></p>

You just need to launch a Live Testing session on a real device, and the audio will be streamed automatically without any configuration.
You just need to launch a Live Testing session on a real device, and the audio will be streamed to your browser automatically without any configuration. If it doesn't launch for you, you can manually launch it by clicking **Performance Mode** butoon under **Device Settings** menu in the live testing toolbar.

The Audio Streaming feature ensures a better digital experience by validating audio playback and testing user flows that require audio testing in the early stages of the development lifecycle.

Expand All @@ -41,14 +41,15 @@
<img src={useBaseUrl('img/audio.png')} alt="Mobile app settings navigation" width="300"/>
:::

## Streaming Limitations
## Live Streaming Limitations

:::note Limitations

- TalkBack Audio is ONLY supported on Private devices, reach out to our Support Team or your Sauce Labs representative to get this configured.
- Audio Streaming is supported on iOS/iPadOS 13.2 and above.
- Audio Streaming is supported on Android 10 and above.
- When Audio Streaming is enabled, we are not attaching the audio to the test results after the session ends on Android 12 and below.
- Android TalkBack is ONLY supported on Private devices, reach out to our Support Team or your Sauce Labs representative to get this configured.
- Audio Live Streaming is not supported on automated tests.
- Audio Live Streaming is supported on iOS/iPadOS 13.2 and above.
- Audio Live Streaming is supported on Android 10 and above.
- When Audio Live Streaming is enabled, we are not attaching the audio to the test results after the session ends on Android 12 and below.
- Website testing is not yet available on Android.

:::
Expand Down Expand Up @@ -92,6 +93,12 @@
<img src={useBaseUrl('/img/mobile-apps/talkBack-live.png')} alt="Sauce Labs TalkBack" width="751"/>
<img src={useBaseUrl('/img/mobile-apps/voiceOver-live.png')} alt="Sauce Labs Voiceover" width="751"/>

### Text to Speech

Text to speech audio of the focused element will be streamed to your browser as you interact with the devices.

On Android, text to speech audio will not be available for download once the session is over.

Check warning on line 100 in docs/mobile-apps/features/audio-capture.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/mobile-apps/features/audio-capture.md#L100

[sauce.WordList] Use 'after the' instead of 'once the'.
Raw output
{"message": "[sauce.WordList] Use 'after the' instead of 'once the'.", "location": {"path": "docs/mobile-apps/features/audio-capture.md", "range": {"start": {"line": 100, "column": 69}}}, "severity": "WARNING"}

## Using Audio Capture on iOS/iPadOS

You will be able to capture audio from iOS 10 and above. Additionally, you can validate the sounds produced by your application, enable VoiceOver, and verify its output.
Expand All @@ -111,9 +118,9 @@
:::note Limitations

- iOS Audio capture for automated test results is supported on iOS/iPadOS 10.1 and above.
- Android Audio capture for test results is supported on Android 10 and above.
- When Audio streaming is enabled, we are not attaching the audio to the test results after the session ends.
- Accessibility and TalkBack on Android are not supported.
- Android Audio capture for automated is supported on Android 10 and above.
- Android Audio capture for live testing is supported on Android 12 and above. Older devices will have limited audio depending on the device in use.
- Audio generated by Android Talkback will not be recorded in the test results video however it will be audible during live testing, streamed to your browser in real-time.
- Emulators and simulators are not supported.
- Website testing is not yet available on Android.

Expand Down
Loading