mirror of
https://gitlab.com/vyla-entertainment/documentation.git
synced 2026-11-16 23:47:22 -05:00
huge doc rewrite
This commit is contained in:
17
products/go.md
Normal file
17
products/go.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# Vyla Go
|
||||
|
||||
<p class="page-description">The Android control center for running the Vyla media stack locally.</p>
|
||||
|
||||
<img class="vyla-banner" src="/assets/images/android/site_preview.png" alt="A collage of films and shows available through a Vyla experience" loading="lazy" fetchpriority="low" />
|
||||
|
||||
**Vyla Go** is the Android application in the Vyla ecosystem. It prepares and runs the local services that power your media experience, then opens the interface in a secure embedded window. It is designed for people who want Vyla on their Android device without managing a separate server process or service lifecycle by hand.
|
||||
|
||||
## Downloads
|
||||
|
||||
Vyla Go is available for Android. Get the latest version below:
|
||||
|
||||
| Platform | Download |
|
||||
| --- | --- |
|
||||
| Android | [Download .apk](https://gitlab.com/vyla-entertainment/go/-/releases) |
|
||||
|
||||
Inside the releases page, you can find the latest version of Vyla Go for Android, find the `.apk` file, and install it on your device.
|
||||
73
products/home.md
Normal file
73
products/home.md
Normal file
@@ -0,0 +1,73 @@
|
||||
# Vyla Home
|
||||
|
||||
<p class="page-description">The desktop control center for running the Vyla media stack locally.</p>
|
||||
|
||||
<img class="vyla-banner" src="/assets/images/desktop/site_preview.png" alt="Vyla Home desktop application preview" loading="lazy" fetchpriority="low" />
|
||||
|
||||
## Vyla Home
|
||||
|
||||
**Vyla Home** is the desktop application in the Vyla ecosystem. It prepares and runs the local services that power your media experience, then opens the interface in a secure embedded window. It is designed for people who want Vyla without managing a separate server process, reverse proxy, or service lifecycle by hand.
|
||||
|
||||
## Downloads
|
||||
|
||||
Vyla Home is available for Windows, macOS, and Linux. Get the latest version below:
|
||||
|
||||
| Platform | Download |
|
||||
| --- | --- |
|
||||
| Windows | [Download .exe](https://gitlab.com/vyla-entertainment/home/-/releases) |
|
||||
| macOS | [Download .dmg](https://gitlab.com/vyla-entertainment/home/-/releases) |
|
||||
| Linux | [Build from source](#linux-setup) |
|
||||
|
||||
Inside the releases page, you can find the latest version of Vyla Home for each platform, find the `.exe` for windows, and `.dmg` for macOS.
|
||||
|
||||
## Linux Setup
|
||||
|
||||
For Linux, you'll need to build Vyla Home from source. Follow these steps to install on Fedora:
|
||||
|
||||
**Step 1: Install dependencies**
|
||||
|
||||
```bash
|
||||
sudo dnf install webkit2gtk4.1-devel curl wget openssl-devel libappindicator-gtk3-devel librsvg2-devel
|
||||
sudo dnf install gcc gcc-c++ make automake autoconf
|
||||
```
|
||||
|
||||
**Step 2: Install Node.js and NPM**
|
||||
|
||||
```bash
|
||||
sudo dnf install nodejs npm
|
||||
```
|
||||
|
||||
**Step 3: Install Rust**
|
||||
|
||||
```bash
|
||||
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
|
||||
source "$HOME/.cargo/env"
|
||||
```
|
||||
|
||||
**Step 4: Clone the Git repository**
|
||||
|
||||
```bash
|
||||
git clone https://gitlab.com/vyla-entertainment/home.git vyla-home
|
||||
cd vyla-home
|
||||
```
|
||||
|
||||
**Step 5: Install more dependencies**
|
||||
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
**Step 6: Build the Fedora package (.rpm)**
|
||||
|
||||
```bash
|
||||
cargo update --manifest-path src-tauri/Cargo.toml
|
||||
npx tauri build --bundles rpm,appimage
|
||||
```
|
||||
|
||||
**Step 7: Final installation**
|
||||
|
||||
```bash
|
||||
sudo dnf install src-tauri/target/release/bundle/rpm/*.rpm
|
||||
```
|
||||
|
||||
*Thank you @krishi279 for supplying the Linux setup instructions on Discord ❤️.*
|
||||
37
products/player.md
Normal file
37
products/player.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# Build a player
|
||||
|
||||
<p class="page-description">Design a resilient Vyla playback experience around your own product and infrastructure.</p>
|
||||
|
||||
## Your player, your rules
|
||||
|
||||
Vyla supplies the integration layer; your application owns the player experience. That includes design, authentication, title discovery, parental controls, analytics, playback policy, and fallback behavior.
|
||||
|
||||
For a local managed experience, Vyla Home starts its bundled player service. For a custom product, choose one of two boundaries:
|
||||
|
||||
| Integration | Best for |
|
||||
| --- | --- |
|
||||
| **SDK directly** | Node.js products that already have a backend and want complete control |
|
||||
| **Stream API** | browser or mobile clients that need an HTTP/SSE source feed |
|
||||
|
||||
## Build for changing conditions
|
||||
|
||||
Provider results vary by title and network. A dependable player should:
|
||||
|
||||
1. Begin playback as soon as it has a usable candidate.
|
||||
2. Keep later candidates as fallbacks.
|
||||
3. Keep subtitles independent from first playback.
|
||||
4. Report a helpful unavailable state when no candidates resolve.
|
||||
5. Destroy playback and abort in-flight work when the viewer changes titles.
|
||||
|
||||
The SDK returns provider results directly; Stream API emits `meta`, `source`, and `done` events. Both models benefit from the same fallback strategy.
|
||||
|
||||
## Playback formats
|
||||
|
||||
Candidates may be HLS manifests or direct media files. Let the result metadata and your player capabilities guide how a candidate is loaded; do not assume every URL has the same format or availability. HLS-capable web players normally use HLS.js where native HLS is unavailable, while direct media can be assigned to a video element.
|
||||
|
||||
## Continue building
|
||||
|
||||
- Embed provider resolution with [SDK quickstart](/sdk/vyla-sdk/quickstart).
|
||||
- Learn the optional HTTP event contract in [Paths and playback events](/stream-api/reference/paths).
|
||||
- Use the [client integration guide](/guides/integrations) for a browser-oriented example.
|
||||
- Review [error handling](/guides/error-handling) before shipping a player.
|
||||
19
products/tv.md
Normal file
19
products/tv.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# Vyla TV
|
||||
|
||||
<p class="page-description">The Android TV application for running the Vyla media experience on your television.</p>
|
||||
|
||||
<img class="vyla-banner" src="/assets/images/android-tv/site-preview.png" alt="A collage of films and shows available through a Vyla experience" loading="lazy" fetchpriority="low" />
|
||||
|
||||
## Vyla TV
|
||||
|
||||
**Vyla TV** is an Android TV streaming app built with Jetpack Compose and ExoPlayer that lets you browse and watch movies and TV shows from TMDB.
|
||||
|
||||
## Downloads
|
||||
|
||||
Vyla TV is available for Android TV. Get the latest version below:
|
||||
|
||||
| Platform | Download |
|
||||
| --- | --- |
|
||||
| Android TV | [Download .apk](https://gitlab.com/vyla-entertainment/TV/-/releases) |
|
||||
|
||||
Inside the releases page, you can find the latest version of Vyla TV for Android TV, find the `.apk` file, and install it on your device.
|
||||
Reference in New Issue
Block a user