AudioEffectPitchShift — C# API

Adds a pitch-shifting audio effect to an audio bus. Raises or lowers the pitch of the input audio.

class AudioEffectPitchShiftReckfellSharpInherits AudioEffect

Adds a pitch-shifting audio effect to an audio bus. Raises or lowers the pitch of the input audio.

Allows modulation of pitch without modifying speed. All frequencies can be raised or lowered with minimal effect on transients.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

AudioEffectPitchShiftConstructor

# AudioEffectPitchShift

C#
public AudioEffectPitchShift();

Properties3

FftSizeProperty

# FftSize

C#
public AudioEffectPitchShift.FftSizeEnum FftSize { get; set; }

The size of the Fast Fourier transform buffer. Higher values smooth out the effect over time, but have greater latency. The effects of this higher latency are especially noticeable on audio signals that have sudden amplitude changes.

OversamplingProperty

# Oversampling

C#
public int Oversampling { get; set; }

The oversampling factor to use. Higher values result in better quality, but are more demanding on the CPU and may cause audio cracking if the CPU can't keep up.

PitchScaleProperty

# PitchScale

C#
public float PitchScale { get; set; }

The pitch scale to use. 1.0 is the default pitch and plays sounds unaffected. AudioEffectPitchShift.PitchScale can range from 0 (infinitely low pitch, inaudible) to 16 (16 times higher than the initial pitch).

Methods6

GetFftSizeAudioEffectPitchShift.FftSizeEnum

# GetFftSize

C#
public AudioEffectPitchShift.FftSizeEnum GetFftSize();

Returns AudioEffectPitchShift.FftSizeEnum

GetOversamplingint

# GetOversampling

C#
public int GetOversampling();

Returns int

GetPitchScalefloat

# GetPitchScale

C#
public float GetPitchScale();

Returns float

SetFftSizevoid

# SetFftSize

C#
public void SetFftSize(AudioEffectPitchShift.FftSizeEnum size);

Parameters
Name	Type	Default
`size`	`AudioEffectPitchShift.FftSizeEnum`	—

SetOversamplingvoid

# SetOversampling

C#
public void SetOversampling(int amount);

Parameters
Name	Type	Default
`amount`	`int`	—

SetPitchScalevoid

# SetPitchScale

C#
public void SetPitchScale(float rate);

Parameters
Name	Type	Default
`rate`	`float`	—

AudioEffectPitchShift.FftSizeEnum

Value	Description
`Max = 5`	Represents the size of the `AudioEffectPitchShift.FftSizeEnum` enum.
`Size1024 = 2`	Use a buffer of 1024 samples for the Fast Fourier transform. This is a compromise between latency and stability over time.
`Size2048 = 3`	Use a buffer of 2048 samples for the Fast Fourier transform. High latency, but stable over time.
`Size256 = 0`	Use a buffer of 256 samples for the Fast Fourier transform. Lowest latency, but least stable over time.
`Size4096 = 4`	Use a buffer of 4096 samples for the Fast Fourier transform. Highest latency, but most stable over time.
`Size512 = 1`	Use a buffer of 512 samples for the Fast Fourier transform. Low latency, but less stable over time.