getChannelCount.lua 517 B

1234567891011121314151617181920212223
  1. return {
  2. summary = 'Get the number of channels in the Sound.',
  3. description = [[
  4. Returns the number of channels in the Sound. Mono sounds have 1 channel, stereo sounds have 2
  5. channels, and ambisonic sounds have 4 channels.
  6. ]],
  7. arguments = {},
  8. returns = {
  9. channels = {
  10. type = 'number',
  11. description = 'The number of channels in the sound.'
  12. }
  13. },
  14. variants = {
  15. {
  16. arguments = {},
  17. returns = { 'channels' }
  18. }
  19. },
  20. related = {
  21. 'Sound:getChannelLayout'
  22. }
  23. }