Stop
What it does: Stops the sound if it is currently playing and returns an AudioError (see Possible Errors), showing wheter and how stopping the sound failed.
- DOES_NOT_EXIST
- MISSING_WRAPPER
- MISSING_SOURCE
- MISSING_CLIP
How to call it:
SoundName
is thename
we have given the sound we want to stopChild
is theChildType
that we want to call this method on
string soundName = "SoundName";
ChildType child = ChildType.PARENT;
AudioError err = am.Stop(soundName, child);
if (err != AudioError.OK) {
Debug.Log("Stopping sound called: " + soundName + " failed with error id: " + err);
}
else {
Debug.Log("Stopping sound called: " + soundName + " succesfull");
}
Alternatively you can call the methods with less paramters as some of them have default arguments.
string soundName = "SoundName";
AudioError err = am.Stop(soundName);
if (err != AudioError.OK) {
Debug.Log("Stopping sound called: " + soundName + " failed with error id: " + err);
}
else {
Debug.Log("Stopping sound called: " + soundName + " succesfull");
}
When to use it: When you want to stop the given sound, if you restart it later the sound will start anew. So to really only pause it use the Toggle Pause method.
Remarks: See AudioSource.Stop
for more details on what stop does.