Skip to content

App documentation

The Sofa King app watches a Sofa King server's live TV, recordings and media libraries. Start with getting started, then using Sofa King for the controls.

Guides

Page What it covers
Getting started From a running Sofa King server to a channel playing on a TV, a desktop, a phone or a browser, including serving the web app
Using Sofa King The guide, the channels it lists, previews, the library, recordings, the player, the remote and keyboard controls, sofaking:// links, captions, the Apple TV app and the settings
Troubleshooting and FAQ Symptoms and fixes for connecting, the lineup and guide, playback, the library and recordings, captions and each platform, and common questions

Reference

Page What it covers
Architecture Modules, components, data flow, storage, launch, the guide, playback on each platform and the server interface
Security What the app stores, where it sends the API token, and cleartext HTTP

Contributing

Page What it covers
Development Build and test, Android Studio, running each platform, the TV checklist and probing a TV over adb, CI and snapshot builds
Dependencies Pinned versions and how to change them

The app's README introduces it, CONTRIBUTING and SECURITY cover conventions and reporting, and the server's documentation covers the lineup, sources and the API the app reads.

Glossary

The repository glossary defines the terms the app shares with the server: server, lineup, channel, tag, guide, program and playback session. These terms are the app's own:

Term Meaning
Category A tag shown as a filter chip in the guide. A channel without a tag is under Other
Preview The muted picture of the focused channel in the guide
Info bar The overlay in the player with the channel and its current program
Channel list The list of channels the player opens over the picture, from the info bar, with Recent, Favorites, filter and All chips and the current channel's buttons
Stream card The card the player opens on Info held or Stream info on the info bar, with the audio tracks, stream details and the server's source
Live edge The newest part of a live stream. Resuming after a long pause, or falling behind, returns to it
Caption timing How far captions are shifted against the picture, saved per channel
Library, DVR The tabs beside Live that a server with media libraries, or one that records, adds
Snapshot A test build from main, published as the snapshot prerelease