An open API service indexing awesome lists of open source software.

https://github.com/mistic100/rainmeter-nowplayingplex

A Rainmeter plugin to read the currently playing track on Plex.
https://github.com/mistic100/rainmeter-nowplayingplex

plex plugin rainmeter

Last synced: 4 months ago
JSON representation

A Rainmeter plugin to read the currently playing track on Plex.

Awesome Lists containing this project

README

          

NowPlayingPlex.dll
================

A Rainmeter plugin to read the currently playing track on Plex.

# Usage

The plugin works similarly to the [NowPlaying measure](https://docs.rainmeter.net/manual/measures/nowplaying) : there is a main measure doing the query and child measures connected to the main.

# Options

### `PlexToken` (required on main measure)

_Main measure only._ Your personnal access token ([how to get it](https://www.plexopedia.com/plex-media-server/general/plex-token/)).

### `PlexServer` (default: `http://localhost:32400`)

_Main measure only._ The url of your Plex server.

### `PlexUsername`

_Main measure only._ Your Plex username, this is used to filter the sessions if other users are using your server. If not defined, the first session will be used.

### `PlayerName` (required on child measures)

_Child measures only._ Name of the main measure.

### `PlayerType` (required)

Type of the measure value. Valid values are:

- `Artist` : Track artist.
- `Album` : Current album.
- `Title` : Track title.
- `Number` : Track number.
- `Year` : Track year.
- `Cover` : URL to cover art.
- `File` : Path to the playing media file.
- `Duration` : Total length of track in seconds.
- `Position` : Current position in track in seconds.
- `Progress` : Percentage of track completed.
- `State` : 0 for stopped, 1 for playing, and 2 for paused.

**Notes:** With measures of type `Duration` or `Position`, the string value is in the form `MM:SS` and the number value is the actual number of seconds.

### `DisableLeadingZero` (default: `0`)

_Main measure only._ If set to `1`, the format of `Duration` and `Position` is `M:SS` instead of `MM:SS`.

# Example

```ini
[Rainmeter]
Update=1000

[Variables]
PlexToken=XXXXXX
PlexUsername=JohnDoe

[MeasureTitlePlex]
Measure=Plugin
Plugin=NowPlayingPlex
PlexToken=#PlexToken#
PlexUsername=#PlexUsername#
PlayerType=Title

[MeasureArtistPlex]
Measure=Plugin
Plugin=NowPlayingPlex
PlayerName=MeasureTitlePlex
PlayerType=Artist

[MeasureAlbumPlex]
Measure=Plugin
Plugin=NowPlayingPlex
PlayerName=MeasureTitlePlex
PlayerType=Album

[MeasureDurationPlex]
Measure=Plugin
Plugin=NowPlayingPlex
PlayerName=MeasureTitlePlex
PlayerType=Duration
Substitute="00:00":""

[MeasurePositionPlex]
Measure=Plugin
Plugin=NowPlayingPlex
PlayerName=MeasureTitlePlex
PlayerType=Position
Substitute="00:00":""
```

# License

MIT