website/docs/segments/music/ytm.mdx
Shows the currently playing song in the YouTube Music Desktop App.
You need to enable the Companion API in the YouTube Music Desktop App settings.
To do this, open the app, go to Settings > Integration and enable the following:
From the CLI, run the following command to set the authentication token:
oh-my-posh auth ytmda
If done correctly, you should now be able to add the ytm segment to your prompt.
:::warning rate limiting
The YouTube Music Desktop App has a pretty strict rate limit. Therefore it is recommended
to set the cache property in your configuration. If you don't, the segment will not be able
to display correctly.
:::
import Config from "@site/src/components/Config.js";
<Config data={{ type: "ytm", style: "powerline", powerline_symbol: "\uE0B0", foreground: "#ffffff", background: "#FF0000", options: { playing_icon: "\uf04b ", paused_icon: "\uf04c ", stopped_icon: "\uf04d ", ad_icon: "\ueebb ", http_timeout: 1000 }, cache: { duration: "5s", strategy: "session" } }} />
| Name | Type | Default | Description |
|---|---|---|---|
playing_icon | string | \uf04b | text/icon to show when playing |
paused_icon | string | \uf04c | text/icon to show when paused |
stopped_icon | string | \uf04d | text/icon to show when stopped |
ad_icon | string | \ueebb | text/icon to show when an advertisement is playing |
http_timeout | int | 5000 | in milliseconds - the timeout for http request |
:::note default template
{{ .Icon }}{{ if ne .Status \"stopped\" }}{{ .Artist }} - {{ .Track }}{{ end }}
:::
| Name | Type | Description |
|---|---|---|
.Status | string | player status (playing, paused, stopped) |
.Artist | string | current artist |
.Track | string | current track |
.Icon | string | icon (based on .Status) |