# MusicPlayer

**Repository Path**: volving/MusicPlayer

## Basic Information

- **Project Name**: MusicPlayer
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-05-22
- **Last Updated**: 2025-05-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# MusicPlayer

[![Github CI Status](https://github.com/ddddxxx/MusicPlayer/workflows/CI/badge.svg)](https://github.com/ddddxxx/MusicPlayer/actions)
[![codebeat badge](https://codebeat.co/badges/1e88cb27-5d83-48d0-b50b-ad88593e2b5f)](https://codebeat.co/projects/github-com-ddddxxx-musicplayer-master)

Music player submodule for [LyricsX](https://github.com/ddddxxx/LyricsX).

Unified API for music players.

## Supported Players

#### macOS

- [x] Apple Music (iTunes)
- [x] Spotify
- [x] Vox
- [x] Audirvana
- [x] Swinsian

#### iOS

- [x] Music
- [ ] Spotify (see [#5](https://github.com/ddddxxx/MusicPlayer/issues/5))

#### Linux

- [x] [MPRIS](https://specifications.freedesktop.org/mpris-spec/latest/) (test needed) (Thanks to [@suransea](https://github.com/suransea))

<details><summary>Read me before using MPRIS</summary>

##### dependencies

- [playerctl](https://github.com/altdesktop/playerctl) (could be installed by package manager)

> A running `GMainLoop` is required to automatically update the player and playback status for MPRIS.
> If not, you can run one by: 
> ```swift
> GRunLoop.main.run()
> ```
> or in other threads:
> ```swift
> Thread.detachNewThread { 
>     GRunLoop.main.run() 
> }
> ```

</details>

#### Universal

- SystemMedia: System-wide Now Playing
  - [x] macOS
  - [x] iOS (jailbroken device only) (test needed)
  - [ ] Windows (via [SMTC](https://docs.microsoft.com/en-us/uwp/api/windows.media.systemmediatransportcontrols))
- [ ] Spotify (Web API)

#### Helper:

- [x] Agent: Delegate events to another player.
- [x] Now Playing: Automatically choose a playing player from given players.
- [x] MPRIS Now Playing: Just like Now Playing, but automatically find available MPRIS players.
- [x] Virtual: A virtual player that allows you to manipulate its state.
- [ ] Remote: Sync player state from other devices.

## Usage

### Quick Start

```swift
let player = MusicPlayers.Scriptable(name: .appleMusic)!
let track = player.currentTrack.title
if player.playbackState.isPlaying {
    player.skipToNextItem()
}
```

## License

MusicPlayer is part of LyricsX and licensed under MPL 2.0. See the [LICENSE file](LICENSE).