GetSoundLength: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Change See Also template)
 
(18 intermediate revisions by 14 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
{{Client function}}
Get the sound length.
This function is used to return the playback length of the specified [[sound]] element.
 
{{New feature/item|3.0132|1.3.2||
If the element is a player, this function will use the players voice.
}}
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">bool getSoundLength ( element sound )</syntaxhighlight>  
<syntaxhighlight lang="lua">float getSoundLength ( element theSound )</syntaxhighlight>  
 
{{OOP||[[sound]]:getLength|length}}
===Required Arguments===  
===Required Arguments===  
*'''sound:''' a sound element.
*'''theSound:''' the [[sound]] element which length you want to return.


===Returns===
===Returns===
Returns an ''integer'' indicating the length of the sound in mini seconds. (times by 1000 to get seconds)
Returns an [[float]] value indicating the playback length of the [[sound]] element in seconds.


==Example==  
==Example==  
TODO
Plays a sound then outputs the sound length.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--TODO
local sound = playSound("money.mp3", false) -- Play a sound
local soundLength = getSoundLength(sound) -- Get the length of the sound
outputChatBox("This sound is " .. soundLength .. " seconds long.")
</syntaxhighlight>
</syntaxhighlight>
</section>
 
==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.2|Added player element to use a players voice}}


==See Also==
==See Also==
{{audio functions}}
{{Audio_functions|client}}
 
[[hu:getSoundLength]]
[[ar:getSoundLength]]
[[ro:getSoundLength]]
[[pt-br:getSoundLength]]

Latest revision as of 22:13, 6 September 2024

This function is used to return the playback length of the specified sound element. If the element is a player, this function will use the players voice.

Syntax

float getSoundLength ( element theSound )

OOP Syntax Help! I don't understand this!

Method: sound:getLength(...)
Variable: .length


Required Arguments

  • theSound: the sound element which length you want to return.

Returns

Returns an float value indicating the playback length of the sound element in seconds.

Example

Plays a sound then outputs the sound length. 

local sound = playSound("money.mp3", false) -- Play a sound
local soundLength = getSoundLength(sound) -- Get the length of the sound
outputChatBox("This sound is " .. soundLength .. " seconds long.")

Changelog

Version Description
1.3.2 Added player element to use a players voice

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/GetSoundLength?oldid=80331"