class AudioSource

package soloud

extended by Wav, WavStream

@:native("SoLoud::AudioSource*")@:include("linc_soloud.h")

Available on clay native

Base class for audio sources

Static methods

@:has_untypedstaticinlinecreate():AudioSource

Variables

mFlags:AudioSourceFlags

Flags. See AudioSource::FLAGS

mBaseSamplerate:Float32

Base sample rate, used to initialize instances

mVolume:Float32

Default volume for created instances

mChannels:UInt32

Number of channels this audio source produces

mAudioSourceID:UInt32

Sound source ID. Assigned by SoLoud the first time it's played.

m3dMinDistance:Float32

3d min distance

m3dMaxDistance:Float32

3d max distance

m3dAttenuationRolloff:Float32

3d attenuation rolloff factor

m3dAttenuationModel:UInt32

3d attenuation model

m3dDopplerFactor:Float32

3d doppler factor

mFilter:Pointer<Filter>

Filter pointer

mSoloud:Soloud

Pointer to the Soloud object. Needed to stop all instances in dtor.

mCollider:AudioCollider

Pointer to a custom audio collider object

mAttenuator:AudioAttenuator

Pointer to custom attenuator object

mColliderData:Int32

User data related to audio collider

mLoopPoint:Time

When looping, start playing from this time

Methods

@:has_untypedinlinedestroy():Void

setVolume(aVolume:Float32):Void

Set default volume for instances

setLooping(aLoop:Bool):Void

Set the looping of the instances created from this audio source

setSingleInstance(aSingleInstance:Bool):Void

Set whether only one instance of this sound should ever be playing at the same time

set3dMinMaxDistance(aMinDistance:Float32, aMaxDistance:Float32):Void

Set the minimum and maximum distances for 3d audio source (closer to min distance = max vol)

set3dAttenuation(aAttenuationModel:UInt32, aAttenuationRolloffFactor:Float32):Void

Set attenuation model and rolloff factor for 3d audio source

set3dDopplerFactor(aDopplerFactor:Float32):Void

Set doppler factor to reduce or enhance doppler effect, default = 1.0

set3dListenerRelative(aListenerRelative:Bool):Void

Set the coordinates for this audio source to be relative to listener's coordinates.

set3dDistanceDelay(aDistanceDelay:Bool):Void

Enable delaying the start of the sound based on the distance.

@:value({ aUserData : 0 })set3dCollider(aCollider:AudioCollider, aUserData:Int32 = 0):Void

Set a custom 3d audio collider. Set to NULL to disable.

set3dAttenuator(aAttenuator:AudioAttenuator):Void

Set a custom attenuator. Set to NULL to disable.

setInaudibleBehavior(aMustTick:Bool, aKill:Bool):Void

Set behavior for inaudible sounds

setLoopPoint(aLoopPoint:Time):Void

Set time to jump to when looping

getLoopPoint():Time

Get current loop point value

setFilter(aFilterId:UInt32, aFilter:Filter):Void

Set filter. Set to NULL to clear the filter.

createInstance():AudioSourceInstance

Create instance from the audio source. Called from within Soloud class.

stop():Void

Stop all instances of this audio source