/// <summary>
/// 播放声音。
/// </summary>
/// <param name="soundAssetName">声音资源名称。</param>
/// <param name="soundGroupName">声音组名称。</param>
/// <param name="priority">加载声音资源的优先级。</param>
/// <param name="playSoundParams">播放声音参数。</param>
/// <param name="userData">用户自定义数据。</param>
/// <returns>声音的序列编号。</returns>
public int PlaySound(string soundAssetName, string soundGroupName, int priority, PlaySoundParams playSoundParams, object userData)
{
if (m_ResourceManager == null)
{
throw new GameFrameworkException("You must set resource manager first.");
}
if (m_SoundHelper == null)
{
throw new GameFrameworkException("You must set sound helper first.");
}
if (playSoundParams == null)
{
playSoundParams = PlaySoundParams.Create();
}
int serialId = ++m_Serial;
PlaySoundErrorCode?errorCode = null;
string errorMessage = null;
SoundGroup soundGroup = (SoundGroup)GetSoundGroup(soundGroupName);
if (soundGroup == null)
{
errorCode = PlaySoundErrorCode.SoundGroupNotExist;
errorMessage = Utility.Text.Format("Sound group '{0}' is not exist.", soundGroupName);
}
else if (soundGroup.SoundAgentCount <= 0)
{
errorCode = PlaySoundErrorCode.SoundGroupHasNoAgent;
errorMessage = Utility.Text.Format("Sound group '{0}' is have no sound agent.", soundGroupName);
}
if (errorCode.HasValue)
{
if (m_PlaySoundFailureEventHandler != null)
{
PlaySoundFailureEventArgs playSoundFailureEventArgs = PlaySoundFailureEventArgs.Create(serialId, soundAssetName, soundGroupName, playSoundParams, errorCode.Value, errorMessage, userData);
m_PlaySoundFailureEventHandler(this, playSoundFailureEventArgs);
ReferencePool.Release(playSoundFailureEventArgs);
if (playSoundParams.Referenced)
{
ReferencePool.Release(playSoundParams);
}
return(serialId);
}
throw new GameFrameworkException(errorMessage);
}
m_SoundsBeingLoaded.Add(serialId);
m_ResourceManager.LoadAsset(soundAssetName, priority, m_LoadAssetCallbacks, PlaySoundInfo.Create(serialId, soundGroup, playSoundParams, userData));
return(serialId);
}
/// <summary>
/// 初始化播放声音失败事件的新实例。
/// </summary>
/// <param name="e">内部事件。</param>
public PlaySoundFailureEventArgs(GameFramework.Sound.PlaySoundFailureEventArgs e)
{
PlaySoundInfo playSoundInfo = e.UserData as PlaySoundInfo;
SerialId = e.SerialId;
SoundAssetName = e.SoundAssetName;
SoundGroupName = e.SoundGroupName;
PlaySoundParams = e.PlaySoundParams;
BindingEntity = playSoundInfo.BindingEntity;
ErrorCode = e.ErrorCode;
ErrorMessage = e.ErrorMessage;
UserData = playSoundInfo.UserData;
}
private void OnPlaySoundFailure(object sender, GameFramework.Sound.PlaySoundFailureEventArgs e)
{
string logMessage = Utility.Text.Format("Play sound failure, asset name '{0}', sound group name '{1}', error code '{2}', error message '{3}'.", e.SoundAssetName, e.SoundGroupName, e.ErrorCode.ToString(), e.ErrorMessage);
if (e.ErrorCode == PlaySoundErrorCode.IgnoredDueToLowPriority)
{
Log.Info(logMessage);
}
else
{
Log.Warning(logMessage);
}
m_EventComponent.Fire(this, PlaySoundFailureEventArgs.Create(e));
}
/// <summary>
/// 创建播放声音失败事件。
/// </summary>
/// <param name="e">内部事件。</param>
/// <returns>创建的播放声音失败事件。</returns>
public static PlaySoundFailureEventArgs Create(GameFramework.Sound.PlaySoundFailureEventArgs e)
{
PlaySoundInfo playSoundInfo = (PlaySoundInfo)e.UserData;
PlaySoundFailureEventArgs playSoundFailureEventArgs = ReferencePool.Acquire <PlaySoundFailureEventArgs>();
playSoundFailureEventArgs.SerialId = e.SerialId;
playSoundFailureEventArgs.SoundAssetName = e.SoundAssetName;
playSoundFailureEventArgs.SoundGroupName = e.SoundGroupName;
playSoundFailureEventArgs.PlaySoundParams = e.PlaySoundParams;
playSoundFailureEventArgs.BindingEntity = playSoundInfo.BindingEntity;
playSoundFailureEventArgs.ErrorCode = e.ErrorCode;
playSoundFailureEventArgs.ErrorMessage = e.ErrorMessage;
playSoundFailureEventArgs.UserData = playSoundInfo.UserData;
ReferencePool.Release(playSoundInfo);
return(playSoundFailureEventArgs);
}
/// <summary>
/// 填充播放声音失败事件。
/// </summary>
/// <param name="e">内部事件。</param>
/// <returns>播放声音失败事件。</returns>
public PlaySoundFailureEventArgs Fill(GameFramework.Sound.PlaySoundFailureEventArgs e)
{
PlaySoundInfo playSoundInfo = (PlaySoundInfo)e.UserData;
SerialId = e.SerialId;
SoundAssetName = e.SoundAssetName;
SoundGroupName = e.SoundGroupName;
PlaySoundParams = e.PlaySoundParams;
BindingEntity = playSoundInfo.BindingEntity;
ErrorCode = e.ErrorCode;
ErrorMessage = e.ErrorMessage;
UserData = playSoundInfo.UserData;
ReferencePool.Release(playSoundInfo);
return(this);
}
private void OnPlaySoundFailure(object sender, GameFramework.Sound.PlaySoundFailureEventArgs e)
{
string logMessage = string.Format("Play sound failure, asset name '{0}', sound group name '{1}', error code '{2}', error message '{3}'.", e.SoundAssetName, e.SoundGroupName, e.ErrorCode.ToString(), e.ErrorMessage);
if (e.ErrorCode == PlaySoundErrorCode.IgnoredDueToLowPriority)
{
Log.Info(logMessage);
}
else
{
Log.Warning(logMessage);
}
if (m_EnablePlaySoundFailureEvent)
{
m_EventComponent.Fire(this, ReferencePool.Acquire <PlaySoundFailureEventArgs>().Fill(e));
}
}
private void LoadSoundFailureCallback(string soundAssetName, LoadResourceStatus status, string errorMessage, object userData)
{
PlaySoundInfo playSoundInfo = (PlaySoundInfo)userData;
if (playSoundInfo == null)
{
throw new GameFrameworkException("Play sound info is invalid.");
}
if (m_SoundsToReleaseOnLoad.Contains(playSoundInfo.SerialId))
{
m_SoundsToReleaseOnLoad.Remove(playSoundInfo.SerialId);
if (playSoundInfo.PlaySoundParams.Referenced)
{
ReferencePool.Release(playSoundInfo.PlaySoundParams);
}
ReferencePool.Release(playSoundInfo);
return;
}
m_SoundsBeingLoaded.Remove(playSoundInfo.SerialId);
string appendErrorMessage = Utility.Text.Format("Load sound failure, asset name '{0}', status '{1}', error message '{2}'.", soundAssetName, status.ToString(), errorMessage);
if (m_PlaySoundFailureEventHandler != null)
{
PlaySoundFailureEventArgs playSoundFailureEventArgs = PlaySoundFailureEventArgs.Create(playSoundInfo.SerialId, soundAssetName, playSoundInfo.SoundGroup.Name, playSoundInfo.PlaySoundParams, PlaySoundErrorCode.LoadAssetFailure, appendErrorMessage, playSoundInfo.UserData);
m_PlaySoundFailureEventHandler(this, playSoundFailureEventArgs);
ReferencePool.Release(playSoundFailureEventArgs);
if (playSoundInfo.PlaySoundParams.Referenced)
{
ReferencePool.Release(playSoundInfo.PlaySoundParams);
}
ReferencePool.Release(playSoundInfo);
return;
}
ReferencePool.Release(playSoundInfo);
throw new GameFrameworkException(appendErrorMessage);
}
private void LoadAssetSuccessCallback(string soundAssetName, object soundAsset, float duration, object userData)
{
PlaySoundInfo playSoundInfo = (PlaySoundInfo)userData;
if (playSoundInfo == null)
{
throw new GameFrameworkException("Play sound info is invalid.");
}
if (m_SoundsToReleaseOnLoad.Contains(playSoundInfo.SerialId))
{
m_SoundsToReleaseOnLoad.Remove(playSoundInfo.SerialId);
if (playSoundInfo.PlaySoundParams.Referenced)
{
ReferencePool.Release(playSoundInfo.PlaySoundParams);
}
ReferencePool.Release(playSoundInfo);
m_SoundHelper.ReleaseSoundAsset(soundAsset);
return;
}
m_SoundsBeingLoaded.Remove(playSoundInfo.SerialId);
PlaySoundErrorCode?errorCode = null;
ISoundAgent soundAgent = playSoundInfo.SoundGroup.PlaySound(playSoundInfo.SerialId, soundAsset, playSoundInfo.PlaySoundParams, out errorCode);
if (soundAgent != null)
{
if (m_PlaySoundSuccessEventHandler != null)
{
PlaySoundSuccessEventArgs playSoundSuccessEventArgs = PlaySoundSuccessEventArgs.Create(playSoundInfo.SerialId, soundAssetName, soundAgent, duration, playSoundInfo.UserData);
m_PlaySoundSuccessEventHandler(this, playSoundSuccessEventArgs);
ReferencePool.Release(playSoundSuccessEventArgs);
}
if (playSoundInfo.PlaySoundParams.Referenced)
{
ReferencePool.Release(playSoundInfo.PlaySoundParams);
}
ReferencePool.Release(playSoundInfo);
return;
}
m_SoundsToReleaseOnLoad.Remove(playSoundInfo.SerialId);
m_SoundHelper.ReleaseSoundAsset(soundAsset);
string errorMessage = Utility.Text.Format("Sound group '{0}' play sound '{1}' failure.", playSoundInfo.SoundGroup.Name, soundAssetName);
if (m_PlaySoundFailureEventHandler != null)
{
PlaySoundFailureEventArgs playSoundFailureEventArgs = PlaySoundFailureEventArgs.Create(playSoundInfo.SerialId, soundAssetName, playSoundInfo.SoundGroup.Name, playSoundInfo.PlaySoundParams, errorCode.Value, errorMessage, playSoundInfo.UserData);
m_PlaySoundFailureEventHandler(this, playSoundFailureEventArgs);
ReferencePool.Release(playSoundFailureEventArgs);
if (playSoundInfo.PlaySoundParams.Referenced)
{
ReferencePool.Release(playSoundInfo.PlaySoundParams);
}
ReferencePool.Release(playSoundInfo);
return;
}
if (playSoundInfo.PlaySoundParams.Referenced)
{
ReferencePool.Release(playSoundInfo.PlaySoundParams);
}
ReferencePool.Release(playSoundInfo);
throw new GameFrameworkException(errorMessage);
}
