WoW:API PlayMusic: Difference between revisions

← Older edit

WoW:API PlayMusic (source)

Revision as of 04:47, 15 August 2023

198 bytes added , 15 August 2023

m

Move page script moved page API PlayMusic to WoW:API PlayMusic without leaving a redirect

Anonymous user

Move page script

@@ Line 1: / Line 1: @@
-<center>'''PlayMusic''' ''-Documentation by [[user:Holo|Holo]]-''</center>
+{{wowapi}} __NOTOC__
+Plays the given mp3 file.
+ PlayMusic(soundFile);
-<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
+==Parameters==
+===Arguments===
- PlayMusic("mp3");
+:;soundFile : String - path to a MP3 file. You can refer to both files in WoW's MPQs, or your own music files in your addon's directory.
-<!-- Describe the purpose of the function, though exhausting detail can be saved for a later section -->
-Plays the given mp3.
-----
-;''Arguments''
-<!-- List each argument, together with its type -->
-:("mp3")
-:;mp3 : String - This is the complete path to an mp3. It is relative to your World of Warcraft Folder!
-----
-;''Example''
-<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->
+==Example==
   PlayMusic("Sound\\Music\\GlueScreenMusic\\wow_main_theme.mp3");
+ PlayMusic("Interface\\AddOns\\Foo\\bar.mp3");
+===Result===
+Current music fades out, login or custom music plays.
-----
+==Notes==
-;''Details''
+*You cannot pause the playback, but you can stop it with [[API_StopMusic|StopMusic()]].
+*You cannot use this function to play custom MP3 files located outside an addon's directory.
-<!-- Details not appropriate for the main description can go here -->
+*To play MP3 files that were added to an addon's directory after WoW has been launched you will first have to restart the game client.
+*If any of the built-in music is playing when you call this function (e.g. Stormwind background music), it will fade out.
-: This function plays the given music file (file format has to be mp3, I think. I have not tried others.) You cannot pause the playback. You can stop it with [[API StopMusic|StopMusic]].
+*(Verified): since World of Warcraft uses the FMOD sound engine, it is very likely that other file formats than mp3 are supported. For example OggVorbis (.ogg).
+*The playback loops until it is stopped with [[API_StopMusic|StopMusic()]].
-----
+*For some reason, during most (but not all) raid encounters the music played will suddenly stop.
-{{Template:WoW API}}