Share via

SoundEffectInstance Class

  • Article

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

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

Syntax

public sealed class SoundEffectInstance : IDisposable

Remarks

You can create a SoundEffectInstance by calling SoundEffect.Play. Initially, the SoundEffectInstance is created as playing, but you can pause it or stop it by calling Pause or Stop.

You can modify the volume, panning, and pitch of the SoundEffectInstance by setting the Volume, Pitch, and Pan properties, or by creating the instance with one of the SoundEffect.Play methods that enables a user to specify the desired properties.

On Zune, a game can have a maximum of 16 total playing SoundEffectInstance instances at one time, combined across all loaded SoundEffect objects. The only limit to the total number of loaded SoundEffectInstance and SoundEffect objects is available memory. However, the user can play only 16 sound effects at one time. Attempts to play a SoundEffectInstance beyond this limit will fail. On Windows, there is no hard limit. Playing too many instances can lead to performance degradation. On Xbox 360, the limit is 300 sound effect instances loaded or playing. Dispose of old instances if you need more. (Unlike other platforms, the Xbox 360 has a limit to how many sound effect instances can exist in memory at one time.)

See Also

Reference

SoundEffect.Play Method
SoundEffectInstance Members
Microsoft.Xna.Framework.Audio Namespace

Platforms

Xbox 360, Windows XP SP2, Windows Vista, Zune