Sound Class

Delta Engine Documentation

Provides a way to load and play simple sound effects by creating a SoundInstance per play. View code on GitHub

Inheritance Hierarchy

System Object
  DeltaEngine.Content ContentData
    DeltaEngine.Multimedia Sound
      DeltaEngine.Content.Mocks MockSound
      DeltaEngine.Multimedia.BaseOpenAL OpenALSound
      DeltaEngine.Multimedia.SharpDX XAudioSound
      DeltaEngine.Multimedia.SlimDX XAudioSound
      DeltaEngine.Multimedia.Xna XnaSound

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 Sound : ContentData

public abstract class Sound : ContentData

Public MustInherit Class Sound 
	Inherits ContentData

Public MustInherit Class Sound 
	Inherits ContentData

public ref class Sound abstract : public ContentData

public ref class Sound abstract : public ContentData

[<AbstractClassAttribute>]
type Sound =  
    class 
        inherit ContentData 
    end

[<AbstractClassAttribute>]
type Sound =  
    class 
        inherit ContentData 
    end

The Sound type exposes the following members.

Constructors

	Name	Description
	Sound	Initializes a new instance of the Sound class

Top

Methods

	Name	Description
	CreateChannel
	CreateDefault	(Inherited from ContentData.)
	CreateSoundInstance	View code on GitHub
	Dispose	View code on GitHub (Inherited from ContentData.)
	DisposeData	(Overrides ContentData DisposeData .)
	InternalCreateDefault	View code on GitHub (Inherited from ContentData.)
	IsPlaying	View code on GitHub
	LoadData	(Inherited from ContentData.)
	Play	View code on GitHub
	Play(Single, Single)
	PlayInstance
	RemoveChannel
	StopAll	View code on GitHub
	StopInstance	View code on GitHub
	ToString	View code on GitHub (Inherited from ContentData.)

Top

Fields

	Name	Description
	ContentChanged	(Inherited from ContentData.)

Top

Properties

	Name	Description
	AllowCreationIfContentNotFound	(Overrides ContentData AllowCreationIfContentNotFound.)
	IsAnyInstancePlaying	View code on GitHub
	IsDisposed	View code on GitHub (Inherited from ContentData.)
	LengthInSeconds
	MetaData	(Inherited from ContentData.)
	Name	View code on GitHub (Inherited from ContentData.)
	NumberOfInstances	View code on GitHub
	NumberOfPlayingInstances	View code on GitHub

Top

Events

	Name	Description
	OnPlay
	OnStop

Top

Remarks

Tests: DeltaEngine.Multimedia.Tests.SoundDeviceTests

Examples

25 unit tests call DeltaEngine.Multimedia.Sound

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);
}