Difference between revisions of "love.audio.stop"

m (Improved description.)
(Updated for 0.11)
Line 19: Line 19:
 
=== Arguments ===
 
=== Arguments ===
 
{{param|Source|source|The [[Source|source]] on which to stop the playback.}}
 
{{param|Source|source|The [[Source|source]] on which to stop the playback.}}
 +
=== Returns ===
 +
Nothing.
 +
 +
== Function ==
 +
{{newin|[[0.11.0]]|110|type=variant}}
 +
Simultaneously stops all given [[Source]]s.
 +
=== Synopsis ===
 +
<source lang="lua">
 +
love.audio.stop( source1, source2, ... )
 +
</source>
 +
=== Arguments ===
 +
{{param|Source|source1|The first Source to stop.}}
 +
{{param|Source|source2|The second Source to stop.}}
 +
{{param|Source|...|Additional Sources to stop.}}
 +
=== Returns ===
 +
Nothing.
 +
 +
== Function ==
 +
{{newin|[[0.11.0]]|110|type=variant}}
 +
Simultaneously stops all given [[Source]]s.
 +
=== Synopsis ===
 +
<source lang="lua">
 +
love.audio.stop( sources )
 +
</source>
 +
=== Arguments ===
 +
{{param|table|sources|A table containing a list of Sources to stop.}}
 
=== Returns ===
 
=== Returns ===
 
Nothing.
 
Nothing.

Revision as of 13:27, 25 March 2018

Stops currently played sources.

Function

This function will stop all currently active sources.

Synopsis

love.audio.stop( )

Arguments

None.

Returns

Nothing.

Function

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 0.11.0
This variant is not supported in earlier versions.

Simultaneously stops all given Sources.

Synopsis

love.audio.stop( source1, source2, ... )

Arguments

Source source1
The first Source to stop.
Source source2
The second Source to stop.
Source ...
Additional Sources to stop.

Returns

Nothing.

Function

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

Simultaneously stops all given Sources.

Synopsis

love.audio.stop( sources )

Arguments

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

Returns

Nothing.

See Also


Other Languages