Table of Contents

Class PitchAudioEffect

Namespace
VisioForge.Core.Types.X.AudioEffects
Assembly
VisioForge.Core.dll

Pitch audio effect changes the pitch of audio without affecting playback speed. Uses the GStreamer 'pitch' element from the soundtouch library. Supports pitch shifting, tempo adjustment, and rate control independently.

public class PitchAudioEffect : BaseAudioEffect, ISharedAudioEffectX, IVideoEditXAudioEffect

Inheritance

Implements

Inherited Members

Remarks

GStreamer element: pitch (from soundtouch plugin) Properties:

  • pitch: Pitch multiplier (0.5 = one octave down, 1.0 = no change, 2.0 = one octave up)
  • tempo: Tempo multiplier (1.0 = no change)
  • rate: Rate multiplier (1.0 = no change)

Constructors

PitchAudioEffect()

Initializes a new instance of the VisioForge.Core.Types.X.AudioEffects.PitchAudioEffect class.

public PitchAudioEffect()

Properties

Pitch

Gets or sets the pitch multiplier. 1.0 = no change, 2.0 = one octave up, 0.5 = one octave down.

public float Pitch { get; set; }

Property Value

float

PitchSemitones

Gets or sets the pitch shift in semitones. Range: -12 to +12 (one octave down to one octave up). 0 = no change, +1 = one semitone up, -1 = one semitone down. This is a convenience property that converts to/from the Pitch multiplier. Values outside the -12 to +12 range will be clamped.

public double PitchSemitones { get; set; }

Property Value

double

Rate

Gets or sets the rate multiplier. 1.0 = no change.

public float Rate { get; set; }

Property Value

float

Tempo

Gets or sets the tempo multiplier. 1.0 = no change, 2.0 = double speed, 0.5 = half speed.

public float Tempo { get; set; }

Property Value

float

Methods

GenerateDescription()

Generates the GStreamer launch string description.

public string GenerateDescription()

Returns

string

A string representation of the audio effect parameters.