mirror of
https://gitlab.com/vyla-entertainment/documentation.git
synced 2026-11-09 20:17:20 -05:00
43 lines
2.9 KiB
Plaintext
43 lines
2.9 KiB
Plaintext
--- START OF FILE llms.txt ---
|
|
# Vyla Entertainment
|
|
|
|
> Vyla is a community-built, self-hosted media platform and developer ecosystem focused on user freedom, privacy, and decentralized control. It provides native client applications (Home, Go, TV), a Node.js scraper SDK, and an optional HTTP/SSE Stream API proxy.
|
|
|
|
## Overview & Architecture
|
|
|
|
- [Introduction](https://vyla.cc/): Community ethos, mission, platforms, and getting started overview.
|
|
- [Our Architecture](https://vyla.cc/start-here/architecture): System decoupling between local runtimes, provider resolution, and playback delivery.
|
|
|
|
## Products
|
|
|
|
- [Vyla Home](https://vyla.cc/products/home): Desktop control center and application runtime for Windows, macOS, and Linux.
|
|
- [Vyla Go](https://vyla.cc/products/go): Android mobile client managing local service lifecycles and embedded playback.
|
|
- [Vyla TV](https://vyla.cc/products/tv): Android TV Leanback streaming client built with Jetpack Compose and ExoPlayer.
|
|
- [Build a Player](https://vyla.cc/products/player): Architectural guidelines for building resilient client media players.
|
|
|
|
## Core Concepts
|
|
|
|
- [Providers](https://vyla.cc/concepts/providers): Source configurations, jitter, timeout policies, HLS proxy mechanics, and verification pipelines.
|
|
|
|
## Developer SDK
|
|
|
|
- [SDK Reference](https://vyla.cc/sdk): Node.js package (@vyla-entertainment/sdk) for direct stream resolution, subtitles, downloads, and health probing.
|
|
- [SDK Quickstart](https://vyla.cc/sdk/vyla-sdk/quickstart): Rapid installation, provider selection, and server-side integration guide.
|
|
|
|
## Stream API
|
|
|
|
- [Stream API Overview](https://vyla.cc/stream-api/overview): Self-hosted HTTP and SSE progressive playback service.
|
|
- [Paths & Playback Events](https://vyla.cc/stream-api/reference/paths): SSE event contract for /movie and /tv routes emitting meta, source, and done events.
|
|
- [Subtitles & Downloads](https://vyla.cc/stream-api/reference/media-data): REST endpoints for subtitle track extraction and direct media downloads.
|
|
- [Operations & Health](https://vyla.cc/stream-api/reference/operations): /health metrics, /test probes, and safe production troubleshooting.
|
|
- [Self-Hosting Guide](https://vyla.cc/stream-api/deployment/self-hosting): Node.js deployment, cluster scaling, environment variables, and reverse proxy setup.
|
|
|
|
## Guides & Integrations
|
|
|
|
- [Client Integration](https://vyla.cc/guides/integrations): Frontend implementation patterns using HLS.js, React, Vue, ExoPlayer, and AVPlayer.
|
|
- [Error Handling](https://vyla.cc/guides/error-handling): Handling SSE timeouts, fallback queues, subtitle absence, and retry strategies.
|
|
|
|
## Policies & Attribution
|
|
|
|
- [Credit](https://vyla.cc/misc/project/credit): Acknowledgments for upstream open-source inspiration including P-Stream, CinePro, and Movieslay.
|
|
- [DMCA Policy](https://vyla.cc/misc/project/dmca): DMCA takedown procedures, upstream content aggregation disclosures, and contact points. |