lovr-indeck/lovr-api/audio/getVolume.lua

return {
  tag = 'listener',
  summary = 'Get the master volume.',
  description = [[
    Returns the master volume.  All audio sent to the playback device has its volume multiplied by
    this factor.
  ]],
  arguments = {
    units = {
      type = 'VolumeUnit',
      default = [['linear']],
      description = 'The units to return (linear or db).'
    }
  },
  returns = {
    volume = {
      type = 'number',
      description = 'The master volume.'
    }
  },
  variants = {
    {
      arguments = { 'units' },
      returns = { 'volume' }
    }
  },
  notes = 'The default volume is 1.0 (0 dB).'
}