mirror of
https://gitlab.com/vyla-entertainment/documentation.git
synced 2026-11-14 22:47:26 -05:00
48 lines
2.5 KiB
Markdown
48 lines
2.5 KiB
Markdown
# Vyla
|
|
|
|
<p class="page-description">An open-source, modular media ecosystem. Native apps for desktop, mobile, and TV backed by a scraper SDK and self-hosted streaming gateway.</p>
|
|
|
|
<img class="vyla-banner" src="/src/assets/images/devices.webp" alt="Vyla across devices" loading="lazy" decoding="async" fetchpriority="low" />
|
|
|
|
## What is Vyla?
|
|
|
|
Vyla is an open-source media stack built for privacy and user control:
|
|
|
|
- **Client Apps**: Native frontends for Desktop (Windows, macOS, Linux), Android Mobile, and Android TV.
|
|
- **Vyla SDK (`@vyla-entertainment/sdk`)**: A Node.js scraping engine querying 60+ upstream sources with jitter buffering and stream validation.
|
|
- **Stream API**: A self-hostable HTTP and Server-Sent Events (SSE) gateway delivering live stream manifests, subtitles, and downloads.
|
|
|
|
:::callout-note
|
|
Vyla does not host, upload, or store video files. It resolves publicly accessible web links on demand.
|
|
:::
|
|
|
|
---
|
|
|
|
## Ecosystem Components
|
|
|
|
- **[Vyla Home](/products/home)** — Desktop app built with Tauri v2 and Rust. Includes auto-updates, Discord RPC, and offline fallbacks.
|
|
- **[Vyla Go](/products/go)** — Android mobile client with shader animations and background playback.
|
|
- **[Vyla TV](/products/tv)** — Android TV and Fire TV app with D-pad navigation and ExoPlayer playback.
|
|
- **[Stream API](/stream-api/overview)** — High-concurrency Node.js streaming gateway with cluster caching and M3U8 reverse proxying.
|
|
- **[Vyla SDK](/sdk)** — Core resolver module for Node.js backends and scrapers.
|
|
- **[Web Player](/products/player)** — Lightweight HLS integration for custom web players.
|
|
|
|
---
|
|
|
|
## Design Principles
|
|
|
|
- **No Telemetry**: No mandatory accounts, analytics, or tracking.
|
|
- **Automatic Failover**: Queries multiple providers with randomized jitter. If a provider fails, the player moves to the next candidate instantly.
|
|
- **Progressive Delivery**: Stream API emits metadata and video candidates over Server-Sent Events (SSE) so playback starts in 3 to 8 seconds.
|
|
- **Self-Hostable**: Run every service locally or deploy to your own VPS.
|
|
|
|
---
|
|
|
|
## Quick Navigation
|
|
|
|
- **Desktop Users**: Get started with [Vyla Home](/products/home).
|
|
- **Mobile & TV**: Check out [Vyla Go](/products/go) and [Vyla TV](/products/tv).
|
|
- **Node.js Developers**: See the [SDK Quickstart](/sdk/vyla-sdk/quickstart) and [API Reference](/sdk/vyla-sdk/reference).
|
|
- **Self-Hosters**: Read the [Self-Hosting Guide](/stream-api/deployment/self-hosting).
|
|
- **Need Help?**: Visit the [FAQ](/resources/faq) or [Troubleshooting](/resources/troubleshooting).
|