The Open Toolkit library  1.1
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Classes | Enumerations
Package OpenTK.Audio.OpenAL

Classes

class  EffectsExtension
 Provides access to the OpenAL effects extension. More...
 
class  XRamExtension
 The X-Ram Extension is provided on the top-end Sound Blaster X-Fi solutions (Sound Blaster X-Fi Fatal1ty, Sound Blaster X-Fi Elite Pro, or later). These products feature 64MB of X-Ram that can only be used for audio purposes, which can be controlled by this Extension. /summary> More...
 

Enumerations

enum  ALCapability : int { ALCapability.Invalid = -1 }
 A list of valid Enable/Disable/IsEnabled parameters More...
 
enum  ALListenerf : int { ALListenerf.Gain = 0x100A, EfxMetersPerUnit = 0x20004 }
 A list of valid 32-bit Float Listener/GetListener parameters More...
 
enum  ALListener3f : int { ALListener3f.Position = 0x1004, Velocity = 0x1006 }
 A list of valid Math.Vector3 Listener/GetListener parameters More...
 
enum  ALListenerfv : int { ALListenerfv.Orientation = 0x100F }
 A list of valid float[] Listener/GetListener parameters More...
 
enum  ALSourcef : int {
  ALSourcef.ReferenceDistance = 0x1020, ALSourcef.MaxDistance = 0x1023, ALSourcef.RolloffFactor = 0x1021, ALSourcef.Pitch = 0x1003,
  ALSourcef.Gain = 0x100A, ALSourcef.MinGain = 0x100D, ALSourcef.MaxGain = 0x100E, ALSourcef.ConeInnerAngle = 0x1001,
  ALSourcef.ConeOuterAngle = 0x1002, ConeOuterGain = 0x1022, ALSourcef.SecOffset = 0x1024, ALSourcef.EfxAirAbsorptionFactor = 0x20007,
  ALSourcef.EfxRoomRolloffFactor = 0x20008, EfxConeOuterGainHighFrequency = 0x20009
}
 A list of valid 32-bit Float Source/GetSource parameters More...
 
enum  ALSource3f : int { ALSource3f.Position = 0x1004, ALSource3f.Velocity = 0x1006, Direction = 0x1005 }
 A list of valid Math.Vector3 Source/GetSource parameters More...
 
enum  ALSourceb : int {
  ALSourceb.SourceRelative = 0x202, ALSourceb.Looping = 0x1007, ALSourceb.EfxDirectFilterGainHighFrequencyAuto = 0x2000A, ALSourceb.EfxAuxiliarySendFilterGainAuto = 0x2000B,
  EfxAuxiliarySendFilterGainHighFrequencyAuto = 0x2000C
}
 A list of valid 8-bit boolean Source/GetSource parameters More...
 
enum  ALSourcei : int {
  ALSourcei.ByteOffset = 0x1026, ALSourcei.SampleOffset = 0x1025, ALSourcei.Buffer = 0x1009, ALSourcei.SourceType = 0x1027,
  EfxDirectFilter = 0x20005
}
 A list of valid Int32 Source parameters More...
 
enum  ALSource3i : int { ALSource3i.EfxAuxiliarySendFilter = 0x20006 }
 A list of valid 3x Int32 Source/GetSource parameters More...
 
enum  ALGetSourcei : int {
  ALGetSourcei.ByteOffset = 0x1026, ALGetSourcei.SampleOffset = 0x1025, Buffer = 0x1009, ALGetSourcei.SourceState = 0x1010,
  ALGetSourcei.BuffersQueued = 0x1015, ALGetSourcei.BuffersProcessed = 0x1016, SourceType = 0x1027
}
 A list of valid Int32 GetSource parameters More...
 
enum  ALSourceState : int { ALSourceState.Initial = 0x1011, ALSourceState.Playing = 0x1012, ALSourceState.Paused = 0x1013, Stopped = 0x1014 }
 Source state information, can be retrieved by AL.Source() with ALSourcei.SourceState. More...
 
enum  ALSourceType : int { ALSourceType.Static = 0x1028, ALSourceType.Streaming = 0x1029, Undetermined = 0x1030 }
 Source type information, can be retrieved by AL.Source() with ALSourcei.SourceType. More...
 
enum  ALFormat : int {
  ALFormat.Mono8 = 0x1100, ALFormat.Mono16 = 0x1101, ALFormat.Stereo8 = 0x1102, Stereo16 = 0x1103,
  ALFormat.MonoALawExt = 0x10016, ALFormat.StereoALawExt = 0x10017, ALFormat.MonoMuLawExt = 0x10014, ALFormat.StereoMuLawExt = 0x10015,
  ALFormat.VorbisExt = 0x10003, ALFormat.Mp3Ext = 0x10020, ALFormat.MonoIma4Ext = 0x1300, ALFormat.StereoIma4Ext = 0x1301,
  ALFormat.MonoFloat32Ext = 0x10010, ALFormat.StereoFloat32Ext = 0x10011, ALFormat.MonoDoubleExt = 0x10012, ALFormat.StereoDoubleExt = 0x10013,
  ALFormat.Multi51Chn16Ext = 0x120B, ALFormat.Multi51Chn32Ext = 0x120C, ALFormat.Multi51Chn8Ext = 0x120A, ALFormat.Multi61Chn16Ext = 0x120E,
  ALFormat.Multi61Chn32Ext = 0x120F, ALFormat.Multi61Chn8Ext = 0x120D, ALFormat.Multi71Chn16Ext = 0x1211, ALFormat.Multi71Chn32Ext = 0x1212,
  ALFormat.Multi71Chn8Ext = 0x1210, ALFormat.MultiQuad16Ext = 0x1205, ALFormat.MultiQuad32Ext = 0x1206, ALFormat.MultiQuad8Ext = 0x1204,
  ALFormat.MultiRear16Ext = 0x1208, ALFormat.MultiRear32Ext = 0x1209, ALFormat.MultiRear8Ext = 0x1207
}
 Sound samples: Format specifier. More...
 
enum  ALGetBufferi : int { ALGetBufferi.Frequency = 0x2001, ALGetBufferi.Bits = 0x2002, ALGetBufferi.Channels = 0x2003, ALGetBufferi.Size = 0x2004 }
 A list of valid Int32 GetBuffer parameters More...
 
enum  ALBufferState : int { ALBufferState.Unused = 0x2010, ALBufferState.Pending = 0x2011, Processed = 0x2012 }
 Buffer state. Not supported for public use (yet). More...
 
enum  ALError : int {
  ALError.NoError = 0, ALError.InvalidName = 0xA001, ALError.IllegalEnum = 0xA002, ALError.InvalidEnum = 0xA002,
  ALError.InvalidValue = 0xA003, ALError.IllegalCommand = 0xA004, ALError.InvalidOperation = 0xA004, OutOfMemory = 0xA005
}
 Returned by AL.GetError More...
 
enum  ALGetString : int { ALGetString.Vendor = 0xB001, ALGetString.Version = 0xB002, ALGetString.Renderer = 0xB003, ALGetString.Extensions = 0xB004 }
 A list of valid string AL.Get() parameters More...
 
enum  ALGetFloat : int { ALGetFloat.DopplerFactor = 0xC000, ALGetFloat.DopplerVelocity = 0xC001, SpeedOfSound = 0xC003 }
 A list of valid 32-bit Float AL.Get() parameters More...
 
enum  ALGetInteger : int { ALGetInteger.DistanceModel = 0xD000 }
 A list of valid Int32 AL.Get() parameters More...
 
enum  ALDistanceModel : int {
  ALDistanceModel.None = 0, ALDistanceModel.InverseDistance = 0xD001, ALDistanceModel.InverseDistanceClamped = 0xD002, ALDistanceModel.LinearDistance = 0xD003,
  ALDistanceModel.LinearDistanceClamped = 0xD004, ALDistanceModel.ExponentDistance = 0xD005, ExponentDistanceClamped = 0xD006
}
 Used by AL.DistanceModel(), the distance model can be retrieved by AL.Get() with ALGetInteger.DistanceModel More...
 
enum  EfxEffectf : int {
  EfxEffectf.ReverbDensity = 0x0001, EfxEffectf.ReverbDiffusion = 0x0002, EfxEffectf.ReverbGain = 0x0003, EfxEffectf.ReverbGainHF = 0x0004,
  EfxEffectf.ReverbDecayTime = 0x0005, EfxEffectf.ReverbDecayHFRatio = 0x0006, EfxEffectf.ReverbReflectionsGain = 0x0007, EfxEffectf.ReverbReflectionsDelay = 0x0008,
  EfxEffectf.ReverbLateReverbGain = 0x0009, EfxEffectf.ReverbLateReverbDelay = 0x000A, EfxEffectf.ReverbAirAbsorptionGainHF = 0x000B, EfxEffectf.ReverbRoomRolloffFactor = 0x000C,
  EfxEffectf.ChorusRate = 0x0003, EfxEffectf.ChorusDepth = 0x0004, EfxEffectf.ChorusFeedback = 0x0005, EfxEffectf.ChorusDelay = 0x0006,
  EfxEffectf.DistortionEdge = 0x0001, EfxEffectf.DistortionGain = 0x0002, EfxEffectf.DistortionLowpassCutoff = 0x0003, EfxEffectf.DistortionEQCenter = 0x0004,
  EfxEffectf.DistortionEQBandwidth = 0x0005, EfxEffectf.EchoDelay = 0x0001, EfxEffectf.EchoLRDelay = 0x0002, EfxEffectf.EchoDamping = 0x0003,
  EfxEffectf.EchoFeedback = 0x0004, EfxEffectf.EchoSpread = 0x0005, EfxEffectf.FlangerRate = 0x0003, EfxEffectf.FlangerDepth = 0x0004,
  EfxEffectf.FlangerFeedback = 0x0005, EfxEffectf.FlangerDelay = 0x0006, EfxEffectf.FrequencyShifterFrequency = 0x0001, EfxEffectf.VocalMorpherRate = 0x0006,
  EfxEffectf.RingModulatorFrequency = 0x0001, EfxEffectf.RingModulatorHighpassCutoff = 0x0002, EfxEffectf.AutowahAttackTime = 0x0001, EfxEffectf.AutowahReleaseTime = 0x0002,
  EfxEffectf.AutowahResonance = 0x0003, EfxEffectf.AutowahPeakGain = 0x0004, EfxEffectf.EqualizerLowGain = 0x0001, EfxEffectf.EqualizerLowCutoff = 0x0002,
  EfxEffectf.EqualizerMid1Gain = 0x0003, EfxEffectf.EqualizerMid1Center = 0x0004, EfxEffectf.EqualizerMid1Width = 0x0005, EfxEffectf.EqualizerMid2Gain = 0x0006,
  EfxEffectf.EqualizerMid2Center = 0x0007, EfxEffectf.EqualizerMid2Width = 0x0008, EfxEffectf.EqualizerHighGain = 0x0009, EfxEffectf.EqualizerHighCutoff = 0x000A,
  EfxEffectf.EaxReverbDensity = 0x0001, EfxEffectf.EaxReverbDiffusion = 0x0002, EfxEffectf.EaxReverbGain = 0x0003, EfxEffectf.EaxReverbGainHF = 0x0004,
  EfxEffectf.EaxReverbGainLF = 0x0005, EfxEffectf.EaxReverbDecayTime = 0x0006, EfxEffectf.EaxReverbDecayHFRatio = 0x0007, EfxEffectf.EaxReverbDecayLFRatio = 0x0008,
  EfxEffectf.EaxReverbReflectionsGain = 0x0009, EfxEffectf.EaxReverbReflectionsDelay = 0x000A, EfxEffectf.EaxReverbLateReverbGain = 0x000C, EfxEffectf.EaxReverbLateReverbDelay = 0x000D,
  EfxEffectf.EaxReverbEchoTime = 0x000F, EfxEffectf.EaxReverbEchoDepth = 0x0010, EfxEffectf.EaxReverbModulationTime = 0x0011, EfxEffectf.EaxReverbModulationDepth = 0x0012,
  EfxEffectf.EaxReverbAirAbsorptionGainHF = 0x0013, EfxEffectf.EaxReverbHFReference = 0x0014, EfxEffectf.EaxReverbLFReference = 0x0015, EaxReverbRoomRolloffFactor = 0x0016
}
 A list of valid 32-bit Float Effect/GetEffect parameters More...
 
enum  EfxEffect3f : int { EfxEffect3f.EaxReverbLateReverbPan = 0x000E, EfxEffect3f.EaxReverbReflectionsPan = 0x000B }
 A list of valid Math.Vector3 Effect/GetEffect parameters More...
 
enum  EfxEffecti : int {
  EfxEffecti.ChorusWaveform = 0x0001, EfxEffecti.ChorusPhase = 0x0002, EfxEffecti.FlangerWaveform = 0x0001, EfxEffecti.FlangerPhase = 0x0002,
  EfxEffecti.FrequencyShifterLeftDirection = 0x0002, EfxEffecti.FrequencyShifterRightDirection = 0x0003, EfxEffecti.VocalMorpherPhonemeA = 0x0001, EfxEffecti.VocalMorpherPhonemeACoarseTuning = 0x0002,
  EfxEffecti.VocalMorpherPhonemeB = 0x0003, EfxEffecti.VocalMorpherPhonemeBCoarseTuning = 0x0004, EfxEffecti.VocalMorpherWaveform = 0x0005, EfxEffecti.PitchShifterCoarseTune = 0x0001,
  EfxEffecti.PitchShifterFineTune = 0x0002, EfxEffecti.RingModulatorWaveform = 0x0003, EfxEffecti.CompressorOnoff = 0x0001, EfxEffecti.ReverbDecayHFLimit = 0x000D,
  EaxReverbDecayHFLimit = 0x0017, EfxEffecti.EffectType = 0x8001
}
 A list of valid Int32 Effect/GetEffect parameters More...
 
enum  EfxFormantFilterSettings : int {
  EfxFormantFilterSettings.VocalMorpherPhonemeA = 0, EfxFormantFilterSettings.VocalMorpherPhonemeE = 1, EfxFormantFilterSettings.VocalMorpherPhonemeI = 2, EfxFormantFilterSettings.VocalMorpherPhonemeO = 3,
  EfxFormantFilterSettings.VocalMorpherPhonemeU = 4, EfxFormantFilterSettings.VocalMorpherPhonemeAA = 5, EfxFormantFilterSettings.VocalMorpherPhonemeAE = 6, EfxFormantFilterSettings.VocalMorpherPhonemeAH = 7,
  EfxFormantFilterSettings.VocalMorpherPhonemeAO = 8, EfxFormantFilterSettings.VocalMorpherPhonemeEH = 9, EfxFormantFilterSettings.VocalMorpherPhonemeER = 10, EfxFormantFilterSettings.VocalMorpherPhonemeIH = 11,
  EfxFormantFilterSettings.VocalMorpherPhonemeIY = 12, EfxFormantFilterSettings.VocalMorpherPhonemeUH = 13, EfxFormantFilterSettings.VocalMorpherPhonemeUW = 14, EfxFormantFilterSettings.VocalMorpherPhonemeB = 15,
  EfxFormantFilterSettings.VocalMorpherPhonemeD = 16, EfxFormantFilterSettings.VocalMorpherPhonemeF = 17, EfxFormantFilterSettings.VocalMorpherPhonemeG = 18, EfxFormantFilterSettings.VocalMorpherPhonemeJ = 19,
  EfxFormantFilterSettings.VocalMorpherPhonemeK = 20, EfxFormantFilterSettings.VocalMorpherPhonemeL = 21, EfxFormantFilterSettings.VocalMorpherPhonemeM = 22, EfxFormantFilterSettings.VocalMorpherPhonemeN = 23,
  EfxFormantFilterSettings.VocalMorpherPhonemeP = 24, EfxFormantFilterSettings.VocalMorpherPhonemeR = 25, EfxFormantFilterSettings.VocalMorpherPhonemeS = 26, EfxFormantFilterSettings.VocalMorpherPhonemeT = 27,
  EfxFormantFilterSettings.VocalMorpherPhonemeV = 28, EfxFormantFilterSettings.VocalMorpherPhonemeZ = 29
}
 Vocal morpher effect parameters. If both parameters are set to the same phoneme, that determines the filtering effect that will be heard. If these two parameters are set to different phonemes, the filtering effect will morph between the two settings at a rate specified by EfxEffectf.VocalMorpherRate. More...
 
enum  EfxEffectType : int {
  EfxEffectType.Null = 0x0000, EfxEffectType.Reverb = 0x0001, EfxEffectType.Chorus = 0x0002, EfxEffectType.Distortion = 0x0003,
  EfxEffectType.Echo = 0x0004, EfxEffectType.Flanger = 0x0005, EfxEffectType.FrequencyShifter = 0x0006, EfxEffectType.VocalMorpher = 0x0007,
  EfxEffectType.PitchShifter = 0x0008, EfxEffectType.RingModulator = 0x0009, EfxEffectType.Autowah = 0x000A, EfxEffectType.Compressor = 0x000B,
  EfxEffectType.Equalizer = 0x000C, EaxReverb = 0x8000
}
 Effect type definitions to be used with EfxEffecti.EffectType. More...
 
enum  EfxAuxiliaryi : int { EfxAuxiliaryi.EffectslotEffect = 0x0001, EfxAuxiliaryi.EffectslotAuxiliarySendAuto = 0x0003 }
 A list of valid Int32 AuxiliaryEffectSlot/GetAuxiliaryEffectSlot parameters More...
 
enum  EfxAuxiliaryf : int { EfxAuxiliaryf.EffectslotGain = 0x0002 }
 A list of valid 32-bits Float AuxiliaryEffectSlot/GetAuxiliaryEffectSlot parameters More...
 
enum  EfxFilterf : int {
  EfxFilterf.LowpassGain = 0x0001, EfxFilterf.LowpassGainHF = 0x0002, EfxFilterf.HighpassGain = 0x0001, EfxFilterf.HighpassGainLF = 0x0002,
  EfxFilterf.BandpassGain = 0x0001, EfxFilterf.BandpassGainLF = 0x0002, BandpassGainHF = 0x0003
}
 A list of valid 32-bits Float Filter/GetFilter parameters More...
 
enum  EfxFilteri : int { EfxFilteri.FilterType = 0x8001 }
 A list of valid Int32 Filter/GetFilter parameters More...
 
enum  EfxFilterType : int { EfxFilterType.Null = 0x0000, EfxFilterType.Lowpass = 0x0001, EfxFilterType.Highpass = 0x0002, Bandpass = 0x0003 }
 Filter type definitions to be used with EfxFilteri.FilterType. More...
 
enum  AlcContextAttributes : int {
  AlcContextAttributes.Frequency = 0x1007, AlcContextAttributes.Refresh = 0x1008, AlcContextAttributes.Sync = 0x1009, AlcContextAttributes.MonoSources = 0x1010,
  StereoSources = 0x1011, AlcContextAttributes.EfxMaxAuxiliarySends = 0x20003
}
 Defines available context attributes. More...
 
enum  AlcError : int {
  AlcError.NoError = 0, AlcError.InvalidDevice = 0xA001, AlcError.InvalidContext = 0xA002, AlcError.InvalidEnum = 0xA003,
  AlcError.InvalidValue = 0xA004, OutOfMemory = 0xA005
}
 Defines OpenAL context errors. More...
 
enum  AlcGetString : int {
  AlcGetString.DefaultDeviceSpecifier = 0x1004, AlcGetString.Extensions = 0x1006, CaptureDefaultDeviceSpecifier = 0x311, AlcGetString.DefaultAllDevicesSpecifier = 0x1012,
  AlcGetString.CaptureDeviceSpecifier = 0x310, DeviceSpecifier = 0x1005, AlcGetString.AllDevicesSpecifier = 0x1013
}
 Defines available parameters for OpenTK.Audio.OpenAL.Alc.GetString(IntPtr, AlcGetString). More...
 
enum  AlcGetStringList : int { AlcGetStringList.CaptureDeviceSpecifier = 0x310, DeviceSpecifier = 0x1005, AlcGetStringList.AllDevicesSpecifier = 0x1013 }
 Defines available parameters for Alc.GetString(IntPtr, AlcGetStringList). More...
 
enum  AlcGetInteger : int {
  AlcGetInteger.MajorVersion = 0x1000, AlcGetInteger.MinorVersion = 0x1001, AlcGetInteger.AttributesSize = 0x1002, AlcGetInteger.AllAttributes = 0x1003,
  CaptureSamples = 0x312, AlcGetInteger.EfxMajorVersion = 0x20001, AlcGetInteger.EfxMinorVersion = 0x20002, AlcGetInteger.EfxMaxAuxiliarySends = 0x20003
}
 Defines available parameters for Alc.GetInteger(IntPtr, AlcGetInteger, int, int[]). More...
 

Enumeration Type Documentation

Buffer state. Not supported for public use (yet).

Enumerator
Unused 

summary>Buffer state. Not supported for public use (yet).

summary>Buffer state. Not supported for public use (yet).

Pending 

summary>Buffer state. Not supported for public use (yet).

A list of valid Enable/Disable/IsEnabled parameters

Enumerator
Invalid 

summary>Currently no state toggles exist for vanilla OpenAL and no Extension uses it.

Defines available context attributes.

Enumerator
Frequency 

summary>Followed by System.Int32 Hz

summary>Followed by System.Int32 Hz

Refresh 

summary>Followed by AlBoolean.True, or AlBoolean.False

Sync 

summary>Followed by System.Int32 Num of requested Mono (3D) Sources

MonoSources 

summary>Followed by System.Int32 Num of requested Stereo Sources

EfxMaxAuxiliarySends 

(EFX Extension) This Context property can be passed to OpenAL during Context creation (alcCreateContext) to request a maximum number of Auxiliary Sends desired on each Source. It is not guaranteed that the desired number of sends will be available, so an application should query this property after creating the context using alcGetIntergerv. Default: 2

Defines OpenAL context errors.

Enumerator
NoError 

summary>There is no current error.

summary>No Device. The device handle or specifier names an inaccessible driver/server.

InvalidDevice 

summary>Invalid context ID. The Context argument does not name a valid context.

InvalidContext 

summary>Bad enum. A token used is not valid, or not applicable.

InvalidEnum 

summary>Bad value. A value (e.g. Attribute) is not valid, or not applicable.

InvalidValue 

summary>Out of memory. Unable to allocate memory.

Defines available parameters for Alc.GetInteger(IntPtr, AlcGetInteger, int, int[]).

Enumerator
MajorVersion 

summary>The specification revision for this implementation (major version). NULL is an acceptable device.

summary>The specification revision for this implementation (minor version). NULL is an acceptable device.

MinorVersion 

summary>The size (number of ALCint values) required for a zero-terminated attributes list, for the current context. NULL is an invalid device.

AttributesSize 

summary>Expects a destination of ALC_ATTRIBUTES_SIZE, and provides an attribute list for the current context of the specified device. NULL is an invalid device.

AllAttributes 

summary>The number of capture samples available. NULL is an invalid device.

EfxMajorVersion 

(EFX Extension) This property can be used by the application to retrieve the Major version number of the Effects Extension supported by this OpenAL implementation. As this is a Context property is should be retrieved using alcGetIntegerv.

EfxMinorVersion 

(EFX Extension) This property can be used by the application to retrieve the Minor version number of the Effects Extension supported by this OpenAL implementation. As this is a Context property is should be retrieved using alcGetIntegerv.

EfxMaxAuxiliarySends 

(EFX Extension) This Context property can be passed to OpenAL during Context creation (alcCreateContext) to request a maximum number of Auxiliary Sends desired on each Source. It is not guaranteed that the desired number of sends will be available, so an application should query this property after creating the context using alcGetIntergerv. Default: 2

Defines available parameters for OpenTK.Audio.OpenAL.Alc.GetString(IntPtr, AlcGetString).

Enumerator
DefaultDeviceSpecifier 

summary>The specifier string for the default device.

summary>A list of available context extensions separated by spaces.

Extensions 

summary>The name of the default capture device

DefaultAllDevicesSpecifier 

a list of the default devices.

CaptureDeviceSpecifier 

summary>Will only return the first Device, not a list. Use AlcGetStringList.CaptureDeviceSpecifier. ALC_EXT_CAPTURE_EXT

summary>Will only return the first Device, not a list. Use AlcGetStringList.DeviceSpecifier

AllDevicesSpecifier 

Will only return the first Device, not a list. Use AlcGetStringList.AllDevicesSpecifier

Defines available parameters for Alc.GetString(IntPtr, AlcGetStringList).

Enumerator
CaptureDeviceSpecifier 

summary>The name of the specified capture device, or a list of all available capture devices if no capture device is specified. ALC_EXT_CAPTURE_EXT

summary>The specifier strings for all available devices. ALC_ENUMERATION_EXT

AllDevicesSpecifier 

The specifier strings for all available devices. ALC_ENUMERATE_ALL_EXT

Used by AL.DistanceModel(), the distance model can be retrieved by AL.Get() with ALGetInteger.DistanceModel

Enumerator
None 

summary>Bypasses all distance attenuation calculation for all Sources.

summary>InverseDistance is equivalent to the IASIG I3DL2 model with the exception that ALSourcef.ReferenceDistance does not imply any clamping.

InverseDistance 

summary>InverseDistanceClamped is the IASIG I3DL2 model, with ALSourcef.ReferenceDistance indicating both the reference distance and the distance below which gain will be clamped.

InverseDistanceClamped 

summary>AL_EXT_LINEAR_DISTANCE extension.

LinearDistance 

summary>AL_EXT_LINEAR_DISTANCE extension.

LinearDistanceClamped 

summary>AL_EXT_EXPONENT_DISTANCE extension.

ExponentDistance 

summary>AL_EXT_EXPONENT_DISTANCE extension.

Returned by AL.GetError

Enumerator
NoError 

summary>No OpenAL Error.

summary>Invalid Name paramater passed to OpenAL call.

InvalidName 

summary>Invalid parameter passed to OpenAL call.

IllegalEnum 

summary>Invalid parameter passed to OpenAL call.

InvalidEnum 

summary>Invalid OpenAL enum parameter value.

InvalidValue 

summary>Illegal OpenAL call.

IllegalCommand 

summary>Illegal OpenAL call.

InvalidOperation 

summary>No OpenAL memory left.

Sound samples: Format specifier.

Enumerator
Mono8 

summary>1 Channel, 8 bits per sample.

summary>1 Channel, 16 bits per sample.

Mono16 

summary>2 Channels, 8 bits per sample each.

Stereo8 

summary>2 Channels, 16 bits per sample each.

MonoALawExt 

1 Channel, A-law encoded data. Requires Extension: AL_EXT_ALAW

StereoALawExt 

2 Channels, A-law encoded data. Requires Extension: AL_EXT_ALAW

MonoMuLawExt 

1 Channel, µ-law encoded data. Requires Extension: AL_EXT_MULAW

StereoMuLawExt 

2 Channels, µ-law encoded data. Requires Extension: AL_EXT_MULAW

VorbisExt 

Ogg Vorbis encoded data. Requires Extension: AL_EXT_vorbis

Mp3Ext 

MP3 encoded data. Requires Extension: AL_EXT_mp3

MonoIma4Ext 

1 Channel, IMA4 ADPCM encoded data. Requires Extension: AL_EXT_IMA4

StereoIma4Ext 

2 Channels, IMA4 ADPCM encoded data. Requires Extension: AL_EXT_IMA4

MonoFloat32Ext 

1 Channel, single-precision floating-point data. Requires Extension: AL_EXT_float32

StereoFloat32Ext 

2 Channels, single-precision floating-point data. Requires Extension: AL_EXT_float32

MonoDoubleExt 

1 Channel, double-precision floating-point data. Requires Extension: AL_EXT_double

StereoDoubleExt 

2 Channels, double-precision floating-point data. Requires Extension: AL_EXT_double

Multi51Chn16Ext 

Multichannel 5.1, 16-bit data. Requires Extension: AL_EXT_MCFORMATS

Multi51Chn32Ext 

Multichannel 5.1, 32-bit data. Requires Extension: AL_EXT_MCFORMATS

Multi51Chn8Ext 

Multichannel 5.1, 8-bit data. Requires Extension: AL_EXT_MCFORMATS

Multi61Chn16Ext 

Multichannel 6.1, 16-bit data. Requires Extension: AL_EXT_MCFORMATS

Multi61Chn32Ext 

Multichannel 6.1, 32-bit data. Requires Extension: AL_EXT_MCFORMATS

Multi61Chn8Ext 

Multichannel 6.1, 8-bit data. Requires Extension: AL_EXT_MCFORMATS

Multi71Chn16Ext 

Multichannel 7.1, 16-bit data. Requires Extension: AL_EXT_MCFORMATS

Multi71Chn32Ext 

Multichannel 7.1, 32-bit data. Requires Extension: AL_EXT_MCFORMATS

Multi71Chn8Ext 

Multichannel 7.1, 8-bit data. Requires Extension: AL_EXT_MCFORMATS

MultiQuad16Ext 

Multichannel 4.0, 16-bit data. Requires Extension: AL_EXT_MCFORMATS

MultiQuad32Ext 

Multichannel 4.0, 32-bit data. Requires Extension: AL_EXT_MCFORMATS

MultiQuad8Ext 

Multichannel 4.0, 8-bit data. Requires Extension: AL_EXT_MCFORMATS

MultiRear16Ext 

1 Channel rear speaker, 16-bit data. See Quadrophonic setups. Requires Extension: AL_EXT_MCFORMATS

MultiRear32Ext 

1 Channel rear speaker, 32-bit data. See Quadrophonic setups. Requires Extension: AL_EXT_MCFORMATS

MultiRear8Ext 

1 Channel rear speaker, 8-bit data. See Quadrophonic setups. Requires Extension: AL_EXT_MCFORMATS

A list of valid Int32 GetBuffer parameters

Enumerator
Frequency 

summary>Sound sample's frequency, in units of hertz [Hz]. This is the number of samples per second. Half of the sample frequency marks the maximum significant frequency component.

Bits 

Bit depth of the buffer. Should be 8 or 16.

Channels 

Number of channels in buffer. > 1 is valid, but buffer won’t be positioned when played. 1 for Mono, 2 for Stereo.

Size 

size of the Buffer in bytes.

A list of valid 32-bit Float AL.Get() parameters

Enumerator
DopplerFactor 

summary>Doppler scale. Default 1.0f

summary>Tweaks speed of propagation. This functionality is deprecated.

DopplerVelocity 

summary>Speed of Sound in units per second. Default: 343.3f

A list of valid Int32 AL.Get() parameters

Enumerator
DistanceModel 

summary>See enum ALDistanceModel.

ALDistanceModel

A list of valid Int32 GetSource parameters

Enumerator
ByteOffset 

summary>The playback position, expressed in bytes. AL_EXT_OFFSET Extension.

summary>The playback position, expressed in samples. AL_EXT_OFFSET Extension.

SampleOffset 

summary>Indicate the Buffer to provide sound samples. Type: uint Range: any valid Buffer Handle.

SourceState 

The state of the source (Stopped, Playing, etc.) Use the enum AlSourceState for comparison.

BuffersQueued 

The number of buffers queued on this source.

BuffersProcessed 

The number of buffers in the queue that have been processed.

summary>Source type (Static, Streaming or undetermined). Use enum AlSourceType for comparison.

A list of valid string AL.Get() parameters

Enumerator
Vendor 

Gets the Vendor name.

Version 

Gets the driver version.

Renderer 

Gets the renderer mode.

Extensions 

Gets a list of all available Extensions, separated with spaces.

A list of valid Math.Vector3 Listener/GetListener parameters

Enumerator
Position 

summary>Specify the current location in three dimensional space. OpenAL, like OpenGL, uses a right handed coordinate system, where in a frontal default view X (thumb) points right, Y points up (index finger), and Z points towards the viewer/camera (middle finger). To switch from a left handed coordinate system, flip the sign on the Z coordinate. Listener position is always in the world coordinate system.

summary>Specify the current velocity in three dimensional space.

A list of valid 32-bit Float Listener/GetListener parameters

Enumerator
Gain 

summary>Indicate the gain (Volume amplification) applied. Type: float Range: [0.0f - ? ] A value of 1.0 means un-attenuated/unchanged. Each division by 2 equals an attenuation of -6dB. Each multiplicaton with 2 equals an amplification of +6dB. A value of 0.0f is interpreted as zero volume and the channel is effectively disabled.

summary>(EFX Extension) This setting is critical if Air Absorption effects are enabled because the amount of Air Absorption applied is directly related to the real-world distance between the Source and the Listener. centimeters 0.01f meters 1.0f kilometers 1000.0f Range [float.MinValue .. float.MaxValue] Default: 1.0f

A list of valid float[] Listener/GetListener parameters

Enumerator
Orientation 

summary>Indicate Listener orientation. Expects two Vector3, At followed by Up.

A list of valid Math.Vector3 Source/GetSource parameters

Enumerator
Position 

summary>Specify the current location in three dimensional space. OpenAL, like OpenGL, uses a right handed coordinate system, where in a frontal default view X (thumb) points right, Y points up (index finger), and Z points towards the viewer/camera (middle finger). To switch from a left handed coordinate system, flip the sign on the Z coordinate. Listener position is always in the world coordinate system.

summary>Specify the current velocity in three dimensional space.

Velocity 

summary>Specify the current direction vector.

A list of valid 3x Int32 Source/GetSource parameters

Enumerator
EfxAuxiliarySendFilter 

summary>(EFX Extension) This Source property is used to establish connections between Sources and Auxiliary Effect Slots. For a Source to feed an Effect that has been loaded into an Auxiliary Effect Slot the application must configure one of the Source’s auxiliary sends. This process involves setting 3 variables – the destination Auxiliary Effect Slot ID, the Auxiliary Send number, and an optional Filter ID. Type: uint Range: any valid Filter Handle.

A list of valid 8-bit boolean Source/GetSource parameters

Enumerator
SourceRelative 

summary>Indicate that the Source has relative coordinates. Type: bool Range: [True, False]

summary>Indicate whether the Source is looping. Type: bool Range: [True, False] Default: False.

Looping 

summary>(EFX Extension) If this Source property is set to True, this Source’s direct-path is automatically filtered according to the orientation of the source relative to the listener and the setting of the Source property Sourcef.ConeOuterGainHF. Type: bool Range [False, True] Default: True

EfxDirectFilterGainHighFrequencyAuto 

summary>(EFX Extension) If this Source property is set to True, the intensity of this Source’s reflected sound is automatically attenuated according to source-listener distance and source directivity (as determined by the cone parameters). If it is False, the reflected sound is not attenuated according to distance and directivity. Type: bool Range [False, True] Default: True

EfxAuxiliarySendFilterGainAuto 

summary>(EFX Extension) If this Source property is AL_TRUE (its default value), the intensity of this Source’s reflected sound at high frequencies will be automatically attenuated according to the high-frequency source directivity as set by the Sourcef.ConeOuterGainHF property. If this property is AL_FALSE, the Source’s reflected sound is not filtered at all according to the Source’s directivity. Type: bool Range [False, True] Default: True

A list of valid 32-bit Float Source/GetSource parameters

Enumerator
ReferenceDistance 

summary>Source specific reference distance. Type: float Range: [0.0f - float.PositiveInfinity] At 0.0f, no distance attenuation occurs. Type: float Default: 1.0f.

summary>Indicate distance above which Sources are not attenuated using the inverse clamped distance model. Default: float.PositiveInfinity Type: float Range: [0.0f - float.PositiveInfinity]

MaxDistance 

summary>Source specific rolloff factor. Type: float Range: [0.0f - float.PositiveInfinity]

RolloffFactor 

summary>Specify the pitch to be applied, either at Source, or on mixer results, at Listener. Range: [0.5f - 2.0f] Default: 1.0f

Pitch 

summary>Indicate the gain (volume amplification) applied. Type: float. Range: [0.0f - ? ] A value of 1.0 means un-attenuated/unchanged. Each division by 2 equals an attenuation of -6dB. Each multiplicaton with 2 equals an amplification of +6dB. A value of 0.0f is meaningless with respect to a logarithmic scale; it is interpreted as zero volume - the channel is effectively disabled.

Gain 

summary>Indicate minimum Source attenuation. Type: float Range: [0.0f - 1.0f] (Logarthmic)

MinGain 

summary>Indicate maximum Source attenuation. Type: float Range: [0.0f - 1.0f] (Logarthmic)

MaxGain 

summary>Directional Source, inner cone angle, in degrees. Range: [0-360] Default: 360

ConeInnerAngle 

summary>Directional Source, outer cone angle, in degrees. Range: [0-360] Default: 360

ConeOuterAngle 

summary>Directional Source, outer cone gain. Default: 0.0f Range: [0.0f - 1.0] (Logarithmic)

SecOffset 

The playback position, expressed in seconds.

EfxAirAbsorptionFactor 

summary>(EFX Extension) This property is a multiplier on the amount of Air Absorption applied to the Source. The AL_AIR_ABSORPTION_FACTOR is multiplied by an internal Air Absorption Gain HF value of 0.994 (-0.05dB) per meter which represents normal atmospheric humidity and temperature. Range [0.0f .. 10.0f] Default: 0.0f

summary>(EFX Extension) This property is defined the same way as the Reverb Room Rolloff property: it is one of two methods available in the Effect Extension to attenuate the reflected sound (early reflections and reverberation) according to source-listener distance. Range [0.0f .. 10.0f] Default: 0.0f

EfxRoomRolloffFactor 

summary>(EFX Extension) A directed Source points in a specified direction. The Source sounds at full volume when the listener is directly in front of the source; it is attenuated as the listener circles the Source away from the front. Range [0.0f .. 1.0f] Default: 1.0f

A list of valid Int32 Source parameters

Enumerator
ByteOffset 

summary>The playback position, expressed in bytes.

SampleOffset 

summary>The playback position, expressed in samples.

Buffer 

summary>Indicate the Buffer to provide sound samples. Type: uint Range: any valid Buffer Handle.

summary>Source type (Static, Streaming or undetermined). Use enum AlSourceType for comparison

SourceType 

summary>(EFX Extension) This Source property is used to apply filtering on the direct-path (dry signal) of a Source.

Source state information, can be retrieved by AL.Source() with ALSourcei.SourceState.

Enumerator
Initial 

summary>Default State when loaded, can be manually set with AL.SourceRewind().

summary>The source is currently playing.

Playing 

summary>The source has paused playback.

Paused 

summary>The source is not playing.

Source type information, can be retrieved by AL.Source() with ALSourcei.SourceType.

Enumerator
Static 

summary>Source is Static if a Buffer has been attached using AL.Source with the parameter Sourcei.Buffer.

summary>Source is Streaming if one or more Buffers have been attached using AL.SourceQueueBuffers

Streaming 

summary>Source is undetermined when it has a null Buffer attached

A list of valid 32-bits Float AuxiliaryEffectSlot/GetAuxiliaryEffectSlot parameters

Enumerator
EffectslotGain 

This property is used to specify an output level for the Auxiliary Effect Slot. Setting the gain to 0.0f mutes the output. Range [0.0f .. 1.0f] Default: 1.0f

A list of valid Int32 AuxiliaryEffectSlot/GetAuxiliaryEffectSlot parameters

Enumerator
EffectslotEffect 

This property is used to attach an Effect object to the Auxiliary Effect Slot object. After the attachment, the Auxiliary Effect Slot object will contain the effect type and have the same effect parameters that were stored in the Effect object. Any Sources feeding the Auxiliary Effect Slot will immediate feed the new effect type and new effect parameters.

EffectslotAuxiliarySendAuto 

This property is used to enable or disable automatic send adjustments based on the physical positions of the sources and the listener. This property should be enabled when an application wishes to use a reverb effect to simulate the environment surrounding a listener or a collection of Sources. Range [False, True] Default: True

A list of valid Math.Vector3 Effect/GetEffect parameters

Enumerator
EaxReverbLateReverbPan 

Reverb Pan does for the Reverb what Reflections Pan does for the Reflections. Unit: Vector3 of length 0f to 1f Default: {0.0f, 0.0f, 0.0f}

EaxReverbReflectionsPan 

This Vector3 controls the spatial distribution of the cluster of early reflections. The direction of this vector controls the global direction of the reflections, while its magnitude controls how focused the reflections are towards this direction. For legacy reasons this Vector3 follows a left-handed co-ordinate system! Note that OpenAL uses a right-handed coordinate system. Unit: Vector3 of length 0f to 1f Default: {0.0f, 0.0f, 0.0f}

A list of valid 32-bit Float Effect/GetEffect parameters

Enumerator
ReverbDensity 

summary>Reverb Modal Density controls the coloration of the late reverb. Lowering the value adds more coloration to the late reverb. Range [0.0f .. 1.0f] Default: 1.0f

summary>The Reverb Diffusion property controls the echo density in the reverberation decay. The default 1.0f provides the highest density. Reducing diffusion gives the reverberation a more "grainy" character that is especially noticeable with percussive sound sources. If you set a diffusion value of 0.0f, the later reverberation sounds like a succession of distinct echoes. Range [0.0f .. 1.0f] Default: 1.0f

ReverbDiffusion 

summary>The Reverb Gain property is the master volume control for the reflected sound - both early reflections and reverberation - that the reverb effect adds to all sound sources. Ranges from 1.0 (0db) (the maximum amount) to 0.0 (-100db) (no reflected sound at all) are accepted. Units: Linear gain Range [0.0f .. 1.0f] Default: 0.32f

ReverbGain 

summary>The Reverb Gain HF property further tweaks reflected sound by attenuating it at high frequencies. It controls a low-pass filter that applies globally to the reflected sound of all sound sources feeding the particular instance of the reverb effect. Ranges from 1.0f (0db) (no filter) to 0.0f (-100db) (virtually no reflected sound) are accepted. Units: Linear gain Range [0.0f .. 1.0f] Default: 0.89f

ReverbGainHF 

summary>The Decay Time property sets the reverberation decay time. It ranges from 0.1f (typically a small room with very dead surfaces) to 20.0 (typically a large room with very live surfaces). Unit: Seconds Range [0.1f .. 20.0f] Default: 1.49f

ReverbDecayTime 

summary>The Decay HF Ratio property sets the spectral quality of the Decay Time parameter. It is the ratio of high-frequency decay time relative to the time set by Decay Time.. Unit: linear multiplier Range [0.1f .. 2.0f] Default: 0.83f

ReverbDecayHFRatio 

summary>The Reflections Gain property controls the overall amount of initial reflections relative to the Gain property. The value of Reflections Gain ranges from a maximum of 3.16f (+10 dB) to a minimum of 0.0f (-100 dB) (no initial reflections at all), and is corrected by the value of the Gain property. Unit: Linear gain Range [0.0f .. 3.16f] Default: 0.05f

ReverbReflectionsGain 

summary>The Reflections Delay property is the amount of delay between the arrival time of the direct path from the source to the first reflection from the source. It ranges from 0 to 300 milliseconds. Unit: Seconds Range [0.0f .. 0.3f] Default: 0.007f

ReverbReflectionsDelay 

summary>The Late Reverb Gain property controls the overall amount of later reverberation relative to the Gain property. The value of Late Reverb Gain ranges from a maximum of 10.0f (+20 dB) to a minimum of 0.0f (-100 dB) (no late reverberation at all). Unit: Linear gain Range [0.0f .. 10.0f] Default: 1.26f

ReverbLateReverbGain 

summary>The Late Reverb Delay property defines the begin time of the late reverberation relative to the time of the initial reflection (the first of the early reflections). It ranges from 0 to 100 milliseconds. Unit: Seconds Range [0.0f .. 0.1f] Default: 0.011f

ReverbLateReverbDelay 

summary>The Air Absorption Gain HF property controls the distance-dependent attenuation at high frequencies caused by the propagation medium and applies to reflected sound only. Unit: Linear gain per meter Range [0.892f .. 1.0f] Default: 0.994f

ReverbAirAbsorptionGainHF 

summary>The Room Rolloff Factor property is one of two methods available to attenuate the reflected sound (containing both reflections and reverberation) according to source-listener distance. It's defined the same way as OpenAL's Rolloff Factor, but operates on reverb sound instead of direct-path sound. Unit: Linear multiplier Range [0.0f .. 10.0f] Default: 0.0f

ReverbRoomRolloffFactor 

summary>This property sets the modulation rate of the low-frequency oscillator that controls the delay time of the delayed signals. Unit: Hz Range [0.0f .. 10.0f] Default: 1.1f

ChorusRate 

summary>This property controls the amount by which the delay time is modulated by the low-frequency oscillator. Range [0.0f .. 1.0f] Default: 0.1f

ChorusDepth 

summary>This property controls the amount of processed signal that is fed back to the input of the chorus effect. Negative values will reverse the phase of the feedback signal. At full magnitude the identical sample will repeat endlessly. Range [-1.0f .. +1.0f] Default: +0.25f

ChorusFeedback 

summary>This property controls the average amount of time the sample is delayed before it is played back, and with feedback, the amount of time between iterations of the sample. Larger values lower the pitch. Unit: Seconds Range [0.0f .. 0.016f] Default: 0.016f

ChorusDelay 

summary>This property controls the shape of the distortion. The higher the value for Edge, the "dirtier" and "fuzzier" the effect. Range [0.0f .. 1.0f] Default: 0.2f

DistortionEdge 

summary>This property allows you to attenuate the distorted sound. Range [0.01f .. 1.0f] Default: 0.05f

DistortionGain 

summary>Input signals can have a low pass filter applied, to limit the amount of high frequency signal feeding into the distortion effect. Unit: Hz Range [80.0f .. 24000.0f] Default: 8000.0f

DistortionLowpassCutoff 

summary>This property controls the frequency at which the post-distortion attenuation (Distortion Gain) is active. Unit: Hz Range [80.0f .. 24000.0f] Default: 3600.0f

DistortionEQCenter 

summary>This property controls the bandwidth of the post-distortion attenuation. Unit: Hz Range [80.0f .. 24000.0f] Default: 3600.0f

DistortionEQBandwidth 

summary>This property controls the delay between the original sound and the first "tap", or echo instance. Subsequently, the value for Echo Delay is used to determine the time delay between each "second tap" and the next "first tap". Unit: Seconds Range [0.0f .. 0.207f] Default: 0.1f

EchoDelay 

summary>This property controls the delay between the "first tap" and the "second tap". Subsequently, the value for Echo LR Delay is used to determine the time delay between each "first tap" and the next "second tap". Unit: Seconds Range [0.0f .. 0.404f] Default: 0.1f

EchoLRDelay 

summary>This property controls the amount of high frequency damping applied to each echo. As the sound is subsequently fed back for further echoes, damping results in an echo which progressively gets softer in tone as well as intensity. Range [0.0f .. 0.99f] Default: 0.5f

EchoDamping 

summary>This property controls the amount of feedback the output signal fed back into the input. Use this parameter to create "cascading" echoes. At full magnitude, the identical sample will repeat endlessly. Below full magnitude, the sample will repeat and fade. Range [0.0f .. 1.0f] Default: 0.5f

EchoFeedback 

summary>This property controls how hard panned the individual echoes are. With a value of 1.0f, the first "tap" will be panned hard left, and the second "tap" hard right. –1.0f gives the opposite result and values near to 0.0f result in less emphasized panning. Range [-1.0f .. +1.0f] Default: -1.0f

EchoSpread 

summary>The number of times per second the low-frequency oscillator controlling the amount of delay repeats. Range [0.0f .. 10.0f] Default: 0.27f

FlangerRate 

summary>The ratio by which the delay time is modulated by the low-frequency oscillator. Range [0.0f .. 1.0f] Default: 1.0f

FlangerDepth 

summary>This is the amount of the output signal level fed back into the effect's input. A negative value will reverse the phase of the feedback signal. Range [-1.0f .. +1.0f] Default: -0.5f

FlangerFeedback 

summary>The average amount of time the sample is delayed before it is played back. When used with the Feedback property it's the amount of time between iterations of the sample. Unit: Seconds Range [0.0f .. 0.004f] Default: 0.002f

FlangerDelay 

summary>This is the carrier frequency. For carrier frequencies below the audible range, the single sideband modulator may produce phaser effects, spatial effects or a slight pitch-shift. As the carrier frequency increases, the timbre of the sound is affected. Unit: Hz Range [0.0f .. 24000.0f] Default: 0.0f

FrequencyShifterFrequency 

summary>This controls the frequency of the low-frequency oscillator used to morph between the two phoneme filters. Unit: Hz Range [0.0f .. 10.0f] Default: 1.41f

VocalMorpherRate 

summary>This is the frequency of the carrier signal. If the carrier signal is slowly varying (less than 20 Hz), the result is a slow amplitude variation effect (tremolo). Unit: Hz Range [0.0f .. 8000.0f] Default: 440.0f

RingModulatorFrequency 

summary>This controls the cutoff frequency at which the input signal is high-pass filtered before being ring modulated. Unit: Hz Range [0.0f .. 24000.0f] Default: 800.0f

RingModulatorHighpassCutoff 

summary>This property controls the time the filtering effect takes to sweep from minimum to maximum center frequency when it is triggered by input signal. Unit: Seconds Range [0.0001f .. 1.0f] Default: 0.06f

AutowahAttackTime 

summary>This property controls the time the filtering effect takes to sweep from maximum back to base center frequency, when the input signal ends. Unit: Seconds Range [0.0001f .. 1.0f] Default: 0.06f

AutowahReleaseTime 

summary>This property controls the resonant peak, sometimes known as emphasis or Q, of the auto-wah band-pass filter. Range [2.0f .. 1000.0f] Default: 1000.0f

AutowahResonance 

summary>This property controls the input signal level at which the band-pass filter will be fully opened. Range [0.00003f .. 31621.0f] Default: 11.22f

AutowahPeakGain 

summary>This property controls amount of cut or boost on the low frequency range. Range [0.126f .. 7.943f] Default: 1.0f

EqualizerLowGain 

summary>This property controls the low frequency below which signal will be cut off. Unit: Hz Range [50.0f .. 800.0f] Default: 200.0f

EqualizerLowCutoff 

summary>This property allows you to cut/boost signal on the "mid1" range. Range [0.126f .. 7.943f] Default: 1.0f

EqualizerMid1Gain 

summary>This property sets the center frequency for the "mid1" range. Unit: Hz Range [200.0f .. 3000.0f] Default: 500.0f

EqualizerMid1Center 

summary>This property controls the width of the "mid1" range. Range [0.01f .. 1.0f] Default: 1.0f

EqualizerMid1Width 

summary>This property allows you to cut/boost signal on the "mid2" range. Range [0.126f .. 7.943f] Default: 1.0f

EqualizerMid2Gain 

summary>This property sets the center frequency for the "mid2" range. Unit: Hz Range [1000.0f .. 8000.0f] Default: 3000.0f

EqualizerMid2Center 

summary>This property controls the width of the "mid2" range. Range [0.01f .. 1.0f] Default: 1.0f

EqualizerMid2Width 

summary>This property allows to cut/boost the signal at high frequencies. Range [0.126f .. 7.943f] Default: 1.0f

EqualizerHighGain 

summary>This property controls the high frequency above which signal will be cut off. Unit: Hz Range [4000.0f .. 16000.0f] Default: 6000.0f

EqualizerHighCutoff 

summary>Reverb Modal Density controls the coloration of the late reverb. Range [0.0f .. 1.0f] Default: 1.0f

EaxReverbDensity 

summary>The Reverb Diffusion property controls the echo density in the reverberation decay. Range [0.0f .. 1.0f] Default: 1.0f

EaxReverbDiffusion 

summary>Reverb Gain controls the level of the reverberant sound in an environment. A high level of reverb is characteristic of rooms with highly reflective walls and/or small dimensions. Unit: Linear gain Range [0.0f .. 1.0f] Default: 0.32f

EaxReverbGain 

summary>Gain HF is used to attenuate the high frequency content of all the reflected sound in an environment. You can use this property to give a room specific spectral characteristic. Unit: Linear gain Range [0.0f .. 1.0f] Default: 0.89f

EaxReverbGainHF 

summary>Gain LF is the low frequency counterpart to Gain HF. Use this to reduce or boost the low frequency content in an environment. Unit: Linear gain Range [0.0f .. 1.0f] Default: 1.0f

EaxReverbGainLF 

summary>The Decay Time property sets the reverberation decay time. It ranges from 0.1f (typically a small room with very dead surfaces) to 20.0f (typically a large room with very live surfaces). Unit: Seconds Range [0.1f .. 20.0f] Default: 1.49f

EaxReverbDecayTime 

summary>Decay HF Ratio scales the decay time of high frequencies relative to the value of the Decay Time property. By changing this value, you are changing the amount of time it takes for the high frequencies to decay compared to the mid frequencies of the reverb. Range [0.1f .. 2.0f] Default: 0.83f

EaxReverbDecayHFRatio 

summary>Decay LF Ratio scales the decay time of low frequencies in the reverberation in the same manner that Decay HF Ratio handles high frequencies. Unit: Linear multiplier Range [0.1f .. 2.0f] Default: 1.0f

EaxReverbDecayLFRatio 

summary>Reflections Gain sets the level of the early reflections in an environment. Early reflections are used as a cue for determining the size of the environment we are in. Unit: Linear gain Range [0.0f .. 3.16f] Default: 0.05f

EaxReverbReflectionsGain 

summary>Reflections Delay controls the amount of time it takes for the first reflected wave front to reach the listener, relative to the arrival of the direct-path sound. Unit: Seconds Range [0.0f .. 0.3f] Default: 0.007f

EaxReverbReflectionsDelay 

summary>The Late Reverb Gain property controls the overall amount of later reverberation relative to the Gain property. Range [0.0f .. 10.0f] Default: 1.26f

EaxReverbLateReverbGain 

summary>The Late Reverb Delay property defines the begin time of the late reverberation relative to the time of the initial reflection (the first of the early reflections). It ranges from 0 to 100 milliseconds. Unit: Seconds Range [0.0f .. 0.1f] Default: 0.011f

EaxReverbLateReverbDelay 

summary>Echo Time controls the rate at which the cyclic echo repeats itself along the reverberation decay. Range [0.075f .. 0.25f] Default: 0.25f

EaxReverbEchoTime 

summary>Echo Depth introduces a cyclic echo in the reverberation decay, which will be noticeable with transient or percussive sounds. Range [0.0f .. 1.0f] Default: 0.0f

EaxReverbEchoDepth 

summary>Modulation Time controls the speed of the rate of periodic changes in pitch (vibrato). Range [0.04f .. 4.0f] Default: 0.25f

EaxReverbModulationTime 

summary>Modulation Depth controls the amount of pitch change. Low values of Diffusion will contribute to reinforcing the perceived effect by reducing the mixing of overlapping reflections in the reverberation decay. Range [0.0f .. 1.0f] Default: 0.0f

EaxReverbModulationDepth 

summary>The Air Absorption Gain HF property controls the distance-dependent attenuation at high frequencies caused by the propagation medium. It applies to reflected sound only. Range [0.892f .. 1.0f] Default: 0.994f

EaxReverbAirAbsorptionGainHF 

summary>The property HF reference determines the frequency at which the high-frequency effects created by Reverb properties are measured. Unit: Hz Range [1000.0f .. 20000.0f] Default: 5000.0f

EaxReverbHFReference 

summary>The property LF reference determines the frequency at which the low-frequency effects created by Reverb properties are measured. Unit: Hz Range [20.0f .. 1000.0f] Default: 250.0f

EaxReverbLFReference 

summary>The Room Rolloff Factor property is one of two methods available to attenuate the reflected sound (containing both reflections and reverberation) according to source-listener distance. It's defined the same way as OpenAL Rolloff Factor, but operates on reverb sound instead of direct-path sound. Range [0.0f .. 10.0f] Default: 0.0f

A list of valid Int32 Effect/GetEffect parameters

Enumerator
ChorusWaveform 

summary>This property sets the waveform shape of the low-frequency oscillator that controls the delay time of the delayed signals. Unit: (0) Sinusoid, (1) Triangle Range [0 .. 1] Default: 1

summary>This property controls the phase difference between the left and right low-frequency oscillators. At zero degrees the two low-frequency oscillators are synchronized. Unit: Degrees Range [-180 .. 180] Default: 90

ChorusPhase 

summary>Selects the shape of the low-frequency oscillator waveform that controls the amount of the delay of the sampled signal. Unit: (0) Sinusoid, (1) Triangle Range [0 .. 1] Default: 1

FlangerWaveform 

summary>This changes the phase difference between the left and right low-frequency oscillator's. At zero degrees the two low-frequency oscillators are synchronized. Range [-180 .. +180] Default: 0

FlangerPhase 

summary>These select which internal signals are added together to produce the output. Unit: (0) Down, (1) Up, (2) Off Range [0 .. 2] Default: 0

FrequencyShifterLeftDirection 

summary>These select which internal signals are added together to produce the output. Unit: (0) Down, (1) Up, (2) Off Range [0 .. 2] Default: 0

FrequencyShifterRightDirection 

summary>Sets the vocal morpher 4-band formant filter A, used to impose vocal tract effects upon the input signal. The vocal morpher is not necessarily intended for use on voice signals; it is primarily intended for pitched noise effects, vocal-like wind effects, etc. Unit: Use enum EfxFormantFilterSettings Range [0 .. 29] Default: 0, "Phoneme A"

VocalMorpherPhonemeA 

summary>This is used to adjust the pitch of phoneme filter A in 1-semitone increments. Unit: Semitones Range [-24 .. +24] Default: 0

VocalMorpherPhonemeACoarseTuning 

summary>Sets the vocal morpher 4-band formant filter B, used to impose vocal tract effects upon the input signal. The vocal morpher is not necessarily intended for use on voice signals; it is primarily intended for pitched noise effects, vocal-like wind effects, etc. Unit: Use enum EfxFormantFilterSettings Range [0 .. 29] Default: 10, "Phoneme ER"

VocalMorpherPhonemeB 

summary>This is used to adjust the pitch of phoneme filter B in 1-semitone increments. Unit: Semitones Range [-24 .. +24] Default: 0

VocalMorpherPhonemeBCoarseTuning 

summary>This controls the shape of the low-frequency oscillator used to morph between the two phoneme filters. Unit: (0) Sinusoid, (1) Triangle, (2) Sawtooth Range [0 .. 2] Default: 0

VocalMorpherWaveform 

summary>This sets the number of semitones by which the pitch is shifted. There are 12 semitones per octave. Unit: Semitones Range [-12 .. +12] Default: +12

PitchShifterCoarseTune 

summary>This sets the number of cents between Semitones a pitch is shifted. A Cent is 1/100th of a Semitone. Unit: Cents Range [-50 .. +50] Default: 0

PitchShifterFineTune 

summary>This controls which waveform is used as the carrier signal. Traditional ring modulator and tremolo effects generally use a sinusoidal carrier. Unit: (0) Sinusoid, (1) Sawtooth, (2) Square Range [0 .. 2] Default: 0

RingModulatorWaveform 

summary>Enabling this will result in audio exhibiting smaller variation in intensity between the loudest and quietest portions. Unit: (0) Off, (1) On Range [0 .. 1] Default: 1

CompressorOnoff 

summary>When this flag is set, the high-frequency decay time automatically stays below a limit value that's derived from the setting of the property Air Absorption HF. Unit: (0) False, (1) True Range [False, True] Default: True

ReverbDecayHFLimit 

summary>When this flag is set, the high-frequency decay time automatically stays below a limit value that's derived from the setting of the property AirAbsorptionGainHF. Unit: (0) False, (1) True Range [False, True] Default: True

EffectType 

Used with the enum EfxEffectType as it's parameter.

Effect type definitions to be used with EfxEffecti.EffectType.

Enumerator
Null 

summary>No Effect, disable. This Effect type is used when an Effect object is initially created.

summary>The Reverb effect is the standard Effects Extension's environmental reverberation effect. It is available on all Generic Software and Generic Hardware devices.

Reverb 

summary>The Chorus effect essentially replays the input audio accompanied by another slightly delayed version of the signal, creating a "doubling" effect.

Chorus 

summary>The Distortion effect simulates turning up (overdriving) the gain stage on a guitar amplifier or adding a distortion pedal to an instrument's output.

Distortion 

summary>The Echo effect generates discrete, delayed instances of the input signal.

Echo 

summary>The Flanger effect creates a "tearing" or "whooshing" sound, like a jet flying overhead.

Flanger 

summary>The Frequency shifter is a single-sideband modulator, which translates all the component frequencies of the input signal by an equal amount.

FrequencyShifter 

summary>The Vocal morpher consists of a pair of 4-band formant filters, used to impose vocal tract effects upon the input signal.

VocalMorpher 

summary>The Pitch shifter applies time-invariant pitch shifting to the input signal, over a one octave range and controllable at a semi-tone and cent resolution.

PitchShifter 

summary>The Ring modulator multiplies an input signal by a carrier signal in the time domain, resulting in tremolo or inharmonic effects.

RingModulator 

summary>The Auto-wah effect emulates the sound of a wah-wah pedal used with an electric guitar, or a mute on a brass instrument.

Autowah 

summary>The Compressor will boost quieter portions of the audio, while louder portions will stay the same or may even be reduced.

Compressor 

summary>The Equalizer is very flexible, providing tonal control over four different adjustable frequency ranges.

Equalizer 

summary>The EAX Reverb has a more advanced parameter set than EfxEffectType.Reverb, but is only natively supported on devices that support the EAX 3.0 or above.

A list of valid 32-bits Float Filter/GetFilter parameters

Enumerator
LowpassGain 

summary>Range [0.0f .. 1.0f] Default: 1.0f

summary>Range [0.0f .. 1.0f] Default: 1.0f

LowpassGainHF 

summary>Range [0.0f .. 1.0f] Default: 1.0f

HighpassGain 

summary>Range [0.0f .. 1.0f] Default: 1.0f

HighpassGainLF 

summary>Range [0.0f .. 1.0f] Default: 1.0f

BandpassGain 

summary>Range [0.0f .. 1.0f] Default: 1.0f

BandpassGainLF 

summary>Range [0.0f .. 1.0f] Default: 1.0f

A list of valid Int32 Filter/GetFilter parameters

Enumerator
FilterType 

Used with the enum EfxFilterType as Parameter to select a filter logic.

Filter type definitions to be used with EfxFilteri.FilterType.

Enumerator
Null 

summary>No Filter, disable. This Filter type is used when a Filter object is initially created.

Lowpass 

A low-pass filter is used to remove high frequency content from a signal.

summary>Currently not implemented. A high-pass filter is used to remove low frequency content from a signal.

Highpass 

summary>Currently not implemented. A band-pass filter is used to remove high and low frequency content from a signal.

Vocal morpher effect parameters. If both parameters are set to the same phoneme, that determines the filtering effect that will be heard. If these two parameters are set to different phonemes, the filtering effect will morph between the two settings at a rate specified by EfxEffectf.VocalMorpherRate.

Enumerator
VocalMorpherPhonemeA 

The A phoneme of the vocal morpher.

VocalMorpherPhonemeE 

The E phoneme of the vocal morpher.

VocalMorpherPhonemeI 

The I phoneme of the vocal morpher.

VocalMorpherPhonemeO 

The O phoneme of the vocal morpher.

VocalMorpherPhonemeU 

The U phoneme of the vocal morpher.

VocalMorpherPhonemeAA 

The AA phoneme of the vocal morpher.

VocalMorpherPhonemeAE 

The AE phoneme of the vocal morpher.

VocalMorpherPhonemeAH 

The AH phoneme of the vocal morpher.

VocalMorpherPhonemeAO 

The AO phoneme of the vocal morpher.

VocalMorpherPhonemeEH 

The EH phoneme of the vocal morpher.

VocalMorpherPhonemeER 

The ER phoneme of the vocal morpher.

VocalMorpherPhonemeIH 

The IH phoneme of the vocal morpher.

VocalMorpherPhonemeIY 

The IY phoneme of the vocal morpher.

VocalMorpherPhonemeUH 

The UH phoneme of the vocal morpher.

VocalMorpherPhonemeUW 

The UW phoneme of the vocal morpher.

VocalMorpherPhonemeB 

The B phoneme of the vocal morpher.

VocalMorpherPhonemeD 

The D phoneme of the vocal morpher.

VocalMorpherPhonemeF 

The F phoneme of the vocal morpher.

VocalMorpherPhonemeG 

The G phoneme of the vocal morpher.

VocalMorpherPhonemeJ 

The J phoneme of the vocal morpher.

VocalMorpherPhonemeK 

The K phoneme of the vocal morpher.

VocalMorpherPhonemeL 

The L phoneme of the vocal morpher.

VocalMorpherPhonemeM 

The M phoneme of the vocal morpher.

VocalMorpherPhonemeN 

The N phoneme of the vocal morpher.

VocalMorpherPhonemeP 

The P phoneme of the vocal morpher.

VocalMorpherPhonemeR 

The R phoneme of the vocal morpher.

VocalMorpherPhonemeS 

The S phoneme of the vocal morpher.

VocalMorpherPhonemeT 

The T phoneme of the vocal morpher.

VocalMorpherPhonemeV 

The V phoneme of the vocal morpher.

VocalMorpherPhonemeZ 

The Z phoneme of the vocal morpher.