mirror of
https://github.com/JanDeDobbeleer/oh-my-posh.git
synced 2024-11-16 16:04:05 -08:00
69 lines
2.3 KiB
Plaintext
69 lines
2.3 KiB
Plaintext
---
|
|
id: spotify
|
|
title: Spotify
|
|
sidebar_label: Spotify
|
|
---
|
|
|
|
## What
|
|
|
|
Show the currently playing song in the [Spotify][spotify] macOS/Windows clients.
|
|
|
|
:::caution
|
|
Be aware this can make the prompt a tad bit slower as it needs to get a response from the Spotify player.
|
|
|
|
On _macOS_, all states are supported (playing/paused/stopped).
|
|
|
|
On _Windows/WSL_, **only the playing state is supported** (no information when paused/stopped). It supports
|
|
fetching information from the native Spotify application and Edge PWA.
|
|
:::
|
|
|
|
## Sample Configuration
|
|
|
|
import Config from "@site/src/components/Config.js";
|
|
|
|
<Config
|
|
data={{
|
|
type: "spotify",
|
|
style: "powerline",
|
|
powerline_symbol: "\uE0B0",
|
|
foreground: "#ffffff",
|
|
background: "#1BD760",
|
|
properties: {
|
|
playing_icon: "\uE602 ",
|
|
paused_icon: "\uF8E3 ",
|
|
stopped_icon: "\uF04D ",
|
|
},
|
|
}}
|
|
/>
|
|
|
|
## Properties
|
|
|
|
| Name | Type | Default | Description |
|
|
| --------------- | :------: | :-------: | ---------------------------------------------------------------------------- |
|
|
| `playing_icon` | `string` | `\uE602 ` | text/icon to show when playing |
|
|
| `paused_icon` | `string` | `\uF8E3 ` | text/icon to show when paused |
|
|
| `stopped_icon` | `string` | `\uF04D` | text/icon to show when stopped |
|
|
| `cache_timeout` | `int` | `0` | **macOS only** in minutes - How long to wait before fetching new information |
|
|
|
|
## Template ([info][templates])
|
|
|
|
:::note default template
|
|
|
|
```template
|
|
{{ .Icon }}{{ if ne .Status \"stopped\" }}{{ .Artist }} - {{ .Track }}{{ end }}
|
|
```
|
|
|
|
:::
|
|
|
|
### Properties
|
|
|
|
| Name | Type | Description |
|
|
| --------- | -------- | ---------------------------------------------- |
|
|
| `.Status` | `string` | player status (`playing`, `paused`, `stopped`) |
|
|
| `.Artist` | `string` | current artist |
|
|
| `.Track` | `string` | current track |
|
|
| `.Icon` | `string` | icon (based on `.Status`) |
|
|
|
|
[templates]: /docs/configuration/templates
|
|
[spotify]: https://www.spotify.com
|