Tao.OpenAl SDK Documentation

Al Fields

The fields of the Al class are listed below. For a complete list of Al class members, see the Al Members topic.

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.

See Also

Al Class | Tao.OpenAl Namespace