AudioEffectCompressor

Documentation

Overview

Package AudioEffectCompressor provides methods for working with AudioEffectCompressor object instances.

Index

• type Advanced
• type Any
• type Instance
  • func New() Instance
  • func (self Instance) AsAudioEffect() AudioEffect.Instance
  • func (self Instance) AsAudioEffectCompressor() Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsRefCounted() [1]gd.RefCounted
  • func (self Instance) AsResource() Resource.Instance
  • func (self Instance) AttackUs() Float.X
  • func (self Instance) Gain() Float.X
  • func (self Instance) Mix() Float.X
  • func (self Instance) Ratio() Float.X
  • func (self Instance) ReleaseMs() Float.X
  • func (self Instance) SetAttackUs(value Float.X)
  • func (self Instance) SetGain(value Float.X)
  • func (self Instance) SetMix(value Float.X)
  • func (self Instance) SetRatio(value Float.X)
  • func (self Instance) SetReleaseMs(value Float.X)
  • func (self Instance) SetSidechain(value string)
  • func (self Instance) SetThreshold(value Float.X)
  • func (self Instance) Sidechain() string
  • func (self Instance) Threshold() Float.X
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value

Types

type Advanced

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any

type Any interface {
	gd.IsClass
	AsAudioEffectCompressor() Instance
}

type Instance

type Instance [1]gdclass.AudioEffectCompressor

Dynamic range compressor reduces the level of the sound when the amplitude goes over a certain threshold in Decibels. One of the main uses of a compressor is to increase the dynamic range by clipping as little as possible (when sound goes over 0dB). Compressor has many uses in the mix: - In the Master bus to compress the whole output (although an [AudioEffectLimiter] is probably better). - In voice channels to ensure they sound as balanced as possible. - Sidechained. This can reduce the sound level sidechained with another audio bus for threshold detection. This technique is common in video game mixing to the level of music and SFX while voices are being heard. - Accentuates transients by using a wider attack, making effects sound more punchy.

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AsAudioEffect

func (self Instance) AsAudioEffect() AudioEffect.Instance

func (Instance) AsAudioEffectCompressor

func (self Instance) AsAudioEffectCompressor() Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsRefCounted

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (Instance) AsResource

func (self Instance) AsResource() Resource.Instance

func (Instance) AttackUs

func (self Instance) AttackUs() Float.X

func (Instance) Gain

func (self Instance) Gain() Float.X

func (Instance) Mix

func (self Instance) Mix() Float.X

func (Instance) Ratio

func (self Instance) Ratio() Float.X

func (Instance) ReleaseMs

func (self Instance) ReleaseMs() Float.X

func (Instance) SetAttackUs

func (self Instance) SetAttackUs(value Float.X)

func (Instance) SetGain

func (self Instance) SetGain(value Float.X)

func (Instance) SetMix

func (self Instance) SetMix(value Float.X)

func (Instance) SetRatio

func (self Instance) SetRatio(value Float.X)

func (Instance) SetReleaseMs

func (self Instance) SetReleaseMs(value Float.X)

func (Instance) SetSidechain

func (self Instance) SetSidechain(value string)

func (Instance) SetThreshold

func (self Instance) SetThreshold(value Float.X)

func (Instance) Sidechain

func (self Instance) Sidechain() string

func (Instance) Threshold

func (self Instance) Threshold() Float.X

func (*Instance) UnsafePointer

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value