tauri-plugin-video 0.3.0

Native video playback for Tauri using platform media engines
Documentation

Tauri platform for Air video

This repository is the Tauri platform implementation for @get-air/video, not a separate player. It publishes both halves of the tauri backend:

Package Role
@get-air/video Owns the shared controller and browser/TV backends
@get-air/video-tauri Plugs backend: 'tauri' into that controller
tauri-plugin-video Runs the native engines behind the adapter

createTauriVideoClient() returns the regular @get-air/video client with the Tauri backend installed. The DOM still owns layout, controls, and overlays.

Platform support

Target Support auto engine Alternative
Linux Supported GStreamer mpv with mpv-runtime
Windows Supported GStreamer
Android / Android TV Supported, API 24+ Media3 / MediaCodec LibVLC
macOS Not supported
iOS Not supported

Native frames never cross JavaScript or the WebView. Containers, codecs, DRM, HDR, and UHD limits depend on the selected engine and target hardware.

All engines provide playback, seeking, volume, tracks, custom headers, and telemetry. Crop-to-cover and zoom require Android or Linux mpv; playback-rate changes and frame-accurate seeking are not currently supported.

Install

npm install @get-air/video @get-air/video-tauri
[dependencies]
tauri-plugin-video = "0.2"
tauri::Builder::default()
    .plugin(tauri_plugin_video::init())
    .run(tauri::generate_context!())?;

Add video:default to the Tauri capability used by your window.

Linux uses GStreamer by default. To make mpv selectable:

tauri-plugin-video = { version = "0.2", features = ["gstreamer-runtime", "mpv-runtime"] }

Use

import { createTauriVideoClient } from '@get-air/video-tauri'

const video = createTauriVideoClient()

const player = await video.attach(document.querySelector('video')!, {
  source: movieUrl,
  backend: 'tauri',
  backendOptions: {
    tauri: { engine: 'gstreamer' },
  },
})

await player.play()

Omit engine to use the platform default: Media3 on Android and GStreamer on desktop builds that include it.

Core integrations

All @get-air/video integrations can use the installed Tauri backend:

Core integration Connect Tauri with
Promise API createTauriVideoClient()
Effect layerTauriVideoBackend() from @get-air/video-tauri/effect
React / TV focus client prop
Canvas client option
SolidTV client option
Blits client option

Keep importing the framework helpers from @get-air/video/*; only the client or Effect layer comes from the Tauri adapter. Canvas, SolidTV, and Blits also need the transparent aperture shown in the examples.

Compatibility

@get-air/video-tauri and tauri-plugin-video must use the same version.

Adapter + crate @get-air/video Native protocol
0.2.x >=0.1.1 <0.2.0 1

API · Examples · Versioning · Contributing

MIT OR Apache-2.0