Files
tangara-fw/luals-stubs/volume.lua
T
jacqueline 36a19182be Use luals-stubs as the source of truth for docs, instead of maintaining
separate docs stubs

Includes introducing a cool new script to turn lua-language-server's
json output into markdown documentation.
2024-03-07 17:22:06 +11:00

12 lines
774 B
Lua

--- @meta
--- 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.
--- @class volume
--- @field current_pct Property The current volume as a percentage of the current volume limit.
--- @field current_db Property The current volume in terms of decibels relative to line level (only applicable to headphone output)
--- @field left_bias Property An additional modifier in decibels to apply to the left channel (only applicable to headphone output)
--- @field limit_db Property The maximum allowed output volume, in terms of decibels relative to line level (only applicable to headphone output)
local volume = {}
return volume