SoundDevice Class

Delta Engine Documentation

Holds the audio device and automatically disposes all finished playing sound instances. View code on GitHub

Inheritance Hierarchy

System Object
  DeltaEngine.Entities Entity
    DeltaEngine.Multimedia SoundDevice
      DeltaEngine.Multimedia.BaseOpenAL OpenALSoundDevice
      DeltaEngine.Multimedia.Mocks MockSoundDevice
      DeltaEngine.Multimedia.SharpDX XAudioDevice
      DeltaEngine.Multimedia.SlimDX XAudioDevice
      DeltaEngine.Multimedia.Xna XnaSoundDevice

Namespace: DeltaEngine.Multimedia
Assembly: DeltaEngine (in DeltaEngine.dll) Version: 1.1.1.0 (1.1.1)

Syntax

C++

Copy to Clipboard Print

public abstract class SoundDevice : Entity, 
	RapidUpdateable

public abstract class SoundDevice : Entity, 
	RapidUpdateable

Public MustInherit Class SoundDevice 
	Inherits Entity 
	Implements RapidUpdateable

Public MustInherit Class SoundDevice 
	Inherits Entity 
	Implements RapidUpdateable

public ref class SoundDevice abstract : public Entity, 
	RapidUpdateable

public ref class SoundDevice abstract : public Entity, 
	RapidUpdateable

[<AbstractClassAttribute>]
type SoundDevice =  
    class 
        inherit Entity 
        interface RapidUpdateable 
    end

[<AbstractClassAttribute>]
type SoundDevice =  
    class 
        inherit Entity 
        interface RapidUpdateable 
    end

The SoundDevice type exposes the following members.

Constructors

	Name	Description
	SoundDevice	Initializes a new instance of the SoundDevice class

Top

Methods

	Name	Description
	Add T	(Inherited from Entity.)
	AddTag	View code on GitHub (Inherited from Entity.)
	ClearTags	View code on GitHub (Inherited from Entity.)
	Contains T	(Inherited from Entity.)
	ContainsBehavior T	(Inherited from Entity.)
	ContainsTag	View code on GitHub (Inherited from Entity.)
	Deactivate	(Inherited from Entity.)
	Dispose	View code on GitHub (Overrides Entity Dispose .)
	Get T	Gets a specific component, derived classes can return faster cached values (e.g. Entity2D) View code on GitHub (Inherited from Entity.)
	GetActiveBehaviors	(Inherited from Entity.)
	GetComponentsForSaving	(Inherited from Entity.)
	GetOrDefault T	(Inherited from Entity.)
	GetTags	View code on GitHub (Inherited from Entity.)
	RapidUpdate	View code on GitHub
	RegisterCurrentMusic	View code on GitHub
	RegisterCurrentVideo	View code on GitHub
	Remove T	(Inherited from Entity.)
	RemoveTag	View code on GitHub (Inherited from Entity.)
	Set	View code on GitHub (Inherited from Entity.)
	SetComponents	(Inherited from Entity.)
	Start T	(Inherited from Entity.)
	Stop T	(Inherited from Entity.)
	ToString	View code on GitHub (Inherited from Entity.)
	TryLoadMusicStream

Top

Fields

	Name	Description
	components	(Inherited from Entity.)

Top

Properties

	Name	Description
	IsActive	View code on GitHub (Inherited from Entity.)
	IsPauseable	View code on GitHub (Overrides Entity IsPauseable.)
	MusicVolume	View code on GitHub
	NumberOfComponents	View code on GitHub (Inherited from Entity.)
	UpdatePriority	View code on GitHub (Inherited from Entity.)

Top

Remarks

Tests: DeltaEngine.Multimedia.Tests.SoundDeviceTests

Examples

6 unit tests call DeltaEngine.Multimedia.SoundDevice

Copy to Clipboard Print

[Test]
public void PlayMusicWhileOtherIsPlaying()
{
    var music1 = ContentLoader.Load<Music>("DefaultMusic");
    var music2 = ContentLoader.Load<Music>("DefaultMusicBackwards");
    music1.Play();
    if (IsMockResolver)
        Assert.False(MockMusic.MusicStopCalled);
    music2.Play();
    if (IsMockResolver)
        Assert.True(MockMusic.MusicStopCalled);
}

[Test]
public void PlayMusicWhileOtherIsPlaying()
{
    var music1 = ContentLoader.Load<Music>("DefaultMusic");
    var music2 = ContentLoader.Load<Music>("DefaultMusicBackwards");
    music1.Play();
    if (IsMockResolver)
        Assert.False(MockMusic.MusicStopCalled);
    music2.Play();
    if (IsMockResolver)
        Assert.True(MockMusic.MusicStopCalled);
}

Copy to Clipboard Print

[Test]
public void RunWithVideoAndMusic()
{
    var video = ContentLoader.Load<Video>("DefaultVideo");
    var music = ContentLoader.Load<Music>("DefaultMusic");
    video.Play();
    music.Play();
}

[Test]
public void RunWithVideoAndMusic()
{
    var video = ContentLoader.Load<Video>("DefaultVideo");
    var music = ContentLoader.Load<Music>("DefaultMusic");
    video.Play();
    music.Play();
}

Copy to Clipboard Print

[Test]
public void TestIfPLayingMusic()
{
    var video = ContentLoader.Load<Video>("DefaultVideo");
    video.Play();
    Assert.IsTrue(video.IsPlaying());
    Assert.AreEqual(3.33333325f, video.DurationInSeconds);
    Assert.AreEqual(1.0f, video.PositionInSeconds);
}

[Test]
public void TestIfPLayingMusic()
{
    var video = ContentLoader.Load<Video>("DefaultVideo");
    video.Play();
    Assert.IsTrue(video.IsPlaying());
    Assert.AreEqual(3.33333325f, video.DurationInSeconds);
    Assert.AreEqual(1.0f, video.PositionInSeconds);
}