tauri-plugin-libmpv 0.0.1

A Tauri plugin for embedding the mpv player in your app via libmpv.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

# Tauri Plugin libmpv


A Tauri plugin for embedding the mpv player in your app via libmpv.

## Installation


### Prerequisites


- Setup libmpv development environment.
- Tauri v2.x
- Node.js 18+

### Install the Plugin


```bash
npm run tauri add libmpv
```

### Configure Window Transparency


For mpv to properly embed into your Tauri window, you need to configure transparency:

#### 1. Set window transparency in `tauri.conf.json`


```json
{
  "app": {
    "windows": [
      {
        "title": "Your App",
        "width": 1280,
        "height": 720,
        "transparent": true  // Add this line
      }
    ]
  }
}
```

#### 2. Set web page background to transparent in your CSS


```css
/* In your main CSS file */
html,
body {
  background: transparent;
}
```

## Quick Start


```typescript
import { destroy, init, MpvConfig, observeProperties, command, MpvObservableProperty } from 'tauri-plugin-libmpv-api';

// Properties to observe
const OBSERVED_PROPERTIES = [
  ['pause', 'flag'],
  ['time-pos', 'double'],
  ['duration', 'double'],
  ['filename', 'string'],
] as const satisfies MpvObservableProperty[];

// mpv configuration
const mpvConfig: MpvConfig = {
  initialOptions: {
    'vo': 'gpu-next',
    'hwdec': 'auto-safe',
    'keep-open': 'yes',
    'force-window': 'yes',
    'pause': 'yes',
  },
  observedProperties: OBSERVED_PROPERTIES,
};

// Initialize mpv
try {
  await init(mpvConfig);
  console.log('mpv initialization completed successfully!');
} catch (error) {
  console.error('mpv initialization failed:', error);
}

// Observe properties
const unlisten = await observeProperties(
  OBSERVED_PROPERTIES,
  ({ name, change }) => {
    switch (name) {
      case 'pause':
        console.log('Playback paused state:', change);
        break;
      case 'time-pos':
        console.log('Current time position:', change);
        break;
      case 'duration':
        console.log('Duration:', change);
        break;
      case 'filename':
        console.log('Current playing file:', change);
        break;
    }
  });

// Unlisten when no longer needed
unlisten();

// Load and play a file
await command('loadfile', ['/path/to/video.mp4']);

// Destroy mpv when no longer needed
await destroy();

```

## Platform Support


- ✅ **Windows** - Fully tested and supported
- ⚠️ **Linux** - Not tested
- ⚠️ **macOS** - Not tested

## Contributing


Contributions are welcome! Please feel free to submit a Pull Request.

## License


This project is licensed under the LGPL-2.1 License - see the [LICENSE](LICENSE) file for details.

This plugin utilizes the `libmpv2` and `libmpv2-sys` crate, which is also licensed under the **LGPL-2.1** license.