GetSoundPitch

Description

Gets the sound pitch.

Syntax

GetSoundPitch(sound)

Parameters

• sound
  The sound identifier.

Return Value

• Returns pitch in floating point on success, false on error.

Example

local pitch = GetSoundPitch(soundId)
if (pitch == false) then
    -- the sound ID is not valid
else
    -- the sound ID pitch is now stored in the variable pitch for use
end

See also

• GetSoundCount
• IsValidSound
• CreateSound
• CreateSound3D
• SetSound3DLocation
• GetSound3DLocation
• DestroySound
• GetAllSounds
• SetSoundVolume
• GetSoundVolume
• SetSoundPitch
• GetSoundPitch
• SetSoundFadeIn
• SetSoundFadeOut