Difference between revisions of "love.audio.stop"

m
 
(5 intermediate revisions by 5 users not shown)
Line 1: Line 1:
Stops all playing audio.
+
Stops specific or all currently played [[Source|sources]].
 
== Function ==
 
== Function ==
 +
This function will stop all currently active [[Source|sources]].
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
Line 9: Line 10:
 
=== Returns ===
 
=== Returns ===
 
Nothing.
 
Nothing.
 +
 
== Function ==
 
== Function ==
 +
{{newin|[[11.0]]|110|type=variant}}
 +
Stops one or multiple [[Source]]s simultaneously.
 +
=== Synopsis ===
 +
<source lang="lua">
 +
love.audio.stop( source, ... )
 +
</source>
 +
=== Arguments ===
 +
{{param|Source|source|The first Source to stop.}}
 +
{{param|Source|...|Additional Sources to stop.}}
 +
=== Returns ===
 +
Nothing.
 +
 +
== Function ==
 +
{{newin|[[11.0]]|110|type=variant}}
 +
Stops a list of [[Source]]s simultaneously.
 +
=== Synopsis ===
 +
<source lang="lua">
 +
love.audio.stop( sources )
 +
</source>
 +
=== Arguments ===
 +
{{param|table|sources|A table containing a list of Sources to stop.}}
 +
=== Returns ===
 +
Nothing.
 +
 +
== Function ==
 +
{{oldin|[[11.0]]|110|type=variant}}
 +
This function will only stop the specified [[Source|source]].
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
Line 15: Line 44:
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|Source|source|The source on which to stop the playback}}
+
{{param|Source|source|The [[Source|source]] on which to stop the playback.}}
 
=== Returns ===
 
=== Returns ===
 
Nothing.
 
Nothing.
 +
 
== See Also ==
 
== See Also ==
 
* [[parent::love.audio]]
 
* [[parent::love.audio]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=Stops all playing audio.}}
+
{{#set:Description=Stops currently played [[Source|sources]].}}
 +
{{#set:Since=000}}
 +
 
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|love.audio.stop}}
 
{{i18n|love.audio.stop}}

Latest revision as of 20:04, 7 April 2024

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

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.

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.

See Also


Other Languages