WoW:API PlaySoundFile

From AddOn Studio
Revision as of 08:46, 21 June 2006 by WoWWiki>Yeg0
Jump to navigation Jump to search
PlaySoundFile -Documentation by coder_1024 taken from Dhargo's post on the official forums-


PlaySoundFile(SoundFile);


Play the specified sound file. The file will be played once.


Arguments


(SoundFile)
SoundFile
String - The path and name of the sound file you'd like to play. This has been successfully tested with .wav and .mp3 files. Note that the path is relative to the World of Warcraft installation directory. As of patch 1.11, custom sound files are not playing properly.

Example: Playing a sound file from within an AddOn's directory


PlaySoundFile("Interface\\AddOns\\MyAddOn\\mysound.wav");

or

PlaySoundFile("Interface\\AddOns\\MyAddOn\\mysound.mp3");

Details


This has been successfully tested for playing sounds inside your AddOn's directory, so you don't have to worry about putting your sound files outside your AddOn directory.

However - it does appear that the sound file must be present in the AddOn directory BEFORE loading the game. A /console reloadui will not refresh the sound files.

There does not appear to be a bad error if the file is missing - it just won't play. There is a return status, which is 1 if the sound was OK and nil if it couldn't be found.


Template:WoW API