Class Sound3D

Namespace

OmegaEngine.Audio

Assembly

OmegaEngine.dll

A memory-cached sound that is played on-demand simulating a position in 3D-space.

public class Sound3D : Sound, IDisposable, IAudio

Inheritance

object

EngineElement

Sound

Sound3D

Implements

IDisposable

IAudio

Inherited Members

Sound.Asset

Sound.Playing

Sound.Looping

Sound.Volume

Sound.StartPlayback(bool)

Sound.OnDispose()

EngineElement.RegisterChild(EngineElement, bool)

EngineElement.UnregisterChild(EngineElement)

EngineElement.Engine

EngineElement.IsEngineSet

EngineElement.OnEngineSet()

EngineElement.IsDisposed

EngineElement.Dispose()

Constructors

Sound3D(XSound)

A memory-cached sound that is played on-demand simulating a position in 3D-space.

public Sound3D(XSound sound)

Parameters

sound XSound

Properties

Attenuation

Factors describing how the sound's volume attenuates with distance from the listener.

public Attenuation Attenuation { get; set; }

Property Value

Attenuation

Position

The sound's position in world space

public DoubleVector3 Position { get; set; }

Property Value

DoubleVector3

Methods

ApplyVolume()

Applies the current Volume to the active playback (if any).

protected override void ApplyVolume()

CreatePlaybackChain(bool)

Builds the chain of sample providers feeding the mixer for a single playback.

protected override ISampleProvider CreatePlaybackChain(bool looping)

Parameters

looping bool

Whether the playback should loop.

Returns

ISampleProvider

The top-level sample provider (stereo, SampleRate, IEEE-float).

StopPlayback()

Stops the sound playback

public override void StopPlayback()