SoundEffectInstance Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Provides a single playing, paused, or stopped instance of a SoundEffect sound.

Inheritance Hierarchy

System.Object
Microsoft.Xna.Framework.Audio.SoundEffectInstance

Namespace: Microsoft.Xna.Framework.Audio
Assembly: Microsoft.Xna.Framework (in Microsoft.Xna.Framework.dll)

'Declaration
Public Class SoundEffectInstance

public class SoundEffectInstance

The SoundEffectInstance type exposes the following members.

	Name	Description
	IsDisposed	Gets a value that indicates whether the object is disposed.
	IsLooped	Gets a value that indicates whether looping is enabled for the SoundEffectInstance.
	Pan	Gets or sets the panning for the SoundEffectInstance.
	Pitch	Gets or sets the pitch adjustment for the SoundEffectInstance.
	State	Gets the current state (playing, paused, or stopped) of the SoundEffectInstance.
	Volume	Gets or sets the volume of the SoundEffectInstance.

Top

	Name	Description
	Dispose()	Releases unmanaged resources held by this SoundEffectInstance.
	Dispose(Boolean)	Releases the unmanaged resources held by this SoundEffectInstance, and optionally releases the managed resources.
	Pause	Pauses the SoundEffectInstance.
	Play	Plays or resumes playing the SoundEffectInstance.
	Resume	Resumes playback of the SoundEffectInstance.
	Stop()	Immediately stops playing the SoundEffectInstance.
	Stop(Boolean)	Stops playing a SoundEffectInstance immediately or as authored.

Top

Supported in: 5

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.