SoundEffectInstance Class (Microsoft.Xna.Framework.Audio)

Represents a single instance of a playing, paused, or stopped sound.

Namespace: Microsoft.Xna.Framework.Audio
Assembly: MonoGame.Framework (MonoGame.Framework.dll
  • C#
  • VB
  • F#
public class SoundEffectInstance : IDisposable

Syntax for VB is not yet implemented.

Syntax for F# is not yet implemented.

The SoundEffectInstance type exposes the following members.

  Platforms Name Description
IsDisposed Indicates whether the object is disposed. 
IsLooped Enables or Disables whether the SoundEffectInstance should repeat after playback. 
Pan Gets or sets the pan, or speaker balance.. 
Pitch Gets or sets the pitch adjustment. 
State Gets the SoundEffectInstance's current playback state. 
Volume Gets or sets the volume of the SoundEffectInstance. 
  Platforms Name Description
Apply3D(AudioListener, AudioEmitter) Applies 3D positioning to the SoundEffectInstance using a single listener. 
Apply3D(AudioListener[], AudioEmitter) Applies 3D positioning to the SoundEffectInstance using multiple listeners. 
Dispose() Releases the resources held by this SoundEffectInstance. (Implements IDisposable.Dispose().)
Dispose(bool) Releases the resources held by this SoundEffectInstance
Finalize Releases unmanaged resources and performs other cleanup operations before the SoundEffectInstance is reclaimed by garbage collection. (Overrides object.Finalize().)
Pause Pauses playback of a SoundEffectInstance. 
Play Plays or resumes a SoundEffectInstance. 
Resume Resumes playback for a SoundEffectInstance. 
Stop() Immediately stops playing a SoundEffectInstance. 
Stop(bool) Stops playing a SoundEffectInstance, either immediately or as authored. 
SoundEffectInstances are created through SoundEffect.CreateInstance() and used internally by SoundEffect.Play()
Supported in:

 Windows DirectX Desktop
 Linux Desktop
 Windows OpenGL Desktop