Table of Contents

Class AudioEmitter

Namespace
LibGFX.Core.GameElements
Assembly
LibGFX.dll

Represents an audio emitter in 3D space

public class AudioEmitter : GameElement, IIdentifier, IPropertyTable, ISerialization
Inheritance
AudioEmitter
Implements
Inherited Members

Constructors

AudioEmitter(IAudioDevice, AudioClip, PlayMode)

Creates a new audio emitter with a clip

public AudioEmitter(IAudioDevice audioDevice, AudioClip clip, PlayMode playMode = PlayMode.Loop)

Parameters

audioDevice IAudioDevice
clip AudioClip
playMode PlayMode

AudioEmitter(IAudioDevice, PlayMode)

Creates a new audio emitter

public AudioEmitter(IAudioDevice audioDevice, PlayMode playMode = PlayMode.Loop)

Parameters

audioDevice IAudioDevice
playMode PlayMode

Properties

HasTransparency

Gets a value indicating whether the image contains any transparent pixels.

public override bool HasTransparency { get; }

Property Value

bool

Source

Gets the audio source for this emitter

public AudioSource Source { get; }

Property Value

AudioSource

Methods

ComputeAABB()

Computes the axis-aligned bounding box (AABB) for this audio emitter.

public override void ComputeAABB()

Init(BaseScene, Viewport, IRenderDevice)

Initializes the audio emitter

public override void Init(BaseScene scene, Viewport viewport, IRenderDevice renderer)

Parameters

scene BaseScene
viewport Viewport
renderer IRenderDevice

Pause()

Pauses the audio source

public void Pause()

Play()

Plays the audio source

public void Play()

SetAudioClip(AudioClip)

Sets the audio clip for this emitter

public void SetAudioClip(AudioClip clip)

Parameters

clip AudioClip

SetPlayMode(PlayMode)

Sets the play mode for this emitter

public void SetPlayMode(PlayMode playMode)

Parameters

playMode PlayMode

SetRange(Vector3)

Sets the range for this emitter

public void SetRange(Vector3 value)

Parameters

value Vector3

Stop()

Stops the audio source

public void Stop()