seek.lua 592 B

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