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

Added supported OS and frameworks matrix for audio capture docs #3072

Merged
merged 2 commits into from
Jan 23, 2025
Merged

Added supported OS and frameworks matrix for audio capture docs #3072

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
67d7038
Added supported OS and frameworks matrix for audio capture docs
diegoperini Jan 22, 2025
157104e
Removed outdated iOS instructions
diegoperini Jan 23, 2025
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
25 changes: 12 additions & 13 deletions docs/mobile-apps/features/audio-capture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,15 @@
- A Sauce Labs account ([Log in](https://accounts.saucelabs.com/am/XUI/#login/) or sign up for a [free trial license](https://saucelabs.com/sign-up))
- A native Android, iOS, or iPadOS mobile app.

## Supported Platforms and Frameworks

| | Android 9 and below | Android 10 | Android 11 | Android 12 and above | iOS 12 and below | iOS 13 and above |

Check warning on line 19 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#L19 

[sauce.SentenceSpacing] Remove the extra space.
Raw output 
{"message": "[sauce.SentenceSpacing] Remove the extra space.", "location": {"path": "docs/mobile-apps/features/audio-capture.md", "range": {"start": {"line": 19, "column": 156}}}, "severity": "WARNING"}
|------------------------------------------------------------------------------------------|:-------------------:|:--------------:|:--------------:|:---------------------:|:----------------:|:----------------:|
| Audio streaming during Live Testing | ❌ | ❌ | ❌ | ✅ | ✅ | ✅ |
| Audio recording in Live and Automated Test Reports | ❌ | Automated only | Automated only | ✅ | ❌ | ❌ |
| Text to speech audio streaming during Live Testing via Talkback/VoiceOver | ❌ | ✅ | ✅ | ✅ | ❌ | ✅ |
| Text to speech audio recording in Live and Automated Test Reports via Talkback/VoiceOver | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |

## Using Audio Capture for Automated Tests on Real Devices

Audio capture works out of box for automated tests on iOS. On Android, if the app does not define any restrictions in its manifest, then it will also work out of box.
Expand All @@ -29,7 +38,7 @@

<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 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.
You 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 @@ -45,10 +54,6 @@
:::note Limitations

- 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 @@ -94,13 +99,11 @@

### 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.
Text to speech audio of the focused element will be streamed to your browser as you interact with the devices. Text to speech audio will not be available for download once the session is over.

Check warning on line 102 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#L102 

[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": 102, "column": 168}}}, "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.
Audio capture is supported on all our iOS devices. Additionally, you can validate the sounds produced by your application, enable VoiceOver, and verify its output.

## Accessing the Audio in Your Test Tesults for Automated Test

Expand All @@ -116,10 +119,6 @@

:::note Limitations

- iOS Audio capture for automated test results is supported on iOS/iPadOS 10.1 and above.
- 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