Multi Theft Auto: Wiki - User contributions [en]

SetSoundPosition

2021-01-24T18:49:21Z

Dante383 d:

__NOTOC__
{{Client function}}
This function is used to change the seek position of the specified [[sound]] element.
Use a player element to control a players voice with this function.

{{Note|
*To set position of a remote audio file you have to pause it first, then set the position and then unpause it.}}

==Syntax==
<syntaxhighlight lang="lua">bool setSoundPosition ( element theSound, float pos )</syntaxhighlight>
{{OOP||[[sound]]:setPlaybackPosition|playbackPosition|getSoundPosition}}
===Required Arguments===
*'''theSound:''' the [[sound]] element which seek position you want to modify.
*'''pos:''' a [[float]] value representing the new seek position of the [[sound]] element in seconds.

===Returns===
Returns ''true'' if the [[sound]] element's seek position was successfully changed, ''false'' otherwise.

==Example==
This example allows the player to set how many milliseconds into the song he wants it to play from
<syntaxhighlight lang="lua">
theSound = playSound("music/song.mp3")
function setSongPos(cmd, tm)
tm = tonumber(tm)
local ssp = setSoundPosition(theSound,tm)
if ssp then
outputChatBox("Sound is now playing from: "..tostring(tm))
else
outputChatBox("An error has occured.")
end
end
addCommandHandler("skipsong", setSongPos)
</syntaxhighlight>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.2|Added player element for voice control}}

==See Also==
{{Client_audio_functions}}

[[hu:setSoundPosition]]
[[ar:setSoundPosition]]
[[ro:setSoundPosition]]

GetSoundMetaTags

2021-01-24T18:48:37Z

Dante383 d:

__NOTOC__
{{Client function}}
Used to get the meta tags attached to a sound. These provide information about the sound, for instance the title or the artist.

{{Note|
*This function does not work on remote WAV files
}}

==Syntax==
<syntaxhighlight lang="lua">table getSoundMetaTags ( element sound [, string format = "" ] )</syntaxhighlight>
{{OOP||[[sound]]:getMetaTags}}
===Required Arguments===
*'''sound:''' a [[sound]] element.

===Optional Arguments===
{{OptionalArg}}
*'''format:''' a filter [[string]] to get a specific meta tag.

===Returns===
Returns a [[table]], but only a [[string]] if '''format''' is given, with all data available (keys are listed below) for the sound if successful, ''false'' otherwise. If any data is unavailable then the associated key is not written to the table.

{{Sound_Meta_Tags}}

==Example==
<syntaxhighlight lang="lua">addEventHandler("onClientSoundFinishedDownload",root,function(length)
local meta = getSoundMetaTags(source)
outputChatBox("The sound: "..(meta.title).." has finished in :"..length.."ms.")
outputChatBox("The sound meta tags: Artist:"..(meta.artist).." Album:"..(meta.album).." Genre:"..(meta.genre).." Year:"..(meta.year).." Comment:"..(meta.comment).." Track:"..(meta.track).." Composer:"..(meta.composer).." Copyright:"..(meta.copyright).." SubTitle:"..(meta.subtitle).." Album Artist:"..(meta.album_artist)..".")
end)
</syntaxhighlight>

==See Also==
{{Client_audio_functions}}

[[HU:getSoundMetaTags]]
[[AR:getSoundMetaTags]]
[[RO:getSoundMetaTags]]