/*! \cond PRIVATE */
/// <summary>
/// Do not call this method. Used internally for ver specific operations. This will set params for "silent" or randomly skipped variations so that a Chained Loop may continue when no audio is played.
/// </summary>
public void DoNextChain(float volumePercentage, float?pitch, Transform transActor, bool attach)
{
EnableUpdater(false);
SetPlaySoundParams(ParentGroup.GameObjectName, volumePercentage, volumePercentage, pitch, transActor, attach, 0f, null, true, false);
VariationUpdater.MaybeChain();
VariationUpdater.StopWaitingForFinish();
}
/// <summary>
/// This method allows you to stop the audio being played by this Variation.
/// </summary>
/// <param name="stopEndDetection">Do not ever pass this in.</param>
/// <param name="skipLinked">Do not ever pass this in.</param>
public void Stop(bool stopEndDetection = false, bool skipLinked = false)
{
var waitStopped = false;
if (stopEndDetection || _isWaitingForDelay)
{
if (VariationUpdater != null)
{
VariationUpdater.StopWaitingForFinish(); // turn off the chain loop endless repeat
waitStopped = true;
}
}
if (!skipLinked)
{
PlayEndLinkedGroups();
}
_objectToFollow = null;
_objectToTriggerFrom = null;
ParentGroup.RemoveActiveAudioSourceId(InstanceId);
MasterAudio.StopTrackingOcclusionForSource(GameObj);
VarAudio.Stop();
VarAudio.time = 0f;
if (VariationUpdater != null)
{
VariationUpdater.StopFollowing();
VariationUpdater.StopFading();
}
if (!waitStopped)
{
if (VariationUpdater != null)
{
VariationUpdater.StopWaitingForFinish();
}
}
_playSndParam.IsPlaying = false;
if (SoundFinished != null)
{
var willAbort = _previousSoundFinishedFrame == AudioUtil.FrameCount;
_previousSoundFinishedFrame = AudioUtil.FrameCount;
if (!willAbort)
{
SoundFinished(); // parameters aren't used
}
SoundFinished = null; // clear it out so subscribers don't have to clean up
}
Trans.localPosition = Vector3.zero;
MaybeUnloadClip();
}
/// <summary>
/// This method allows you to stop the audio being played by this Variation.
/// </summary>
public void Stop(bool stopEndDetection = false)
{
var waitStopped = false;
if (stopEndDetection || _isWaitingForDelay)
{
if (VariationUpdater != null)
{
VariationUpdater.StopWaitingForFinish(); // turn off the chain loop endless repeat
waitStopped = true;
}
}
_objectToFollow = null;
_objectToTriggerFrom = null;
ParentGroup.RemoveActiveAudioSourceId(InstanceId);
VarAudio.Stop();
VarAudio.time = 0f;
if (VariationUpdater != null)
{
VariationUpdater.StopFollowing();
VariationUpdater.StopFading();
}
if (!waitStopped)
{
if (VariationUpdater != null)
{
VariationUpdater.StopWaitingForFinish();
}
}
_playSndParam.IsPlaying = false;
if (SoundFinished != null)
{
var willAbort = _previousSoundFinishedFrame == Time.frameCount;
_previousSoundFinishedFrame = Time.frameCount;
if (!willAbort)
{
SoundFinished(); // parameters aren't used
}
SoundFinished = null; // clear it out so subscribers don't have to clean up
}
MaybeUnloadClip();
}
/// <summary>
/// This method allows you to pause the audio being played by this Variation. This is automatically called by MasterAudio.PauseSoundGroup and MasterAudio.PauseBus.
/// </summary>
public void Pause()
{
if (_audioOriginsThatCanUnload.Contains(audLocation) && !MasterAudio.Instance.resourceClipsPauseDoNotUnload)
{
Stop();
return;
}
VarAudio.Pause();
curFadeMode = FadeMode.None;
if (VariationUpdater != null)
{
VariationUpdater.StopWaitingForFinish(); // necessary so that the clip can be unpaused.
}
}
/// <summary>
/// This method allows you to pause the audio being played by this Variation. This is automatically called by MasterAudio.PauseSoundGroup and MasterAudio.PauseBus.
/// </summary>
public void Pause()
{
if (audLocation == MasterAudio.AudioLocation.ResourceFile && !MasterAudio.Instance.resourceClipsPauseDoNotUnload)
{
Stop();
return;
}
VarAudio.Pause();
curFadeMode = FadeMode.None;
if (VariationUpdater != null)
{
VariationUpdater.StopWaitingForFinish(); // necessary so that the clip can be unpaused.
}
MaybeUnloadClip();
}
/// <summary>
/// This method allows you to stop the audio being played by this Variation.
/// </summary>
/// <param name="stopEndDetection">Do not ever pass this in.</param>
/// <param name="skipLinked">Do not ever pass this in.</param>
public void Stop(bool stopEndDetection = false, bool skipLinked = false)
{
if (IsPlaying && !_isStopRequested)
{
_isStopRequested = true;
}
_isPaused = false;
var waitStopped = false;
if (stopEndDetection)
{
if (VariationUpdater != null)
{
VariationUpdater.StopWaitingForFinish(); // turn off the chain loop endless repeat
waitStopped = true;
}
}
if (!skipLinked)
{
PlayEndLinkedGroups();
}
_objectToFollow = null;
_objectToTriggerFrom = null;
VarAudio.pitch = OriginalPitch;
ParentGroup.RemoveActiveAudioSourceId(InstanceId);
MasterAudio.StopTrackingOcclusionForSource(GameObj);
if (VariationUpdater != null)
{
VariationUpdater.StopFollowing();
VariationUpdater.StopFading();
VariationUpdater.StopPitchGliding();
}
if (!waitStopped)
{
if (VariationUpdater != null)
{
VariationUpdater.StopWaitingForFinish();
}
}
_playSndParam.IsPlaying = false;
if (SoundFinished != null)
{
var willAbort = _previousSoundFinishedFrame == AudioUtil.FrameCount;
_previousSoundFinishedFrame = AudioUtil.FrameCount;
if (!willAbort)
{
SoundFinished(); // parameters aren't used
}
MaybeCleanupFinishedDelegate();
}
Trans.localPosition = Vector3.zero;
switch (_loadStatus)
{
case MasterAudio.VariationLoadStatus.None:
case MasterAudio.VariationLoadStatus.Loaded:
case MasterAudio.VariationLoadStatus.LoadFailed:
StopEndCleanup();
break;
case MasterAudio.VariationLoadStatus.Loading:
if (!_isUnloadAddressableCoroutineRunning)
{
StartCoroutine(WaitForLoadToUnloadClipAndDeactivate());
}
break;
}
}
/// <summary>
/// This method allows you to stop the audio being played by this Variation.
/// </summary>
/// <param name="stopEndDetection">Do not ever pass this in.</param>
/// <param name="skipLinked">Do not ever pass this in.</param>
public void Stop(bool stopEndDetection = false, bool skipLinked = false)
{
_isPaused = false;
var waitStopped = false;
if (stopEndDetection)
{
if (VariationUpdater != null)
{
VariationUpdater.StopWaitingForFinish(); // turn off the chain loop endless repeat
waitStopped = true;
}
}
if (!skipLinked)
{
PlayEndLinkedGroups();
}
_objectToFollow = null;
_objectToTriggerFrom = null;
VarAudio.pitch = OriginalPitch;
ParentGroup.RemoveActiveAudioSourceId(InstanceId);
MasterAudio.StopTrackingOcclusionForSource(GameObj);
VarAudio.Stop();
VarAudio.time = 0f;
if (VariationUpdater != null)
{
VariationUpdater.StopFollowing();
VariationUpdater.StopFading();
VariationUpdater.StopPitchGliding();
}
if (!waitStopped)
{
if (VariationUpdater != null)
{
VariationUpdater.StopWaitingForFinish();
}
}
_playSndParam.IsPlaying = false;
if (SoundFinished != null)
{
var willAbort = _previousSoundFinishedFrame == AudioUtil.FrameCount;
_previousSoundFinishedFrame = AudioUtil.FrameCount;
if (!willAbort)
{
SoundFinished(); // parameters aren't used
}
MaybeCleanupFinishedDelegate();
}
Trans.localPosition = Vector3.zero;
MaybeUnloadClip();
if (!MasterAudio.IsWarming) // avoids breaking the Variation if warming sound is "Internet file".
{
DTMonoHelper.SetActive(GameObj, false);
}
}
