Open Asterune
PitchShiftSoundEffect

PitchShiftSoundEffect

Changes audio pitch.

Creatable
Instance.new("PitchShiftSoundEffect")
Inherits
SoundEffectInstance
Replication
Standard

Behavior

PitchShiftSoundEffect changes audio pitch.

Summary

Members4
Properties3
  • Enabled: boolean = trueparallel read

    Whether this effect processes the audio signal.

  • Octave: number = 1parallel read

    The pitch multiplier expressed in octaves.

  • Priority: number = 0parallel read

    The relative priority used to order or process this object.

Methods1

Properties

Enabled

PitchShiftSoundEffect.Enabled: boolean = true

Whether this effect processes the audio signal.

Octave

PitchShiftSoundEffect.Octave: number = 1

The pitch multiplier expressed in octaves.

Priority

PitchShiftSoundEffect.Priority: number = 0

The relative priority used to order or process this object.

Methods

GetExecutionGroup

PitchShiftSoundEffect:GetExecutionGroup(): ExecutionGroup?

Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.

Inherited members

Inherited47
Instance47
Properties
ArchivableClassNameNameParent
Methods
AddComponent()AddTag()ClearAllChildren()ClearTags()Clone()Destroy()FindFirstAncestor()FindFirstAncestorOfClass()FindFirstAncestorWhichIsA()FindFirstChild()FindFirstChildOfClass()FindFirstChildWhichIsA()FindFirstDescendant()GetAttribute()GetAttributeChangedSignal()GetAttributes()GetChildren()GetComponent()GetComponentChangedSignal()GetComponents()GetDebugId()GetDescendants()GetFullName()GetPropertyChangedSignal()GetReferencing()GetTags()HasComponent()HasTag()IsA()IsAncestorOf()IsDescendantOf()RemoveComponent()RemoveTag()SetAttribute()WaitForChild()
Events
AncestryChangedAttributeChangedChangedChildAddedChildRemovedDescendantAddedDescendantRemovingDestroying

Related APIs

SoundEffect