Tao.OpenAl SDK Documentation

Al Members

Al overview

Public Static (Shared) Fields

AL_BITS Buffer bit depth.
AL_BUFFER Indicates the buffer to provide sound samples. The accepted range is any valid buffer ID.
AL_BUFFERS_PROCESSED Buffers are processed.
AL_BUFFERS_QUEUED Buffers are queued.
AL_BYTE_OFFSET Source buffer position information.
AL_CHANNEL_MASK Specifies the channel mask. The accepted range is 0 to 255.
AL_CHANNELS Buffer channels.
AL_CONE_INNER_ANGLE Directional source, inner cone angle, in degrees. The accepted range is 0 to 360, the default value is 360.
AL_CONE_OUTER_ANGLE Directional source, outer cone angle, in degrees. The accepted range is 0 to 360, the default value is 360.
AL_CONE_OUTER_GAIN Indicates the gain (volume amplification) applied. The accepted range is 0.0 or above. A value of 1.0 means unattenuated/unchanged. Each division by 2 equals an attenuation of -6dB. Each multiplication by 2 equals an amplification of +6dB. A value of 0.0 is meaningless with respect to a logarithmic scale; it is interpreted as zero volume, the channel is effectively disabled.
AL_CURRENT Buffer current.
AL_DATA Buffer data.
AL_DIRECTION Specifies the current direction as forward vector.
AL_DISTANCE_MODEL Distance model. The default value is AL_INVERSE_DISTANCE_CLAMPED.
AL_DISTANCE_SCALE Distance scaling.
AL_DOPPLER_FACTOR Doppler scale. The default value is 1.0.
AL_DOPPLER_VELOCITY Doppler velocity. The default value is 1.0.
AL_ENV_DECAY_HIGH_FREQUENCY_RATIO_IASIG Decay high frequency ratio. The accepted range is 0.1 to 2.0. The default value is 0.5.
AL_ENV_DECAY_TIME_IASIG Decay time. The accepted range is 0.1 to 20.0. The default value is 1.0.
AL_ENV_DENSITY_IASIG Density. The accepted range is 0.0 to 100.0. The default value is 100.0.
AL_ENV_DIFFUSION_IASIG Diffusion. The accepted range is 0.0 to 100.0. The default value is 100.0.
AL_ENV_HIGH_FREQUENCY_REFERENCE_IASIG High frequency reference. The accepted range is 20.0 to 20000.0. The default value is 5000.0.
AL_ENV_REFLECTIONS_DELAY_IASIG Reflections delay. The accepted range is 0.0 to 0.3. The default value is 0.02.
AL_ENV_REFLECTIONS_IASIG Reflections. The accepted range is -10000 to 1000. The default value is -10000.
AL_ENV_REVERB_DELAY_IASIG Reverb delay. The accepted range is 0.0 to 0.1. The default value is 0.04.
AL_ENV_REVERB_IASIG Reverb. The accepted range is -10000 to 2000. The default value is -10000.
AL_ENV_ROOM_HIGH_FREQUENCY_IASIG Room high frequency. The accepted range is -10000 to 0. The default value is 0.
AL_ENV_ROOM_IASIG Room. The accepted range is -10000 to 0. The default value is -10000.
AL_ENV_ROOM_ROLLOFF_FACTOR Room rolloff factor. The accepted range is 0.1 to 20.0. The default value is 0.0.
AL_EXPONENT_DISTANCE
AL_EXPONENT_DISTANCE_CLAMPED
AL_EXTENSIONS Extensions.
AL_FALSE bool false.
AL_FORMAT_MONO16 16-bit mono buffer.
AL_FORMAT_MONO8 8-bit mono buffer.
AL_FORMAT_STEREO16 16-bit stereo buffer.
AL_FORMAT_STEREO8 8-bit stereo buffer.
AL_FREQUENCY Buffer 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.
AL_GAIN Indicates the gain (volume amplification) applied. The accepted range is 0.0 or above. A value of 1.0 means unattenuated/unchanged. Each division by 2 equals an attenuation of -6dB. Each multiplication by 2 equals an amplification of +6dB. A value of 0.0 is meaningless with respect to a logarithmic scale; it is interpreted as zero volume, the channel is effectively disabled.
AL_ILLEGAL_COMMAND A function was called at an inappropriate time or in an inappropriate way, causing an illegal state. This can be an incompatible value, object ID, and/or function.
AL_ILLEGAL_ENUM Illegal enum passed as an argument to an AL call.
AL_INITIAL Source initialized.
AL_INVALID Bad value.
AL_INVALID_ENUM Illegal enum passed as an argument to an AL call.
AL_INVALID_NAME Illegal name passed as an argument to an AL call.
AL_INVALID_OPERATION A function was called at an inappropriate time or in an inappropriate way, causing an illegal state. This can be an incompatible value, object ID, and/or function.
AL_INVALID_VALUE Illegal value passed as an argument to an AL call. Applies to parameter values, but not to enumerations.
AL_INVERSE_DISTANCE Inverse distance model.
AL_INVERSE_DISTANCE_CLAMPED Inverse distance clamped model.
AL_LINEAR_DISTANCE
AL_LINEAR_DISTANCE_CLAMPED
AL_LOOPING Indicates whether source has to loop infinitely. The accepted values are AL_TRUE or AL_FALSE, the default value is AL_FALSE.
AL_MAX_DISTANCE Specifies the maximum distance. The accepted range is 0.0 or above.
AL_MAX_GAIN Indicates maximum source attenuation. The accepted range is 0.0 to 1.0.
AL_MIN_GAIN Indicates minimum source attenuation. The accepted range is 0.0 to 1.0.
AL_NO_ERROR No error.
AL_NONE Disable value.
AL_ORIENTATION Specifies the current orientation.
AL_OUT_OF_MEMORY A function could not be completed, because there is not enough memory available.
AL_PAUSED Source paused.
AL_PENDING Buffer pending.
AL_PITCH Specifies the pitch to be applied, either at source, or on mixer results, at listener. The accepted range is 0.5 to 2.0, the default value is 1.0.
AL_PLAYING Source playing.
AL_POSITION Specifies 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 to a left-handed coordinate system, flip the sign on the Z coordinate. Listener position is always in the world coordinate system.
AL_PROCESSED Buffer processed.
AL_QUEUED Buffer queued.
AL_REFERENCE_DISTANCE byte offset into source (in canon format). -1 if source is not playing. Do not set this, only get this value. The accepted range is 0.0 or above. The default value is 1.0.
AL_RENDERER Renderer.
AL_ROLLOFF_FACTOR Indicates the rolloff factor for the source. The accepted range is 0.0 or above. The default value is 1.0.
AL_SAMPLE_OFFSET Source buffer position information.
AL_SEC_OFFSET Source buffer position information.
AL_SIZE Buffer size.
AL_SOURCE_RELATIVE Indicates source has listener-relative coordinates.
AL_SOURCE_STATE Source state information.
AL_SOURCE_TYPE Indicates the type of AL_SOURCE. Sources can be spatialized.
AL_SPEED_OF_SOUND Speed of Sound
AL_STATIC Indicates whether source is meant to be static. The accepted values are AL_TRUE or AL_FALSE, the default value is AL_FALSE.
AL_STOPPED Source stopped.
AL_STREAMING Indicates whether source is meant to be streaming. The accepted values are AL_TRUE or AL_FALSE, the default value is AL_FALSE.
AL_TRUE bool true.
AL_UNDETERMINED Indicates whether source is meant to be undetermined. The accepted values are AL_TRUE or AL_FALSE, the default value is AL_FALSE.
AL_UNUSED Buffer unused.
AL_VELOCITY Specifies the current velocity in three dimensional space.
AL_VENDOR Vendor name.
AL_VERSION Version.

Public Static (Shared) Methods

alBuffer3f Set Buffer parameters.
alBuffer3i Set Buffer parameters.
alBufferDataOverloaded. Fills a buffer with audio data.
alBufferf Set Buffer parameters.
alBufferfv Set Buffer parameters.
alBufferi Set Buffer parameters.
alBufferiv Set Buffer parameters.
alDeleteBuffersOverloaded. Deletes one or more buffers.
alDeleteEnvironmentIASIGOverloaded. Unknown.
alDeleteSourcesOverloaded. Deletes one or more sources.
alDisable Disables a feature of the OpenAL driver.
alDistanceModel Selects the OpenAL distance model.
alDopplerFactor Selects the OpenAL Doppler factor value.
alDopplerVelocity Selects the OpenAL Doppler velocity value.
alEnable Enables a feature of the OpenAL driver.
alEnvironmentfIASIG Unknown.
alEnvironmentiIASIG Unknown.
alGenBuffersOverloaded. Generates one or more buffers.
alGenEnvironmentIASIGOverloaded. Unknown.
alGenSourcesOverloaded. Generates one or more sources.
alGetBoolean Returns a boolean OpenAL state.
alGetBooleanvOverloaded. Retrieves a boolean OpenAL state.
alGetBuffer3f Retrieves a floating point property of a buffer.
alGetBuffer3i Retrieves an integer property of a buffer.
alGetBufferfOverloaded. Retrieves a floating point property of a buffer.
alGetBufferfvOverloaded. Retrieves a floating point property of a buffer.
alGetBufferiOverloaded. Retrieves an integer property of a buffer.
alGetBufferivOverloaded. Retrieves an integer property of a buffer.
alGetDouble Returns a double precision floating point OpenAL state.
alGetDoublevOverloaded. Retrieves a double precision floating point OpenAL state.
alGetEnumValue Returns the enumeration value of an OpenAL enum described by a string.
alGetError Returns the current error state and then clears the error state.
alGetFloat Returns a floating point OpenAL state.
alGetFloatvOverloaded. Retrieves a floating point OpenAL state.
alGetInteger Returns an integer OpenAL state.
alGetIntegervOverloaded. Retrieves an integer OpenAL state.
alGetListener3fOverloaded. Retrieves a set of three floating point values from a property of the listener.
alGetListener3i Retrieves a set of three integer values from a property of the listener.
alGetListenerfOverloaded. Retrieves a floating point property of the listener.
alGetListenerfvOverloaded. Retrieves a floating point-vector property of the listener.
alGetListeneriOverloaded. Retrieves an integer property of the listener.
alGetListenerivOverloaded. Retrieves an integer property of the listener.
alGetProcAddress Returns the address of an OpenAL extension function.
alGetSource3fOverloaded. Retrieves an integer property of a source.
alGetSource3i Retrieves an integer property of a source.
alGetSourcefOverloaded. Retrieves a floating point property of a source.
alGetSourcefvOverloaded. Retrieves a floating point-vector property of a source.
alGetSourceiOverloaded. Retrieves an integer property of a source.
alGetSourceivOverloaded. Retrieves an integer property of a source.
alGetString Retrieves an OpenAL string property.
alHint Sets application preferences for driver performance choices.
alIsBuffer Tests if a buffer name is valid.
alIsEnabled Returns a value indicating if a specific feature is enabled in the OpenAL driver.
alIsEnvironmentIASIG Unknown.
alIsExtensionPresent Tests if a specific extension is available for the OpenAL driver.
alIsSource Tests if a source name is valid.
alListener3f Sets a floating point property for the listener.
alListener3i Sets an integer property for the listener.
alListenerf Sets a floating point property for the listener.
alListenerfvOverloaded. Sets a floating point-vector property of the listener.
alListeneri Sets an integer property of the listener.
alListeneriv Sets a integer-vector property of the listener.
alQueuei Unknown.
alSource3f Sets a source property requiring three floating point values.
alSource3i Sets a source property requiring three integer values.
alSourcef Sets a floating point property of a source.
alSourcefvOverloaded. Sets a floating point-vector property of a source.
alSourcei Sets an integer property of a source.
alSourceiv Sets a integer-vector property of a source.
alSourcePause Pauses a source.
alSourcePausevOverloaded. Pauses a set of sources.
alSourcePlay Plays a source.
alSourcePlayvOverloaded. Plays a set of sources.
alSourceQueueBuffersOverloaded. Queues a set of buffers on a source.
alSourceRewind Stops the source and sets its state to AL_INITIAL.
alSourceRewindvOverloaded. Stops a set of sources and sets all their states to AL_INITIAL.
alSourceStop Stops a source.
alSourceStopvOverloaded. Stops a set of sources.
alSourceUnqueueBuffersOverloaded. Unqueues a set of buffers attached to a source.
alSpeedOfSound Selects the OpenAL Speed of Sound value.

Public Instance Methods

Equals (inherited from Object) 
GetHashCode (inherited from Object) 
GetType (inherited from Object) 
ToString (inherited from Object) 

See Also

Al Class | Tao.OpenAl Namespace