summaryrefslogtreecommitdiff
path: root/src/lua/stubs/playback.lua
diff options
context:
space:
mode:
authorjacqueline <me@jacqueline.id.au>2023-11-15 10:22:01 +1100
committerjacqueline <me@jacqueline.id.au>2023-11-15 10:22:01 +1100
commit51d1cee3d70bac68e7bc735569e92bc584267f73 (patch)
treeb78090c8c85b672e5e5ad9cb84dcf1e7f01cba46 /src/lua/stubs/playback.lua
parent0cae95a71ee88aafe0a9fffe9ee310b708029146 (diff)
downloadtangara-fw-51d1cee3d70bac68e7bc735569e92bc584267f73.tar.gz
Set up ldoc and lua-language-server, write some module stubs
Diffstat (limited to 'src/lua/stubs/playback.lua')
-rw-r--r--src/lua/stubs/playback.lua11
1 files changed, 11 insertions, 0 deletions
diff --git a/src/lua/stubs/playback.lua b/src/lua/stubs/playback.lua
new file mode 100644
index 00000000..d32febae
--- /dev/null
+++ b/src/lua/stubs/playback.lua
@@ -0,0 +1,11 @@
+--- Properties for interacting with the audio playback system
+-- @module playback
+
+local playback = {}
+
+--- Whether or not any audio is *allowed* to be played. If there is a current track, then this is essentially an indicator of whether playback is paused or unpaused.
+--- This value isn't meaningful if there is no current track.
+-- @treturn types.Property a boolean property
+function playback.playing() end
+
+return playback