summaryrefslogtreecommitdiff
path: root/src/lua/stubs/volume.lua
diff options
context:
space:
mode:
Diffstat (limited to 'src/lua/stubs/volume.lua')
-rw-r--r--src/lua/stubs/volume.lua14
1 files changed, 14 insertions, 0 deletions
diff --git a/src/lua/stubs/volume.lua b/src/lua/stubs/volume.lua
new file mode 100644
index 00000000..15499630
--- /dev/null
+++ b/src/lua/stubs/volume.lua
@@ -0,0 +1,14 @@
+--- Module for interacting with playback volume. The Bluetooth and wired outputs store their current volume separately; this API only allows interacting with the volume of the currently used output device.
+-- @module volume
+
+local volume = {}
+
+--- Returns the current volume as a percentage of the current volume limit.
+-- @treturn types.Property an integer property
+function volume.current_pct() end
+
+--- Returns the current volume in terms of dB from line level.
+-- @treturn types.Property an integer property
+function volume.current_db() end
+
+return volume