WoW:API PlayMusic: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(→‎Notes: .ogg can be played using this API. .mp2 and .wav files should be able to be played with the API as well.)
(You can play MP3 after reload UI, checked it yesterday)
Line 15: Line 15:
==Notes==
==Notes==
*You cannot pause the playback, but you can stop it with [[API_StopMusic|StopMusic()]].
*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. You cannot use this function to play custom MP3 files that were added to an addon's directory after WoW has been launched.
*You cannot use this function to play custom MP3 files located outside an addon's directory.  
*To play MP3 files that were added to an addon's directory after WoW has been launched you will first have to reload the UI.
*If any of the built-in music is playing when you call this function (e.g. Stormwind background music), it will fade out.
*If any of the built-in music is playing when you call this function (e.g. Stormwind background music), it will fade out.
*(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).
*(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).

Revision as of 21:13, 6 July 2007

WoW API < PlayMusic

Plays the given mp3 file.

PlayMusic(soundFile);

Parameters

Arguments

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.

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

  • You cannot pause the playback, but you can stop it with StopMusic().
  • You cannot use this function to play custom MP3 files located outside an addon's directory.
  • To play MP3 files that were added to an addon's directory after WoW has been launched you will first have to reload the UI.
  • If any of the built-in music is playing when you call this function (e.g. Stormwind background music), it will fade out.
  • (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).