SoundEffectInstance.Stop Method (Microsoft.Xna.Framework.Audio)

Stops playing a SoundEffectInstance, either immediately or as authored.

Namespace: Microsoft.Xna.Framework.Audio
Assembly: MonoGame.Framework (MonoGame.Framework.dll 3.8.0.1082)
  • C#
  • VB
  • F#
public void Stop(
	bool immediate
)

Syntax for VB is not yet implemented.

Syntax for F# is not yet implemented.

Parameters

immediate
Type: System.Boolean
Determined whether the sound stops immediately, or after playing its release phase and/or transitions.
Stopping a sound with the immediate argument set to false will allow it to play any release phases, such as fade, before coming to a stop.
Supported in:

    
 Windows DirectX Desktop
    
 Linux Desktop
    
 Windows OpenGL Desktop
    
 Web