documentation.help

AudioObject.Stop Method (Single, Single)

From Audio Toolkit

previous page next page
Collapse image Expand Image Copy image CopyHover image
Stops a playing audio with fade-out at a specified time.

Namespace: (Default Namespace)
Assembly: AudioToolkit (in AudioToolkit.dll) Version: 8.0.0.0 (8.0.0.0)

Syntax

C#
public void Stop(
	float fadeOutLength,
	float startToFadeTime
)

Parameters

fadeOutLength
Type: System..::..Single
The fade time in seconds. If a negative value is specified, the fade out as specified in the corresponding FadeOut is used
startToFadeTime
Type: System..::..Single
Fade out starts after startToFadeTime seconds have passed

Remarks

If the audio is already fading out the requested fade-out is combined with the existing one.

See Also

previous page start next page