Map: iOS app that plays the narration track
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- ios, typescript
- Domain
- audio-video-rtc, mobile
Research direction
Read the glossary, conversion and authentication architecture pages, apps/mobile-app/README.md, and qa/mobile-e2e/README.md; review ADR 0011 and the simulator probe in issue 374. The map calls for a physical iPad probe to resolve playback, controls, headphone, call, and save behavior before writing the spec. Done means one spec ready for /to-tickets that covers CUP-81’s acceptance check, testing, and documentation changes.
Written by the indexing model from the issue text.
Description
Destination
A spec ready for /to-tickets that makes Cup's iOS app play an audiobook's narration track reliably. It names the playback engine and any native pieces the shell gets, and how system media controls, headphone disconnects, calls and listening-position saves behave. It says how the result is tested on the simulator and on a physical device, and which ADRs, architecture pages and READMEs change. Its acceptance check is CUP-81's: with the device locked, playback continues through a whole audiobook on the operator's iPad Air 2022 (latest iPadOS), which stands in for an iPhone; system media controls show title, cover image, whole duration and position, and their play, pause and seek actions work; playback pauses when headphones disconnect; and the saved listening position follows the same rules as the web player. Releasing the app is out of this map's scope (see Out of scope).
Notes
- Origin: CUP-81 iOS app that plays the narration track (Linear, stays in Backlog while this map is open). On 2026-11-16 it was split, with this map, from CUP-41 and Map: Native Android media player, which keep Android.
- Starting point: the shell plays through the web player's single
<audio>in itsWKWebView, best effort (ADR 0011), and keepsUIBackgroundModesaudio. The web player sets onlynavigator.mediaSession.metadata. The removed per-segmentNarration*Swift components are in git history at0fb4e71d; they played one MP3 per segment, so none of them applies unchanged. - Evidence so far: Narration track playback in the Capacitor WebView (2026-10-27, from source: WebKit keeps audio-only media playing in the background and publishes Now Playing by default) and the simulator probe under Decisions so far. None of it comes from a physical device.
- Settled while charting (2026-11-14, carried over from the shared map).
- The map ends in one spec; it plans only and carries no build.
- The engine is an open decision: WebView
<audio>with WebKit's Now Playing and any minimal native pieces (keeps ADR 0011), or a native player (supersedes its "native players removed"). - Probes run AFK on the simulator wherever it can show the behavior. HITL probes on the operator's iPad cover only what it cannot, such as a real locked listen, headphone routing and calls.
- Settled at the split (2026-11-16). The web player's
navigator.mediaSessionaction handlers and position state, for every platform, belong to Map: Native Android media player. This map builds on that decision and only checks how WebKit's Now Playing reacts to it. - Skills:
grillinganddomain-modelingfor grilling tickets,researchfor research tickets. Read the glossary, the conversion architecture (Playback; Delivery, positions and lifecycle), the signed media URL,apps/mobile-app/README.mdand the mobile E2E suite first.
Decisions so far
- Can the Capacitor WebView's audio element play a narration track with the device locked? (from the narration-track map): likely yes on iOS with the existing configuration; device behavior unverified.
- How do iOS Safari and Android Chrome fetch and play one long MP3 while locked? (from the narration-track map): the engine keeps issuing range requests through a locked listen without page JavaScript, so media authorization must stay valid from Play to the end.
- How is the narration track authorized over a long listening session? (from the narration-track map): a signed track URL valid for the whole session.
- Which native configuration stays in the Capacitor shells? (from the narration-track map): the shell got removals only and keeps the
audiobackground mode; everything that makes it play moved to this increment. - Which plugins or players could give Cup's Android and iOS apps a media-playback foreground service and system controls under Capacitor 8? (from the Android map): for iOS, a WebView engine needs no native code for Now Playing;
@capgo/capacitor-media-sessionwritesMPNowPlayingInfoCenternatively, which may compete with WebKit's own (unverified); native players (Capawesome Audio Player, hand-written AVPlayer) are viable but add a second engine behind the web player, and AVPlayer pauses on headphone disconnect; from source and docs, not run. - How does Cup's WebView audio behave on the iOS simulator?: with WebKit's defaults the lock screen shows title, scrubber, Play/Pause and 10-second skips that drive the
<audio>, artwork unconfirmed;navigator.mediaSessionhandlers receive those commands andsetPositionStatetakes over the shown position; signed-URL range requests fromcapacitor://localhostreturn206through seeks and a locked listen; audio, timers andCapacitorHttpsaves kept running while locked only because the simulator ignores RunningBoard's suspension of Cup's app, page and network processes after about 30 s, so a device may stop page scripts and saves while audio plays.
Not yet specified
- Listening-position saves while locked. Depends on what the iPad probe shows: if iOS suspends the page, how saves happen during a locked listen (natively, on unlock, or not at all), and whether "the same rules as the web player" still hold.
- System controls. Whether WebKit's Now Playing, with the handlers and position state the Android map decides, is enough, or whether Cup writes Now Playing natively.
- Headphones, calls and other apps. What Cup does when each happens, once the iPad probe shows what WebKit does by itself.
UIBackgroundModesaudio. Whether it stays, from the probe's variant run.- Testing. What the mobile E2E suite can cover on the simulator, and the physical-device protocol.
- Documentation. Which ADRs, architecture pages, glossary terms and READMEs the build changes.
Out of scope
- Releasing the app: CUP-79 Publish the iOS app to the App Store. CUP-81's "the iOS app is released" criterion is met through it.
- The Android app and the web player's media-session handlers and position state: Map: Native Android media player.
- Testing the app's other native functionality on physical devices: CUP-44, which CUP-81 blocks.
- A player queue (CUP-57) and the transcript view (CUP-9).
- Dominant language
- TypeScript
- Stars
- 1
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from patricktree/cup
-
wayfinder:grilling
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
patricktree/cup#484 ·
-
wayfinder:grilling
Difficulty 2/5 1-3 hours Newbie friendliness 48/100
patricktree/cup#487 ·
-
wayfinder:grilling
Difficulty 5/5 Over a week Newbie friendliness 25/100
patricktree/cup#486 ·
-
wayfinder:grilling
Difficulty 5/5 Over a week Newbie friendliness 25/100
patricktree/cup#485 ·
-
wayfinder:grilling
Difficulty 5/5 Over a week Newbie friendliness 25/100
patricktree/cup#483 ·
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
vercel-labs/ui#865 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 63/100
outline/outline#14638 · 1 comment ·
Maintainers usually reply within 1 day
-
bot:ai-assisted component:platform-js status:untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
midnightntwrk/platform-js#69 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
Maintainers usually reply within 1 day