Difference between revisions of "love.audio.stop"

m (0.11.0 -> 11.0)
(Consistency edit for this article; to match up w/ l.a.play and l.a.pause.)
Line 1: Line 1:
Stops currently played [[Source|sources]].
+
Stops specific or all currently played [[Source|sources]].
 
== Function ==
 
== Function ==
 
This function will stop all currently active [[Source|sources]].
 
This function will stop all currently active [[Source|sources]].
Line 12: Line 12:
  
 
== Function ==
 
== Function ==
 +
{{oldin|[[11.0]]|110|type=variant}}
 
This function will only stop the specified [[Source|source]].
 
This function will only stop the specified [[Source|source]].
 
=== Synopsis ===
 
=== Synopsis ===
Line 24: Line 25:
 
== Function ==
 
== Function ==
 
{{newin|[[11.0]]|110|type=variant}}
 
{{newin|[[11.0]]|110|type=variant}}
Simultaneously stops all given [[Source]]s.
+
Stops one or multiple [[Source]]s simultaneously.
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
love.audio.stop( source1, source2, ... )
+
love.audio.stop( source, ... )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|Source|source1|The first Source to stop.}}
+
{{param|Source|source|The first Source to stop.}}
{{param|Source|source2|The second Source to stop.}}
 
 
{{param|Source|...|Additional Sources to stop.}}
 
{{param|Source|...|Additional Sources to stop.}}
 
=== Returns ===
 
=== Returns ===
Line 38: Line 38:
 
== Function ==
 
== Function ==
 
{{newin|[[11.0]]|110|type=variant}}
 
{{newin|[[11.0]]|110|type=variant}}
Simultaneously stops all given [[Source]]s.
+
Stops a list of [[Source]]s simultaneously.
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">

Revision as of 15:03, 13 February 2022

Stops specific or all currently played sources.

Function

This function will stop all currently active sources.

Synopsis

love.audio.stop( )

Arguments

None.

Returns

Nothing.

Function

Removed in LÖVE 11.0
This variant is not supported in that and later versions.

This function will only stop the specified source.

Synopsis

love.audio.stop( source )

Arguments

Source source
The source on which to stop the playback.

Returns

Nothing.

Function

Available since LÖVE 11.0
This variant is not supported in earlier versions.

Stops one or multiple Sources simultaneously.

Synopsis

love.audio.stop( source, ... )

Arguments

Source source
The first Source to stop.
Source ...
Additional Sources to stop.

Returns

Nothing.

Function

Available since LÖVE 11.0
This variant is not supported in earlier versions.

Stops a list of Sources simultaneously.

Synopsis

love.audio.stop( sources )

Arguments

table sources
A table containing a list of Sources to stop.

Returns

Nothing.

See Also


Other Languages