GetSoundMetaTags: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 4: Line 4:


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


===Returns===
===Returns===
Returns a [[table]] with all data available (keys are listed below) for the sound if successful, ''false'' otherwise.
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.


{{Sound_Meta_Tags}}
{{Sound_Meta_Tags}}

Revision as of 04:26, 28 September 2018

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

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.

  • 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

Retrieved from "https://wiki.multitheftauto.com/wiki/GetSoundMetaTags?oldid=59538"