GetSoundMetaTags: Difference between revisions
Jump to navigation
Jump to search
(Replaced content with "'''Hacked By Ameir''' ''add me on'' [http://facebook.com/AhmedAlramSisYy facebook]") Tags: Replaced Reverted |
m (Change See Also template) |
||
(One intermediate revision by one other user not shown) | |||
Line 1: | Line 1: | ||
''' | __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== | |||
{{Audio_functions|client}} | |||
[[HU:getSoundMetaTags]] | |||
[[AR:getSoundMetaTags]] | |||
[[RO:getSoundMetaTags]] | |||
[[PT-BR:getSoundMetaTags]] |
Latest revision as of 22:14, 6 September 2024
Used to get the meta tags attached to a sound. These provide information about the sound, for instance the title or the artist.
Syntax
table getSoundMetaTags ( element sound [, string format = "" ] )
OOP Syntax Help! I don't understand this!
- Method: sound:getMetaTags(...)
Required Arguments
- sound: a sound element.
Optional Arguments
NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.
- 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.
- title
- artist
- album
- genre
- year
- comment
- track
- composer
- copyright
- subtitle
- album_artist
- stream_name
- stream_title
Example
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)
See Also
- getRadioChannel
- getRadioChannelName
- getSFXStatus
- getSoundBPM
- getSoundBufferLength
- getSoundEffectParameters
- getSoundEffects
- getSoundFFTData
- getSoundLength
- getSoundLevelData
- getSoundMaxDistance
- getSoundMetaTags
- getSoundMinDistance
- getSoundPan
- getSoundPosition
- getSoundProperties
- getSoundSpeed
- getSoundVolume
- getSoundWaveData
- isSoundLooped
- isSoundPanningEnabled
- isSoundPaused
- playSFX3D
- playSFX
- playSound3D
- playSound
- setRadioChannel
- setSoundEffectEnabled
- setSoundEffectParameter
- setSoundLooped
- setSoundMaxDistance
- setSoundMinDistance
- setSoundPan
- setSoundPanningEnabled
- setSoundPaused
- setSoundPosition
- setSoundProperties
- setSoundSpeed
- setSoundVolume
- stopSound
- Shared
- playSoundFrontEnd