mirror of
https://gitlab.com/vyla-entertainment/documentation.git
synced 2026-11-14 22:47:26 -05:00
50 lines
4.9 KiB
Plaintext
50 lines
4.9 KiB
Plaintext
# Vyla Entertainment
|
|
|
|
> Vyla is a community-built, decentralized media ecosystem and developer platform focused on privacy, user sovereignty, and self-hosted streaming infrastructure. It provides native client applications (Home, Go, TV), a Node.js scraper SDK aggregating 60+ upstream providers, and a self-hosted HTTP/SSE Stream API proxy.
|
|
|
|
## Architecture & Ecosystem Overview
|
|
|
|
- [Introduction](https://vyla.cc/start-here/introduction): Philosophy, system components, platform support, and getting started overview.
|
|
- [Architecture & System Design](https://vyla.cc/start-here/architecture): High-level system topology, module boundaries, video delivery pipelines, HLS proxy mechanics, and deployment options.
|
|
- [Provider Mechanics](https://vyla.cc/concepts/providers): Source configurations, jitter staggering, two-phase stream verification, M3U8 rewriting, and 120-byte TS de-masking.
|
|
|
|
## Native Client Applications
|
|
|
|
- [Vyla Home (Desktop)](https://vyla.cc/products/home): Desktop control center and runtime for Windows, macOS, and Linux built on Tauri v2 and an embedded Node.js sidecar.
|
|
- [Vyla Go (Android Mobile)](https://vyla.cc/products/go): Android mobile client with hardware WebGL shaders, automated runtime payload downloads, and background playback.
|
|
- [Vyla TV (Android TV)](https://vyla.cc/products/tv): Native 10-foot Leanback streaming client built with Jetpack Compose and Google ExoPlayer (Media3).
|
|
- [Building a Custom Player](https://vyla.cc/products/player): Architectural guidelines, HLS vs direct MP4/MKV handling, and resilient player design rules.
|
|
|
|
## Developer SDK (`@vyla-entertainment/sdk`)
|
|
|
|
- [SDK Overview](https://vyla.cc/sdk): Installation, capabilities, module architecture, and initial configuration.
|
|
- [SDK Quickstart](https://vyla.cc/sdk/vyla-sdk/quickstart): 5-minute setup, resolving movie and TV streams, concurrent queries, and subtitle extraction.
|
|
- [Complete API Reference](https://vyla.cc/sdk/vyla-sdk/reference): Comprehensive documentation of the VylaSDK class, methods, parameters, and TypeScript interfaces.
|
|
- [Manga Resolution Module](https://vyla.cc/sdk/vyla-sdk/manga): Title search, chapter listings, and page image extraction via atsu.moe with Chrome 131 TLS fingerprinting.
|
|
- [Contributing a Source Scraper](https://vyla.cc/sdk/vyla-sdk/contributing): How to author, test, and submit a new provider scraper module to the SDK.
|
|
|
|
## Stream API Gateway
|
|
|
|
- [Stream API Overview](https://vyla.cc/stream-api/overview): Self-hosted HTTP/SSE streaming gateway, multi-core cluster supervisor, and shared LRU cache.
|
|
- [Paths & Playback Events](https://vyla.cc/stream-api/reference/paths): SSE event specifications for `/movie` and `/tv` routes (`meta`, `source`, `done`), plus `/api` proxy query parameters.
|
|
- [Subtitles & Media Downloads](https://vyla.cc/stream-api/reference/media-data): REST endpoints for multi-language subtitle tracks and direct media download links.
|
|
- [Operations & Health Diagnostics](https://vyla.cc/stream-api/reference/operations): Automated `/health` endpoint, direct `/test/:source` harness, and `/debug` diagnostic traces.
|
|
- [API Keys & Authentication](https://vyla.cc/stream-api/authentication): Managing API keys (`pk_`, `sk_`, `pub_`), SQLite database synchronization, CLI tools, and rate limits.
|
|
- [Production Self-Hosting Guide](https://vyla.cc/stream-api/deployment/self-hosting): Docker containerization, systemd service, PM2, and Nginx reverse proxy configuration with SSE streaming support.
|
|
|
|
## Guides & Best Practices
|
|
|
|
- [Client Integration Guide](https://vyla.cc/guides/integrations): Ready-to-use player integration patterns for React, Vue 3, Android ExoPlayer, and iOS AVPlayer.
|
|
- [Error Handling & Resilience](https://vyla.cc/guides/error-handling): Error classification, exponential retry backoff, client fallback priority queues, and network recovery.
|
|
|
|
## Resources & Community
|
|
|
|
- [Frequently Asked Questions](https://vyla.cc/resources/faq): Answers to common questions regarding self-hosting, legal policies, and platform compatibility.
|
|
- [Troubleshooting & Diagnostics](https://vyla.cc/resources/troubleshooting): Step-by-step diagnostic workflows for Windows WebView2, Linux headers, and Android NDK setups.
|
|
- [Ecosystem Glossary](https://vyla.cc/resources/glossary): Authoritative definitions of ecosystem terminology (SSE, HLS, TS de-masking, Tauri sidecar, etc.).
|
|
- [Project Story](https://vyla.cc/misc/project/story): Origin story of Vyla from web project to decentralized ecosystem.
|
|
- [Changelog](https://vyla.cc/misc/project/changelog): Release history and changelog across all projects.
|
|
- [Credits & Attribution](https://vyla.cc/misc/project/credit): Acknowledgments for upstream open-source inspiration (P-Stream, CinePro).
|
|
- [Support Us](https://vyla.cc/misc/project/support-us): Community donation channels and cryptocurrency wallet addresses.
|
|
- [DMCA & Copyright Policy](https://vyla.cc/misc/project/dmca): Upstream aggregation disclosures and DMCA source removal request procedures.
|