API PlaySound

From Wowpedia
Jump to: navigation, search

Play one of a set of built-in sounds. Other players will not hear the sound.

willPlay, soundHandle = PlaySound(soundKitID, ["channel", [forceNoDuplicates, [runFinishCallback]]])

Arguments

soundKitID 
number - All sounds used by Blizzard's UI are defined in the SOUNDKIT table.
channel 
string (optional) - The sound volume slider setting the sound should use, one of: Master, SFX, Music, Ambience, Dialog. Individual channels (except "Master") have user-configurable volume settings and may be muted, preventing playback. Defaults to SFX (Sound) if not specified.
forceNoDuplicate 
boolean (optional) - Allow duplicate sounds if false. Defaults to true.
runFinishCallback 
boolean (optional) - Fires SOUNDKIT_FINISHED when sound is done, arg1 will be soundHandle given below. Defaults to false.
Sound channels

Returns

willPlay 
boolean - true if the sound will be played, nil otherwise (prevented by a muted sound channel, for instance).
soundHandle 
number - identifier for the queued playback.

Example

Plays the ready check sound file (sound/interface/levelup2.ogg)

PlaySound(SOUNDKIT.READY_CHECK) -- by SOUNDKIT key
PlaySound(8960) -- by SoundKitID
PlaySoundFile(567478) -- by FileDataID

Finding Sound IDs

File Data IDs

Sound Kit Names/IDs

Patch history

  • Legion Patch 7.3.0 (2017-08-29): Changed. String-based input is not allowed. SoundKitID should be given while calling PlaySound(). This change is more like a replacement for PlaySoundKitID.
  • Mists of Pandaria Patch 5.0.4 (2012-08-28): Added willPlay and soundHandle return values.
  • WoW Icon update.png Patch 1.1.0 (2004-11-07): Added.

See also