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

65 lines
2.2 KiB
JSON

{
"name": "PwNodeAudio",
"module": "Quickshell.Services.Pipewire",
"type": "class",
"super": {
"type": "qt",
"module": "qml.QtQml",
"name": "QtObject"
},
"description": "Audio specific properties of pipewire nodes.",
"details": "Extra properties of a TYPE99MQS_Quickshell_Services_Pipewire99NPwNode99TYPE if the node is an audio node.\n\nSee TYPE99MQS_Quickshell_Services_Pipewire99NPwNode99Vaudio99Tprop99TYPE.\n",
"flags": [
"uncreatable"
],
"properties": {
"volume": {
"type": {
"type": "qt",
"module": "qml",
"name": "real"
},
"details": "The average volume over all channels of the node.\nSetting this property modifies the volume of all channels proportionately.\n\n> [!WARNING] This property is invalid unless the node is [bound](../pwobjecttracker).\n"
},
"channels": {
"type": {
"type": "qt",
"module": "qml",
"name": "list",
"of": {
"type": "local",
"module": "Quickshell.Services.Pipewire",
"name": "PwAudioChannel"
}
},
"details": "The audio channels present on the node.\n\n> [!WARNING] This property is invalid unless the node is [bound](../pwobjecttracker).\n",
"flags": [
"readonly"
]
},
"muted": {
"type": {
"type": "qt",
"module": "qml",
"name": "bool"
},
"details": "If the node is currently muted. Setting this property changes the mute state.\n\n> [!WARNING] This property is invalid unless the node is [bound](../pwobjecttracker).\n"
},
"volumes": {
"type": {
"type": "qt",
"module": "qml",
"name": "list",
"of": {
"type": "qt",
"module": "qml",
"name": "real"
}
},
"details": "The volumes of each audio channel individually. Each entry corrosponds to\nthe volume of the channel at the same index in TYPE99Vchannels99Tprop99TYPE. TYPE99Vvolumes99Tprop99TYPE and TYPE99Vchannels99Tprop99TYPE\nwill always be the same length.\n\n> [!WARNING] This property is invalid unless the node is [bound](../pwobjecttracker).\n"
}
},
"functions": [],
"signals": {},
"variants": {}
}