AudioController.Stop Method (String, Single)

Audio Toolkit

Collapse image Expand Image Copy image CopyHover image
Stops all playing audio items with name audioID with a fade-out.

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

Syntax

C#
public static bool Stop(
	string audioID,
	float fadeOutLength
)

Parameters

audioID
Type: System..::..String
The audio ID.
fadeOutLength
Type: System..::..Single
The fade out time. If a negative value is specified, the subitem's FadeOut value is taken.

Return Value

Type: Boolean
Return true if any audio was stopped.

See Also