2
0

getVolume.lua 544 B

123456789101112131415161718192021222324
  1. return {
  2. tag = 'listener',
  3. summary = 'Get the master volume.',
  4. description = [[
  5. Returns the master volume. All audio sent to the playback device has its volume multiplied by
  6. this factor.
  7. ]],
  8. arguments = {
  9. {
  10. name = 'units',
  11. type = 'VolumeUnit',
  12. default = [['linear']],
  13. description = 'The units to return (linear or db).'
  14. }
  15. },
  16. returns = {
  17. {
  18. name = 'volume',
  19. type = 'number',
  20. description = 'The master volume.'
  21. }
  22. },
  23. notes = 'The default volume is 1.0 (0 dB).'
  24. }