Adopting Picture in Picture Playback in tvOS
At a glance
| Item | Summary |
|---|---|
| Purpose | Add advanced multitasking capabilities to your video apps by using Picture in Picture playback in tvOS. |
| App architecture | A Swift sample with the source-visible chain AppDelegate → ViewController → AVKit APIs. |
| Main patterns | View-controller organization, Protocol-oriented abstraction, Delegate or data-source callbacks |
| Project style | 6 scanned source file(s) across Swift, organized around ranked entry, type, and file boundaries. |
| Execution model | Source-visible boundaries: RunLoop.main; none alone proves a background thread. |
| State/event model | No structured observation or publisher-scheduling marker indexed. |
| Key frameworks/packages | UIKit, AVKit, AVFoundation, Combine; these are source dependencies, not architecture labels. |
Project structure
Source bundle/
├── PictureInPictureSample/
│ ├── AppDelegate.swift
│ ├── ButtonGridView.swift
│ ├── CustomPlayerControlsView.swift
│ ├── CustomPlayerViewController.swift
│ ├── ViewController.swift
│ ├── PlaybackItem.swift
│ ├── Info-iOS.plist
│ └── Info-tvOS.plist
├── Configuration/
│ └── SampleCode.xcconfig
└── PictureInPictureSample.xcodeproj/
├── .xcodesamplecode.plist
└── project.pbxproj
Structure observations
- Architecturally prominent files are ranked from entry points and role-named declarations; resource-only paths are omitted.
- Primary languages: Swift.
- The verified tree contains 5 project/configuration file(s) and 13 source declaration(s).
Overall architecture
flowchart LR
N1["AppDelegate"]
N2["ViewController"]
N3["AVKit APIs"]
N1 --> N2
N2 --> N3
Reference code
PictureInPictureSample/AppDelegate.swift:11 — architecture anchor
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
var window: UIWindow?
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
window = UIWindow(frame: UIScreen.main.bounds)
window?.rootViewController = ViewController()
window?.makeKeyAndVisible()
// The app's AVAudioSession must be a PiP-appropriate audio category, such as AVAudioSessionCategoryPlayback.
do {
try AVAudioSession.sharedInstance().setCategory(.playback, mode: .moviePlayback)
} catch {
print("Setting category to AVAudioSessionCategoryPlayback failed.")
}
return true
}
}Interpretation
The arrows summarize the source-visible entry, role-named types or folders, and framework direction; when nodes come from structural folders, the sequence is a high-level interpretation rather than proof that every adjacent node calls the next. Ownership is claimed only where the next section cites a stored property or assignment. The diagram is intentionally limited to the dominant path into AVKit.
Ownership and state
classDiagram
AppDelegate o-- UIWindow : window
Button o-- IndexPath : indexPath
Button o-- ButtonGridViewDelegate : delegate
Button o-- Text : text
Ownership evidence
PictureInPictureSample/AppDelegate.swift:14 — stored dependency or nearest verified ownership anchor
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
// ...
var window: UIWindow?
// ...
}| Owner | Object or state | Relationship | Mutation authority |
|---|---|---|---|
AppDelegate |
UIWindow (window) |
stores or receives | App/module collaborators |
Button |
IndexPath (indexPath) |
stores or receives | App/module collaborators |
Button |
ButtonGridViewDelegate (delegate) |
holds a non-owning reference | The referenced object’s lifecycle is owned elsewhere |
Button |
Text (text) |
stores or receives | App/module collaborators |
Composition arrows indicate a source-visible construction expression or locally owned value state; aggregation means the owner stores or receives a dependency without proving exclusive lifetime ownership.
Concurrency, scheduling, and thread safety
Evidence limit: actor isolation, async/await, or Task creation does not by itself prove background-thread execution; Sendable conformance alone does not prove thread-safe mutation.
| Concern | Source mechanism | Verified placement or handoff | Evidence |
|---|---|---|---|
| Run-loop scheduling | RunLoop.main |
The source refers to the main thread’s run loop, a scheduling/liveness boundary rather than actor isolation. | PictureInPictureSample/CustomPlayerControlsView.swift:71 |
@MainActor/MainActor.run, DispatchQueue.main, and RunLoop.main are reported as distinct isolation, queue, and event-loop mechanisms. A plain Task is kept separate from Task.detached; neither is labeled as a background thread.
Reference code
PictureInPictureSample/CustomPlayerControlsView.swift:71 — representative execution boundary
RunLoop.main.add(self.progressTimer, forMode: .default)
let menuGestureRecognizer = UITapGestureRecognizer(target: self, action: #selector(menuGestureHandler(recognizer:)))
menuGestureRecognizer.allowedPressTypes = [UIPress.PressType.menu].map { $0.rawValue as NSNumber }State propagation, frameworks, and dependencies
Evidence limit: an import proves a source-level compilation dependency at the cited line; it does not prove runtime use, architectural adoption, or whether a Swift package is a direct application dependency.
| Category | Mechanism or module | Verified role | Evidence |
|---|---|---|---|
| Source import | UIKit |
The cited file imports this module; runtime use and architectural role are not inferred. | PictureInPictureSample/AppDelegate.swift:9 |
| Source import | AVKit |
The cited file imports this module; runtime use and architectural role are not inferred. | PictureInPictureSample/CustomPlayerControlsView.swift:8 |
| Source import | AVFoundation |
The cited file imports this module; runtime use and architectural role are not inferred. | PictureInPictureSample/AppDelegate.swift:8 |
| Source import | Combine |
The cited file imports this module; runtime use and architectural role are not inferred. | PictureInPictureSample/CustomPlayerControlsView.swift:9 |
receive(on:) describes downstream delivery scheduling, while subscribe(on:) describes upstream subscription/request/cancel scheduling. An import Combine alone establishes neither behavior nor a Store, reducer, Redux, or other application architecture.
Class and protocol design
PictureInPictureSample/ButtonGridView.swift:10 — representative type boundary
protocol ButtonGridViewDelegate: AnyObject {
func buttonGrid(_ buttonGrid: ButtonGridView, titleForButtonAtIndexPath indexPath: IndexPath) -> String
func buttonGrid(_ buttonGrid: ButtonGridView, didSelectItemAtIndexPath indexPath: IndexPath)
}| Type | Responsibility | Depends on or conforms to |
|---|---|---|
AppDelegate |
Receives callback-driven events | UIResponder, UIApplicationDelegate |
ButtonGridViewDelegate |
Defines a capability or collaboration contract | AnyObject |
CustomPlayerControlsViewDelegate |
Defines a capability or collaboration contract | AnyObject |
CustomPlayerViewControllerDelegate |
Defines a capability or collaboration contract | AnyObject |
ButtonGridView |
User-interface presentation and input forwarding | UIView |
CustomPlayerControlsView |
User-interface presentation and input forwarding | UIView |
CustomPlayerViewController |
View lifecycle, callbacks, and feature coordination | UIViewController |
ViewController |
View lifecycle, callbacks, and feature coordination | UIViewController |
Button |
Owns feature behavior and collaborator lifecycle | UIButton |
Button |
Owns feature behavior and collaborator lifecycle | UIButton |
The source explicitly defines local protocol relationships: CustomPlayerViewController → CustomPlayerControlsViewDelegate, ViewController → CustomPlayerViewControllerDelegate, ViewController → ButtonGridViewDelegate.
Access control
| Symbol | Access | Verified effect | Likely rationale |
|---|---|---|---|
didSelectButton (PictureInPictureSample/ButtonGridView.swift:101) |
private |
Use is restricted to the lexical declaration and same-file extensions allowed by Swift. | Inference: hide an implementation step that is not part of the collaboration surface. |
player (PictureInPictureSample/CustomPlayerControlsView.swift:48) |
private |
Use is restricted to the lexical declaration and same-file extensions allowed by Swift. | Inference: keep state mutation or dependency lifetime inside the owning implementation. |
pipController (PictureInPictureSample/CustomPlayerControlsView.swift:49) |
private |
Use is restricted to the lexical declaration and same-file extensions allowed by Swift. | Inference: keep state mutation or dependency lifetime inside the owning implementation. |
buttonStackView (PictureInPictureSample/CustomPlayerControlsView.swift:51) |
private |
Use is restricted to the lexical declaration and same-file extensions allowed by Swift. | Inference: keep state mutation or dependency lifetime inside the owning implementation. |
Reference code
PictureInPictureSample/ButtonGridView.swift:101 — representative boundary
@objc private func didSelectButton(button: Button) {
delegate?.buttonGrid(self, didSelectItemAtIndexPath: button.indexPath)
}Swift declarations without a modifier are internal; explicit private, fileprivate, private(set), public, or open entries above are interpreted by language semantics. Objective-C/C samples instead rely on header and implementation boundaries, which are not equivalent to Swift lexical privacy.
Logic ownership and placement
| Logic | Owning type or file | Placement rationale |
|---|---|---|
| View lifecycle, callbacks, and feature coordination | CustomPlayerViewController, ViewController |
The source’s Controller suffix makes this role explicit. |
| Receives callback-driven events | AppDelegate, ButtonGridViewDelegate, CustomPlayerControlsViewDelegate, CustomPlayerViewControllerDelegate |
The source’s Delegate suffix makes this role explicit. |
| User-interface presentation and input forwarding | ButtonGridView, CustomPlayerControlsView |
The source’s View suffix makes this role explicit. |
Design patterns
| Pattern | Source evidence | Purpose or tradeoff |
|---|---|---|
| View-controller organization | PictureInPictureSample/CustomPlayerViewController.swift:23 |
A controller is the verified coordination boundary; this is MVC-style only where a separate model is present. |
| Protocol-oriented abstraction | PictureInPictureSample/CustomPlayerViewController.swift:128 |
A local protocol and concrete conformance create an explicit capability boundary. |
| Delegate or data-source callbacks | PictureInPictureSample/AppDelegate.swift:12 |
Callback protocols invert event delivery back into the sample’s owner. |
Naming conventions
- Types: Controller: CustomPlayerViewController, ViewController; Delegate: AppDelegate, ButtonGridViewDelegate, CustomPlayerControlsViewDelegate, CustomPlayerViewControllerDelegate; View: ButtonGridView, CustomPlayerControlsView.
- Protocols:
ButtonGridViewDelegate,CustomPlayerControlsViewDelegate,CustomPlayerViewControllerDelegate. - Methods:
application,buttonGrid,didUpdateFocus,didSelectButton,controlsViewDidRequestStartPictureInPicture,controlsViewDidRequestStopPictureInPicture,controlsViewDidRequestControlsDismissal,controlsViewDidRequestPlayerDismissal. - Files:
PictureInPictureSample/AppDelegate.swift,PictureInPictureSample/ButtonGridView.swift,PictureInPictureSample/CustomPlayerControlsView.swift,PictureInPictureSample/CustomPlayerViewController.swift,PictureInPictureSample/ViewController.swift,PictureInPictureSample/PlaybackItem.swift.
Architecture takeaways
AppDelegateis the main source-visible entry or composition anchor for this sample.- Framework work reaches UIKit, AVKit, AVFoundation through a deliberately small high-level chain; the detailed API graph remains inside the cited implementation files.
- Stored-property evidence identifies lifecycle collaboration; it does not by itself prove exclusive object ownership.
- Access-control conclusions separate verified language visibility from the likely design rationale.
- Local protocol relationships provide an explicit substitution boundary.
Source map
| Source file | Relevant symbols |
|---|---|
PictureInPictureSample/AppDelegate.swift |
Cited implementation, UIKit, AVFoundation, AppDelegate |
PictureInPictureSample/ButtonGridView.swift |
ButtonGridViewDelegate, Cited implementation, ButtonGridView, Button |
PictureInPictureSample/CustomPlayerControlsView.swift |
Cited implementation, RunLoop.main, AVKit, Combine, CustomPlayerControlsViewDelegate, CustomPlayerControlsView, Button |
PictureInPictureSample/CustomPlayerViewController.swift |
CustomPlayerViewController, Cited implementation, CustomPlayerViewControllerDelegate |
PictureInPictureSample/ViewController.swift |
ViewController |
PictureInPictureSample/PlaybackItem.swift |
PlaybackItem, PlayerKind, Video |