quickshell-web/modules_old/Quickshell.Services.Pipewire/PwNode.json
2024-09-28 02:35:19 +03:00

108 lines
3.4 KiB
JSON

{
"name": "PwNode",
"module": "Quickshell.Services.Pipewire",
"type": "class",
"super": {
"type": "qt",
"module": "qml.QtQml",
"name": "QtObject"
},
"description": "A node in the pipewire connection graph.",
"details": "",
"flags": [
"uncreatable"
],
"properties": {
"isSink": {
"type": {
"type": "qt",
"module": "qml",
"name": "bool"
},
"details": "If `true`, then the node accepts audio input from other nodes,\nif `false` the node outputs audio to other nodes.\n",
"flags": [
"readonly"
]
},
"nickname": {
"type": {
"type": "qt",
"module": "qml",
"name": "string"
},
"details": "The node's nickname, corrosponding to the object's `node.nickname` property.\n\nMay be empty. Generally but not always more human readable than {{< qmltypelink type=\"\" module=\"\" name=\"\" mtype=\"prop\" mname=\"description\" >}}.\n",
"flags": [
"readonly"
]
},
"id": {
"type": {
"type": "qt",
"module": "qml",
"name": "int"
},
"details": "The pipewire object id of the node.\n\nMainly useful for debugging. you can inspect the node directly\nwith `pw-cli i <id>`.\n",
"flags": [
"readonly"
]
},
"isStream": {
"type": {
"type": "qt",
"module": "qml",
"name": "bool"
},
"details": "If `true` then the node is likely to be a program, if false it is liekly to be hardware.\n",
"flags": [
"readonly"
]
},
"name": {
"type": {
"type": "qt",
"module": "qml",
"name": "string"
},
"details": "The node's name, corrosponding to the object's `node.name` property.\n",
"flags": [
"readonly"
]
},
"properties": {
"type": {
"type": "unknown",
"module": "",
"name": ""
},
"details": "The property set present on the node, as an object containing key-value pairs.\nYou can inspect this directly with `pw-cli i <id>`.\n\nA few properties of note, which may or may not be present:\n- `application.name` - A suggested human readable name for the node.\n- `application.icon-name` - The name of an icon recommended to display for the node.\n- `media.name` - A description of the currently playing media.\n (more likely to be present than `media.title` and `media.artist`)\n- `media.title` - The title of the currently playing media.\n- `media.artist` - The artist of the currently playing media.\n\n{{< callout type=\"warning\" >}}\n This property is invalid unless the node is [bound](../pwobjecttracker).\n\n{{< /callout >}}",
"flags": [
"readonly"
]
},
"description": {
"type": {
"type": "qt",
"module": "qml",
"name": "string"
},
"details": "The node's description, corrosponding to the object's `node.description` property.\n\nMay be empty. Generally more human readable than {{< qmltypelink type=\"\" module=\"\" name=\"\" mtype=\"prop\" mname=\"name\" >}}.\n",
"flags": [
"readonly"
]
},
"audio": {
"type": {
"type": "local",
"module": "Quickshell.Services.Pipewire",
"name": "PwNodeAudio"
},
"details": "Extra information present only if the node sends or receives audio.\n",
"flags": [
"readonly"
]
}
},
"functions": [],
"signals": {},
"variants": {}
}