DynamicSoundEffectInstance Class (Microsoft.Xna.Framework.Audio)

A SoundEffectInstance for which the audio buffer is provided by the game at run time.

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

Syntax for VB is not yet implemented.

Syntax for F# is not yet implemented.

The DynamicSoundEffectInstance type exposes the following members.

  Platforms Name Description
  Platforms Name Description
IsDisposed Indicates whether the object is disposed. (Inherited from SoundEffectInstance.)
IsLooped Enables or Disables whether the SoundEffectInstance should repeat after playback. (Overrides SoundEffectInstance.IsLooped().)
Pan Gets or sets the pan, or speaker balance.. (Inherited from SoundEffectInstance.)
PendingBufferCount Returns the number of audio buffers queued for playback. 
Pitch Gets or sets the pitch adjustment. (Inherited from SoundEffectInstance.)
State Gets the SoundEffectInstance's current playback state. (Overrides SoundEffectInstance.State().)
Volume Gets or sets the volume of the SoundEffectInstance. (Inherited from SoundEffectInstance.)
  Platforms Name Description
Apply3D(AudioListener[], AudioEmitter) Applies 3D positioning to the SoundEffectInstance using multiple listeners. (Inherited from SoundEffectInstance.)
Apply3D(AudioListener, AudioEmitter) Applies 3D positioning to the SoundEffectInstance using a single listener. (Inherited from SoundEffectInstance.)
Dispose() Releases the resources held by this SoundEffectInstance. (Inherited from SoundEffectInstance.)
Dispose(bool) Releases the resources held by this SoundEffectInstance. (Overrides SoundEffectInstance.Dispose().)
Finalize Releases unmanaged resources and performs other cleanup operations before the SoundEffectInstance is reclaimed by garbage collection. (Inherited from SoundEffectInstance.)
GetSampleDuration Returns the duration of an audio buffer of the specified size, based on the settings of this instance. 
GetSampleSizeInBytes Returns the size, in bytes, of a buffer of the specified duration, based on the settings of this instance. 
Pause Pauses playback of the DynamicSoundEffectInstance. (Overrides SoundEffectInstance.Pause().)
Play Plays or resumes the DynamicSoundEffectInstance. (Overrides SoundEffectInstance.Play().)
Resume Resumes playback of the DynamicSoundEffectInstance. (Overrides SoundEffectInstance.Resume().)
Stop() Immediately stops playing the DynamicSoundEffectInstance. (Overrides SoundEffectInstance.Stop().)
Stop(bool) Stops playing the DynamicSoundEffectInstance. If the immediate parameter is false, this call has no effect. (Overrides SoundEffectInstance.Stop().)
SubmitBuffer(Byte[]) Queues an audio buffer for playback. 
SubmitBuffer(Byte[], int, int) Queues an audio buffer for playback. 
  Platforms Name Description
BufferNeeded The event that occurs when the number of queued audio buffers is less than or equal to 2. 
Supported in:

 Windows DirectX Desktop
 Linux Desktop
 Windows OpenGL Desktop