Map: iOS app that plays the narration track

Open
#386 0 comments 0 reactions 0 assignees View on GitHub

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

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

wayfinder:map

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 its WKWebView, best effort (ADR 0011), and keeps UIBackgroundModes audio. The web player sets only navigator.mediaSession.metadata. The removed per-segment Narration* Swift components are in git history at 0fb4e71d; 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.mediaSession action 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: grilling and domain-modeling for grilling tickets, research for research tickets. Read the glossary, the conversion architecture (Playback; Delivery, positions and lifecycle), the signed media URL, apps/mobile-app/README.md and the mobile E2E suite first.

Decisions so far

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.
  • UIBackgroundModes audio. 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

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

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from patricktree/cup

All issues in patricktree/cup

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.