SyncTV App

Watch together. Stay in sync.

A native, self-hosting-friendly client for synchronized rooms, rich media providers, real-time conversation, voice chat, and room-scoped media P2P.

简体中文 · Website · Documentation · Download · Server · Privacy · Discussion

• Synchronized playback: shared play, pause, seek, speed, source, quality, and playlist navigation with live drift correction.
• A complete room experience: discovery, guest access, membership, permissions, favorites, chat, danmaku, playback history, and administration.
• A broad media surface: on-demand video, livestreams, direct URLs, HLS, DASH, HTTP-FLV, RTMP, NAS products, private clouds, and media servers.
• Native viewing workflows: fullscreen playback, compact player and picture-in-picture, platform volume and brightness controls, and responsive desktop/mobile layouts.
• Room-scoped communication: WebRTC voice and optional media P2P with configurable short-lived persistent caching and transfer metrics.
• Modern authentication: password, OPAQUE, email, OAuth2, native passkeys, TOTP, recovery flows, and server-directed multi-factor authentication.
• Multi-server isolation: credentials, preferences, caches, and identities are separated by normalized server address.

Provider capabilities and credentials are decided by the server. The app consumes typed protobuf source configuration and lets users choose individual items, selected items, or dynamic playlists. See the server's Provider User Guide and Provider Development Guide.

flowchart LR
    P["Media providers, NAS, and direct sources"]
    S["SyncTV server"]
    A["SyncTV App · client A"]
    B["SyncTV App · client B"]

    P -->|Resolve, authorize, or proxy| S
    S <-->|Rooms, playback state, messages, signaling| A
    S <-->|Rooms, playback state, messages, signaling| B
    P -->|Direct media when selected| A
    P -->|Direct media when selected| B
    A <-.->|Room-scoped voice and media P2P| B

The server remains the authority for rooms, permissions, playback, provider decisions, and P2P swarm identity. Clients may fetch media directly or through the server's proxy according to each playback source.

Contributor-facing layering and test boundaries are documented in Application Architecture.

Every GitHub Release contains a quick-download matrix and SHA256SUMS.txt. Native debug symbols are published separately. Windows ARM64-native output depends on upstream Flutter, media-kit, and WebView2 ARM64 support.

• FVM with Flutter 3.44.8 and Dart 3.12.2.
• Node.js 24 and npm for macOS DMG packaging.
• Rust 1.97.1 for the OPAQUE native asset.
• Protobuf compiler 35.1 and Dart protoc_plugin 25.0.0 when regenerating API code.
• librsvg and FFmpeg when regenerating app icons.
• The native platform toolchain for the target: Java 17 and Android SDK, Xcode, Visual Studio, or the Linux GTK/WebKit/MPV development packages.

git clone https://github.com/synctv-org/synctv-app.git
cd synctv-app

fvm install
fvm flutter pub get
fvm dart analyze --fatal-infos
fvm flutter test
fvm flutter run

Start a SyncTV server before running the app. Debug builds use http://127.0.0.1:8080 as the development endpoint. Store and release builds open the server setup flow when no built-in server is configured.

The app owns the protobuf snapshot in proto/; generation never reads from a sibling server checkout.

dart pub global activate protoc_plugin 25.0.0
bash tool/generate_proto.sh
git diff --exit-code -- lib/src/generated

assets/icon/logo-notext.png and assets/icon/logo-notext.svg are copies of the designer-provided no-text logo. The generator creates the shared iOS and macOS Icon Composer package plus the Android, Windows, and Linux formats. Apple builds require Xcode 26 or newer.

bash tool/generate_app_icons.sh

Release builds are server-neutral by default. A distributor can embed a server explicitly:

fvm flutter build apk --release \
  --dart-define SYNCTV_BUILT_IN_SERVER_URL=https://tv.example.com

The Release workflow reads two independent repository variables. SYNCTV_BUILT_IN_SERVER_URL configures downloadable GitHub Release assets. SYNCTV_STORE_BUILT_IN_SERVER_URL configures Google Play, iOS App Store, and Mac App Store builds and resolves to an empty value when unset. SYNCTV_PASSKEY_RP_IDS accepts semicolon-separated RP IDs for native passkey association. SYNCTV_OAUTH2_APP_LINK_ORIGIN configures the HTTPS origin used by Android Auth Tabs and Apple authentication sessions. Windows and Linux use a temporary loopback callback through the system browser.

Native passkeys rely on an authenticated association between the app identity and the server's RP domain.

• Android can connect the official app to any self-hosted domain dynamically. Configure the server with package org.synctv.app and the release certificate fingerprints from the android-passkey-server-config.yaml attached to official signed releases.
• Apple platforms embed allowed RP IDs in the signed app's Associated Domains entitlement. A self-hosted Apple build must include its RP ID in SYNCTV_PASSKEY_RP_IDS, use an Apple Developer Team signature, and register <TeamID>.org.synctv.app in the server's webauthn.apple_app_ids.
• Availability is server-directed. The app exposes native passkeys only when the platform and the selected server association are valid.

The complete server configuration and security model are documented in WebAuthn and Passkeys.

The workflows are designed for both the upstream repository and forks. Repository URLs, release links, package metadata, and artifact names are derived from the active GitHub context.

• Every branch push runs formatting, analysis, generated-code checks, and tests.
• Pull requests, the default branch, and manual CI also build Android ARM64, Linux x64/ARM64, Windows x64, macOS Universal, and unsigned iOS releases.
• v* tags run the quality gate, build the full artifact matrix, produce checksums and download notes, then publish a GitHub Release.
• Store publication is opt-in and protected through the google-play and app-store GitHub Environments.

The authoritative implementations live in CI, Release, and the reusable toolchain setup action.

Join the SyncTV Telegram discussion to talk with users and contributors about setup, playback, Providers, self-hosting, and development.

SyncTV contains no advertising SDK, cross-app tracking, centralized analytics, or automatic crash reporting. Server-specific credentials and cached data remain isolated by normalized server address. Review the Privacy Policy and the selected server operator's policy before connecting accounts or providers.

SyncTV is a general-purpose synchronization client. Users and server operators are responsible for media rights, local law, provider terms, access control, and retention policy.

Licensed under Apache-2.0.