PwNode: QtObject [uncreatable]

import Quickshell.Services.PipeWire

A node in the pipewire connection graph.

Properties

Property Details

[readonly]

audio: PwNodeAudio

Extra information present only if the node sends or receives audio.

[readonly]

description: string

The node’s description, corrosponding to the object’s node.description property.

May be empty. Generally more human readable than name.

[readonly]

id: int

The pipewire object id of the node.

Mainly useful for debugging. you can inspect the node directly with pw-cli i <id>.

[readonly]

isSink: bool

If true, then the node accepts audio input from other nodes, if false the node outputs audio to other nodes.

[readonly]

isStream: bool

If true then the node is likely to be a program, if false it is liekly to be hardware.

[readonly]

name: string

The node’s name, corrosponding to the object’s node.name property.

[readonly]

nickname: string

The node’s nickname, corrosponding to the object’s node.nickname property.

May be empty. Generally but not always more human readable than description.

[readonly]

properties: unknown

The property set present on the node, as an object containing key-value pairs. You can inspect this directly with pw-cli i <id>.

A few properties of note, which may or may not be present:

  • application.name - A suggested human readable name for the node.
  • application.icon-name - The name of an icon recommended to display for the node.
  • media.name - A description of the currently playing media. (more likely to be present than media.title and media.artist)
  • media.title - The title of the currently playing media.
  • media.artist - The artist of the currently playing media.

This property is invalid unless the node is bound.