seek.lua 501 B

12345678910111213141516171819
  1. return {
  2. summary = 'Set the playback position of the Source.',
  3. description = 'Seeks the Source to the specified position.',
  4. arguments = {
  5. {
  6. name = 'position',
  7. type = 'number',
  8. description = 'The position to seek to.'
  9. },
  10. {
  11. name = 'unit',
  12. type = 'TimeUnit',
  13. default = [['seconds']],
  14. description = 'The units for the seek position.'
  15. }
  16. },
  17. returns = {},
  18. notes = 'Seeking a Source backed by a stream `Sound` has no meaningful effect.'
  19. }