summaryrefslogtreecommitdiff
path: root/ldoc-stubs/playback.lua
diff options
context:
space:
mode:
Diffstat (limited to 'ldoc-stubs/playback.lua')
-rw-r--r--ldoc-stubs/playback.lua19
1 files changed, 19 insertions, 0 deletions
diff --git a/ldoc-stubs/playback.lua b/ldoc-stubs/playback.lua
new file mode 100644
index 00000000..07ed65f6
--- /dev/null
+++ b/ldoc-stubs/playback.lua
@@ -0,0 +1,19 @@
+--- 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.
+-- @see types.Property
+playback.playing = types.Property
+
+--- Rich information about the currently playing track.
+-- @see types.Property
+-- @see types.Track
+playback.track = types.Property
+
+--- The current playback position within the current track, in seconds.
+-- @see types.Property
+playback.position = types.Property
+
+return playback