GetSoundLength: Difference between revisions

Revision as of 16:36, 26 September 2021

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

@@ Line 1: / Line 1: @@
-'''Hacked By Ameir'''
+__NOTOC__
-''add me on''
+{{Client function}}
-[http://facebook.com/AhmedAlramSisYy facebook]
+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==
+<syntaxhighlight lang="lua">float getSoundLength ( element theSound )</syntaxhighlight>
+{{OOP||[[sound]]:getLength|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.
+<syntaxhighlight lang="lua">
+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>
+==Changelog==
+{{ChangelogHeader}}
+{{ChangelogItem|1.3.2|Added player element to use a players voice}}
+==See Also==
+{{Client_audio_functions}}
+[[hu:getSoundLength]]
+[[ar:getSoundLength]]
+[[ro:getSoundLength]]
+[[pt-br:getSoundLength]]