Difference between revisions of "love.audio.pause"

m (0.11.0 -> 11.0)
 
(6 intermediate revisions by 4 users not shown)
Line 1: Line 1:
Pauses all audio.
+
Pauses specific or all currently played [[Source|Sources]].
 +
 
 
== Function ==
 
== Function ==
 +
{{newin|[[11.0]]|110|type=variant}}
 +
Pauses all currently active [[Source]]s and returns them.
 +
=== Synopsis ===
 +
<source lang="lua">
 +
sources = love.audio.pause( )
 +
</source>
 +
=== Arguments ===
 +
None.
 +
=== Returns ===
 +
{{param|table|Sources|A table containing a list of Sources that were paused by this call.}}
 +
 +
== Function ==
 +
{{newin|[[11.0]]|110|type=variant}}
 +
Pauses the given [[Source]]s.
 +
=== Synopsis ===
 +
<source lang="lua">
 +
love.audio.pause( source, ... )
 +
</source>
 +
=== Arguments ===
 +
{{param|Source|source|The first Source to pause.}}
 +
{{param|Source|...|Additional Sources to pause.}}
 +
=== Returns ===
 +
Nothing.
 +
 +
== Function ==
 +
{{newin|[[11.0]]|110|type=variant}}
 +
Pauses the given [[Source]]s.
 +
=== Synopsis ===
 +
<source lang="lua">
 +
love.audio.pause( sources )
 +
</source>
 +
=== Arguments ===
 +
{{param|table|sources|A table containing a list of Sources to pause.}}
 +
=== Returns ===
 +
Nothing.
 +
 +
 +
== Function ==
 +
{{oldin|[[11.0]]|110|type=variant}}
 +
Pauses all currently active [[Source]]s.
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
Line 9: Line 50:
 
=== Returns ===
 
=== Returns ===
 
Nothing.
 
Nothing.
 +
 
== Function ==
 
== Function ==
 +
{{oldin|[[11.0]]|110|type=variant}}
 +
Pauses a specific [[Source]].
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
Line 15: Line 59:
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|Source|source|The source on which to pause the playback}}
+
{{param|Source|source|The source on which to pause the playback.}}
 
=== Returns ===
 
=== Returns ===
 
Nothing.
 
Nothing.
 +
 
== See Also ==
 
== See Also ==
 
* [[parent::love.audio]]
 
* [[parent::love.audio]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=Pauses all audio.}}
+
{{#set:Description=Pauses specific or all currently played [[Source|Sources]].}}
 +
{{#set:Since=000}}
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|love.audio.pause}}
 
{{i18n|love.audio.pause}}

Latest revision as of 14:13, 22 December 2018

Pauses specific or all currently played Sources.

Function

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

Pauses all currently active Sources and returns them.

Synopsis

sources = love.audio.pause( )

Arguments

None.

Returns

table Sources
A table containing a list of Sources that were paused by this call.

Function

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

Pauses the given Sources.

Synopsis

love.audio.pause( source, ... )

Arguments

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

Returns

Nothing.

Function

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

Pauses the given Sources.

Synopsis

love.audio.pause( sources )

Arguments

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

Returns

Nothing.


Function

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

Pauses all currently active Sources.

Synopsis

love.audio.pause( )

Arguments

None.

Returns

Nothing.

Function

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

Pauses a specific Source.

Synopsis

love.audio.pause( source )

Arguments

Source source
The source on which to pause the playback.

Returns

Nothing.

See Also


Other Languages