SoundEffectInstance.Stop Method (Boolean)

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

Stops playing a SoundEffectInstance immediately or as authored.

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

Syntax

'Declaration
Public Sub Stop ( _
    immediate As Boolean _
)
public void Stop(
    bool immediate
)

Parameters

  • immediate
    Type: System.Boolean
    Specifies whether to stop playing immediately, or to break out of the loop region and play the release. Specify true to stop playing immediately, or false to break out of the loop region and play the release phase (the remainder of the sound).

Version Information

Silverlight

Supported in: 5

Platforms

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