getBlob.lua 577 B

12345678910111213141516171819202122232425
  1. return {
  2. summary = 'Get the bytes backing this Sound as a Blob.',
  3. description = 'Returns a Blob containing the raw bytes of the Sound.',
  4. arguments = {},
  5. returns = {
  6. blob = {
  7. type = 'Blob',
  8. description = 'The Blob instance containing the bytes for the `Sound`.'
  9. }
  10. },
  11. variants = {
  12. {
  13. arguments = {},
  14. returns = { 'blob' }
  15. }
  16. },
  17. notes = [[
  18. Samples for each channel are stored interleaved. The data type of each sample is given by
  19. `Sound:getFormat`.
  20. ]],
  21. related = {
  22. 'Blob:getPointer',
  23. 'Image:getBlob'
  24. }
  25. }