C_Sound

namespaceavailable in: camelot

Status in wowlua

6 functions: 1 implemented, 0 recorded, 5 guessed. 2 events, 0 of them fired by the emulator on its own.

Functions

function	what it does	status
`GetSoundScaledVolume`	Returns the scaled volume of a playing sound. · by wowlua `(soundHandle: number): number`	guessed
`IsPlaying`	Whether the given sound is still playing. · by wowlua `(soundHandle: number): boolean`	guessed
`PlayItemSound`	Plays a sound of the item at the given location. · by wowlua `(soundType: ItemSoundType, itemLocation: ItemLocationMixin)`	guessed
`PlaySound`	Plays a sound kit. Returns whether it played, and a handle to the sound. · by wowlua `(soundKitID: number, uiSoundSubType: UISoundSubType, forceNoDuplicates: boolean, runFinishCallback: boolean, overridePriority: number?, volumeOverride: number?): (boolean?, SoundHandle?)`	implemented
`PlaySoundWithOptions`	Plays a sound with the given options, like `PlaySound`. Returns whether it played, and a handle to the sound. · by wowlua `(params: PlaySoundParams): (boolean?, SoundHandle?)`	guessed
`PlayVocalErrorSound`	Plays the player character's voice line for the given error. · by wowlua `(vocalErrorSoundID: Vocalerrorsounds)`	guessed

"by wowlua": no one documents this function, so wowlua wrote the description from its name, signature and behaviour.

Events

event	payload	fired by the emulator
`SOUNDKIT_FINISHED`	`soundHandle: number`	not implemented
`SOUND_DEVICE_UPDATE`	`no payload`	not implemented

An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("SOUNDKIT_FINISHED").

Structures

PlaySoundParams · soundKitID, uiSoundSubType, forceNoDuplicates, runFinishCallback, overridePriority?, volumeOverride?
PlaySoundResult · success, soundHandle

sources

Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (Sound system, camelot 1.60.1). Descriptions: written by wowlua where no documentation describes the entry.