---
name: "yambar-modules-pulse"
section: "5"
platform: "linux"
package: "yambar"
version: "1.11.0-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/yambar-modules-pulse"
---

# yambar-modules-pulse(5)

Monitors a PulseAudio source and/or sink

## NAME

pulse - Monitors a PulseAudio source and/or sink

## TAGS

| | | |
| --- | --- | --- |
| **Name** | **Type** | **Description** |
| online | bool | True when connected to the PulseAudio server |
| sink\_online | bool | True when the sink is present |
| source\_online | bool | True when the source is present |
| sink\_percent | range | Sink volume level, as a percentage |
| source\_percent | range | Source volume level, as a percentage |
| sink\_muted | bool | True if the sink is muted, otherwise false |
| source\_muted | bool | True if the source is muted, otherwise false |
| sink\_port | string | Description of the active sink port |
| source\_port | string | Description of the active source port |

## CONFIGURATION

| | | | |
| --- | --- | --- | --- |
| **Name** | **Type** | **Req** | **Description** |
| sink | string | no | Name of sink to monitor (default: *@DEFAULT\_SINK@*). |
| source | string | no | Name of source to monitor (default: *@DEFAULT\_SOURCE@*). |

## EXAMPLES

```
bar:
  left:
    - pulse:
	    content:
		  string: {text: "{sink_percent}% ({sink_port})"}
```

## SEE ALSO

[**yambar-modules**(5)](/yambar-modules/5.md), [**yambar-particles**(5)](/yambar-particles/5.md), [**yambar-tags**(5)](/yambar-tags/5.md), [**yambar-decorations**(5)](/yambar-decorations/5.md)