MSX Knowledge Base — Master Index
Media Station X (MSX) is a white-label TV app driven entirely by JSON served over HTTP. This knowledge base covers the MSX API from version 0.1.0 to 0.1.166.
Note: This page is a human-readable navigation index. If you are an LLM/agent, use llms.txt and AGENTS.md instead — see README.md for full usage and integration instructions.
Overview
General information about MSX, platform support, release notes, and the quick-start guide.
- Home — Overview of MSX features and capabilities
- Quick-Start Guide — Step-by-step setup instructions
- Platform Support — Supported platforms and current app versions per platform
- Release Notes — Version history and changelog
- Tips & Tricks — Practical tips: legacy TV distribution, the Web Version Loader, safely opening external links/apps, unique device IDs, the Launcher MSX service, common errors, platform quirks, and the Emergency Combination
- Showcases — Real-world MSX implementations
- About — About Media Station X
- License — License terms
- Data Privacy — Data privacy information
- Welcome — Original wiki welcome page and API taxonomy overview
Main API
Start API
The start object sets up which menu or content is loaded at startup.
Menu objects group content objects; displayed as vertical lists on the left side of the screen.
Content API
Content objects display content items on a grid; can be pages (horizontal) or list (vertical).
Common API
Used in both menu and content objects.
Extended API
Integration of third-party media sources and playlist formats.
Experts API
The experts API is designed for users who are already familiar with the main API.
Special API
Special use cases, internal actions, URL parameters, and platform-specific integrations.
Live API
Periodic content item updates (live data, playback progress, etc.) and live inline expressions.
Selection API
Control the behavior of a content item when it receives focus.
Plugin API
Create custom video/audio or interaction plugins.
Hidden Features
Features not originally intended as official API but useful for advanced use cases.
Benchmark Tests
Performance and capability tests for TV devices.
Reference
Consolidated cross-cutting reference documents synthesized from all sources.
- Type Definitions — TypeScript interfaces for all MSX JSON objects (
MSX* types) and TVX plugin classes
- Actions Reference — Complete reference for all main and internal actions
- JSON Building Guide — Step-by-step guide to building valid MSX JSON pages
- Cookbook — Curated tour of the most practical real examples: functional pages (media lists, adaptive playback, live data, interaction, plugins) and beautiful layouts. Includes deep dives on resuming playback position, the live TV/EPG guide backend, building your own interaction/video plugin, and
layout-vs-offset navigation
- Best Practices & Good to Know — Recommendations learned from building real pages, plus rendering behaviors/quirks worth knowing — not covered on any single API reference page
- Versioning — Version model, compatibility rules, feature minimum versions
- Glossary — Key MSX terms defined
- Common Misconceptions — Anti-hallucination reference: plausible-sounding things that do NOT exist
- In-App Settings Reference — The native, end-user-facing Settings screen: every panel, its allowed values, how to open/set it from a JSON action, and how a plugin reads it. Covers what the URL Parameters and Settings Menu Item pages don’t: which settings are runtime-adjustable vs. launch-only, the Context Menu (Home/Player/Volume/Settings/Exit), and the
layout fix: prefix
Examples
101 JSON example files with a searchable catalog.
- Examples Index — Catalog of all examples with metadata
- guide/ — 29 basic examples (since
0.1.0)
- github/base/ — 4 baseline examples (since
0.1.0; youtube.json requires the YouTube plugin, since 0.1.40)
- github/extended/ — 14 extended examples (require
0.1.112, except list3_section0.json–list3_section3.json which require 0.1.144)
- github/ — 2 top-level examples (since
0.1.0)
- xp/ — 52 experimental/advanced tests