Source:setPitch

Sets the pitch of the Source.

Function

Synopsis

Source:setPitch( pitch )

Arguments

number pitch
Calculated with regard to 1 being the base pitch. Each reduction by 50 percent equals a pitch shift of -12 semitones (one octave reduction). Each doubling equals a pitch shift of 12 semitones (one octave increase). Zero is not a legal value.

Returns

Nothing.

Examples

function love.load()
    sound = love.audio.newSource("sound.wav")
 
    -- Note that this code, as-is, will set the pitch to 1.0, as per the last line, and that's how sound:play() will play it back.
    sound:setPitch(0.5) -- One octave lower
    sound:setPitch(2) -- One octave higher
    sound:setPitch(1) -- Reset to normal pitch
end

See Also


Other Languages