getSampleCount.lua 549 B

1234567891011121314151617181920212223
  1. return {
  2. summary = 'Get the number of samples in the Sound.',
  3. description = 'Returns the total number of samples in the Sound.',
  4. arguments = {},
  5. returns = {
  6. samples = {
  7. type = 'number',
  8. description = 'The total number of samples in the Sound.'
  9. }
  10. },
  11. variants = {
  12. {
  13. arguments = {},
  14. returns = { 'samples' }
  15. }
  16. },
  17. notes = 'For streams, this returns the number of samples in the stream\'s buffer.',
  18. related = {
  19. 'Sound:getDuration',
  20. 'Sound:getFrameCount',
  21. 'Sound:getChannelCount'
  22. }
  23. }