If something seems wrong or incomplete, please enter a comment at the bottom of this page.

- source - main - QA -

jsaudio module

Support 2D and 3D sound source and listener using OpenAL library.

class jsaudio::OalBuffer

• top - revision -

constructor( soundBlob )

arguments:

  1. <sub>Blob</sub> _soundBlob_:

Methods

_integer valueOf()

Properties

_integer frequency

is the frquency (in Hz) of the sound hold by the buffer.

_integer size

is the size (in bytes) of the sound hold by the buffer.

_integer bits

is the resolution (in bits) of the sound hold by the buffer.

_integer channels

is the number of channels of the sound hold by the buffer.

class jsaudio::OalEffect

• top - revision -

constructor()

Creates a new effect object.

Methods

_integer valueOf()

Returns the internal OpenAL buffer id.

Properties

_integer type

set the type of effect represented by the Effect object. * undefined * Oal.EFFECT_EAXREVERB * Oal.EFFECT_REVERB * Oal.EFFECT_CHORUS * Oal.EFFECT_DISTORTION * Oal.EFFECT_ECHO * Oal.EFFECT_FLANGER * Oal.EFFECT_FREQUENCY_SHIFTER * Oal.EFFECT_VOCAL_MORPHER * Oal.EFFECT_PITCH_SHIFTER * Oal.EFFECT_RING_MODULATOR * Oal.EFFECT_AUTOWAH * Oal.EFFECT_COMPRESSOR * Oal.EFFECT_EQUALIZER

========(many) * _real reverbDensity * _real reverbDiffusion * _real reverbGain * _real reverbGainHF * _real reverbDecayTime * _real reverbDecayHFRatio * _real reverbReflectionsGain * _real reverbReflectionsDelay * _real reverbLateReverbGain * _real reverbLateReverbDelay * _real reverbAirAbsorptionGainHF * _real reverbRoomRolloffFactor * _boolean reverbDecayHFLimit

• _integer chorusWaveform
• _integer chorusPhase
• _real chorusRate
• _real chorusDepth
• _real chorusFeedback

• _real chorusDelay

• _real distortionEdge

• _real distortionGain
• _real distortionLowpassCutoff
• _real distortionEqcenter

• _real distortionEqbandwidth

• _real echoDelay

• _real echoLrdelay
• _real echoDamping
• _real echoFeedback

• _real echoSpread

• _integer flangerWaveform

• _real flangerPhase
• _real flangerRate
• _real flangerDepth
• _real flangerFeedback

• _real flangerDelay

• _real frequencyShifterFrequency

• _integer frequencyShifterLeftDirection

• _integer frequencyShifterRightDirection

• _integer vocalMorpherPhonemea

• _integer vocalMorpherPhonemeaCoarseTuning
• _integer vocalMorpherPhonemeb
• _integer vocalMorpherPhonemebCoarseTuning
• _integer vocalMorpherWaveform

• _real vocalMorpherRate

• _integer pitchShifterCoarseTune

• _integer pitchShifterFineTune

• _real ringModulatorFrequency

• _real ringModulatorHighpassCutoff

• _integer ringModulatorWaveform

• _real autowahAttackTime

• _real autowahReleaseTime
• _real autowahResonance

• _real autowahPeakGain

• _boolean compressorOnoff

• _real equalizerLowGain

• _real equalizerLowCutoff
• _real equalizerMid1Gain
• _real equalizerMid1Center
• _real equalizerMid1Width
• _real equalizerMid2Gain
• _real equalizerMid2Center
• _real equalizerMid2Width
• _real equalizerHighGain
• _real equalizerHighCutoff

class jsaudio::OalFilter

• top - revision -

constructor()

Creates a new filter object.

Methods

_integer valueOf()

Returns the internal OpenAL filter id.

Properties

_integer type

set the type of filter represented by the Filter object. * undefined * Oal.FILTER_NULL * Oal.FILTER_LOWPASS * Oal.FILTER_HIGHPASS * Oal.FILTER_BANDPASS

========(many) * _real lowpassGain * _real lowpassGainHF

• _real highpassGain

• _real highpassGainLF

• _real bandpassGain

• _real bandpassGainLF
• _real bandpassGainHF

class jsaudio::OalListener

• top - revision -

Properties

_Array position

Gets or sets the position of the listener in the 3D environment.

_Array metersPerUnit

Gets or sets the unit size of the 3D environment.

class jsaudio::Oal

• top - revision -

Static functions

_void Open( [.md deviceName ] )

Open an audio device.

arguments:

  1. <sub>string</sub> _deviceName_: "Generic Hardware", "Generic Software", "DirectSound3D" (for legacy), "DirectSound", "MMSYSTEM"

If no device name is specified, we will attempt to use DS3D.

OpenAL API:

alcOpenDevice, alcCreateContext, alcMakeContextCurrent

_void Close()

Close the current audio device.

OpenAL API:

alcGetCurrentContext, alcMakeContextCurrent, alcGetContextsDevice, alcDestroyContext, alcCloseDevice

_boolean hasEfx

is true if EFX extension is available.

_boolean maxAuxiliarySends

is the number of aux sends per source.

_void DopplerFactor( value )

Selects the OpenAL Doppler factor value. The default Doppler factor value is 1.0 .

arguments:

  1. <sub>number</sub> _value_

OpenAL API:

alDopplerFactor

_void DopplerVelocity( value )

Selects the OpenAL Doppler velocity value. The default Doppler velocity value is 343.3 .

arguments:

  1. <sub>number</sub> _value_

OpenAL API:

alDopplerVelocity

_void SpeedOfSound( value )

Selects the OpenAL Speed of Sound value.

arguments:

  1. <sub>number</sub> _value_

OpenAL API:

alSpeedOfSound

_void DistanceModel( distanceModel )

arguments:

  1. <sub>integer</sub> _value_

OpenAL API:

alDistanceModel

_void Enable( cap )

arguments:

  1. <sub>GLenum</sub> _cap_

OpenAL API:

alEnable

_void Disable( cap )

arguments:

  1. <sub>GLenum</sub> _cap_

OpenAL API:

alDisable

_void IsEnabled( cap )

arguments:

  1. <sub>GLenum</sub> _cap_

OpenAL API:

alIsEnabled

_boolean GetString( pname )

arguments:

  1. <sub>GLenum</sub> _pname_

return value:

value of a selected parameter.

OpenAL API:

alGetString

_boolean GetBoolean( pname )

arguments:

  1. <sub>ALenum</sub> _pname_

return value:

value of a selected parameter.

OpenAL API:

alGetBooleanv

_integer | _Array GetInteger( pname [.md, count] )

arguments:

  1. <sub>ALenum</sub> _pname_
  1. <sub>integer</sub> _count_: is the number of expected values. If _count_ is defined, the function will returns an array of values, else it returns a single value.

return value:

A single value or an array of values of a selected parameter.

OpenAL API:

alGetIntegerv

_real | _Array GetDouble( pname [.md, count] )

arguments:

  1. <sub>ALenum</sub> _pname_
  1. <sub>integer</sub> _count_: is the number of expected values. If _count_ is defined, the function will returns an array of values, else a single value.

return value:

single value or Array of values of the selected parameter.

OpenAL API:

alGetDoublev

_void Listener( pname, params )

arguments:

  1. <sub>ALenum</sub> _pname_:
  1. <sub>Array</sub> _params_:

OpenAL API:

alListeneri, alListenerf, alListenerfv

_real | _Array GetListenerReal( source, pname [.md, count] )

arguments:

  1. <sub>integer</sub> _source_:
  1. <sub>ALenum</sub> _pname_:
  1. <sub>integer</sub> _count_: is the number of expected values. If _count_ is defined, the function will returns an array of values, else a single value.

return value:

single value or Array of values of the selected parameter.

OpenAL API:

alGetListenerfv

_integer GenSource()

OpenAL API:

alSourcei, alSourcef, alSourcefv

_void Source( source, pname, params )

arguments:

  1. <sub>integer</sub> _source_:
  1. <sub>ALenum</sub> _pname_:
  1. <sub>Array</sub> _params_:

OpenAL API:

alSourcei, alSourcef, alSourcefv

_real | _Array GetSourceReal( source, pname [.md, count] )

arguments:

  1. <sub>integer</sub> _source_:
  1. <sub>ALenum</sub> _pname_:
  1. <sub>integer</sub> _count_: is the number of expected values. If _count_ is defined, the function will returns an array of values, else a single value.

return value:

single value or Array of values of the selected parameter.

OpenAL API:

alGetSourcef

_real | _Array GetSourceInteger( source, pname [.md, count] )

_void DeleteSource( source )

arguments:

  1. <sub>integer</sub> _source_: the source id.

OpenAL API:

alDeleteBuffers

_void SourceQueueBuffers( source, buffer | bufferArray )

arguments:

  1. <sub>integer</sub> _source_: the source id.
  1. <sub>integer</sub> _buffer_: the buffer id.
  1. <sub>Array</sub> _bufferArray_: an Array of buffer id.

OpenAL API:

alDeleteBuffers

_void SourceUnqueueBuffers( source, buffer | bufferArray )

arguments:

  1. <sub>integer</sub> _buffer_: the buffer id.
  1. <sub>Array</sub> _bufferArray_: an Array of buffer id.

OpenAL API:

alDeleteBuffers

_integer Buffer( soundObject )

Creates a new buffer and attach a sound data to it. The data comming from the soundObject is copied into the OpenAL system. undefined

Buffers containing audio data with more than one channel will be played without 3D spatialization features these formats are normally used for background music.

arguments:

  1. <sub>soundObject</sub> _sound_: a sound object that contains PCM audio data and the following properties: rate, channels and bits.

_real | _Array GetBufferReal( source, pname [.md, count] )

arguments:

  1. <sub>integer</sub> _source_:
  1. <sub>ALenum</sub> _pname_:
  1. <sub>integer</sub> _count_: is the number of expected values. If _count_ is defined, the function will returns an array of values, else a single value.

return value:

single value or Array of values of the selected parameter.

OpenAL API:

alGetBufferfv

_integer | _Array GetBufferInteger( source, pname [.md, count] )

arguments:

  1. <sub>integer</sub> _source_:
  1. <sub>ALenum</sub> _pname_:
  1. <sub>integer</sub> _count_: is the number of expected values. If _count_ is defined, the function will returns an array of values, else a single value.

return value:

single value or Array of values of the selected parameter.

OpenAL API:

alGetBufferiv

_void DeleteBuffer( buffer )

arguments:

  1. <sub>integer</sub> _buffer_: the buffer id.

note:

Buffers that have been unqueued from all sources are UNUSED. Buffers that are UNUSED can be deleted, or changed by alBufferData commands.

OpenAL API:

alDeleteBuffers

_void PlaySource( source )

Plays the given source.

arguments:

  1. <sub>integer</sub> _source_: the ID of the source to play.

_void StopSource( source )

Stop the given source.

arguments:

  1. <sub>integer</sub> _source_: the ID of the source to play.

_void PauseSource( source )

Pause the given source.

arguments:

  1. <sub>integer</sub> _source_: the ID of the source to play.

_void RewindSource( source )

Rewind the given source. set playback postiton to beginning.

arguments:

  1. <sub>integer</sub> _source_: the ID of the source to play.

_void GenEffect()

OpenaL API:

alGenEffects

_void DeleteEffect()

OpenaL API:

alGenEffects

_void PlaySound( sound )

Plays a sound on the default playback device.

arguments:

  1. <sub>soundObject</sub> _sound_: sound object to play.

Examples

A simple ogg player ``` LoadModule('jsio'); LoadModule('jsstd'); LoadModule('jssound'); LoadModule('jsaudio');

Oal.Open(); var decoder = new OggVorbisDecoder(new File('41_30secOgg-q0.ogg').Open(File.RDONLY)); var sourceId = Oal.GenSource();

var pcm; while ( pcm = decoder.Read(10000) ) {

var bufferId = Oal.Buffer(pcm); Oal.SourceQueueBuffers(sourceId, bufferId); if ( Oal.GetSourceInteger(sourceId, Oal.SOURCE_STATE) == Oal.INITIAL ) Oal.PlaySource(sourceId); };

var totalTime = decoder.frames/decoder.rate; var currentTimeOffset = Oal.GetSourceReal(sourceId, Oal.SEC_OFFSET); Sleep( 1000 * (totalTime - currentTimeOffset) ); ```

class jsaudio::OalSource

• top - revision -

constructor()

Creates a new source object.

_void QueueBuffers( buffer )

arguments:

  1. <sub>OalBuffer</sub> | BufferId: a Buffer Object or a buffer Id.

OpenAL API:

alDeleteBuffers

_OalBuffer UnqueueBuffers()

OpenAL API:

alDeleteBuffers

Properties

class jsaudio::OalError

• top -

_integer code

OpenAL error number.

_string text

OpenAL error literal.

_string const

Const name of the OpenAL error.

_string toString

see Text().

more information

OpenAL Specification and Reference OpenAL 1.1 Specification and Reference

• top - main -