Difference between revisions of "Source:seek"

m
m (Clarification for queueable Source related behaviour.)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{newin|[[0.8.0]]}}
+
{{newin|[[0.8.0]]|080|type=function}}
Sets the currently playing position of the Source.
+
Sets the currently playing position of the Source. With the queueable source type, this method can only work on the currently playing buffer.
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 7: Line 7:
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|number|offset|The new position for the Source to play from.}}
+
{{param|number|offset|The position to seek to.}}
{{param|TimeUnit|unit ("seconds")|The unit of the offset value.}}
+
{{param|TimeUnit|unit ("seconds")|The unit of the position value.}}
 
=== Returns ===
 
=== Returns ===
 
Nothing.
 
Nothing.
 
== See Also ==
 
== See Also ==
 
* [[Source:tell]]
 
* [[Source:tell]]
 +
* [[Source:getDuration]]
 
* [[parent::Source]]
 
* [[parent::Source]]
[[Category:Function]]
+
[[Category:Functions]]
 
{{#set:Description=Sets the currently playing position of the Source.}}
 
{{#set:Description=Sets the currently playing position of the Source.}}
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|Source:seek}}
 
{{i18n|Source:seek}}

Latest revision as of 13:37, 16 March 2024

Available since LÖVE 0.8.0
This function is not supported in earlier versions.

Sets the currently playing position of the Source. With the queueable source type, this method can only work on the currently playing buffer.

Function

Synopsis

Source:seek( offset, unit )

Arguments

number offset
The position to seek to.
TimeUnit unit ("seconds")
The unit of the position value.

Returns

Nothing.

See Also

Other Languages