Game Framework  2021.05.31
DefaultSoundAgentHelper类 参考

默认声音代理辅助器。 更多...

类 DefaultSoundAgentHelper 继承关系图:
SoundAgentHelperBase ISoundAgentHelper

Public 成员函数

override void Play (float fadeInSeconds)
 播放声音。 更多...
 
override void Stop (float fadeOutSeconds)
 停止播放声音。 更多...
 
override void Pause (float fadeOutSeconds)
 暂停播放声音。 更多...
 
override void Resume (float fadeInSeconds)
 恢复播放声音。 更多...
 
override void Reset ()
 重置声音代理辅助器。 更多...
 
override bool SetSoundAsset (object soundAsset)
 设置声音资源。 更多...
 
override void SetBindingEntity (Entity bindingEntity)
 设置声音绑定的实体。 更多...
 
override void SetWorldPosition (Vector3 worldPosition)
 设置声音所在的世界坐标。 更多...
 

属性

override bool IsPlaying [get]
 获取当前是否正在播放。 更多...
 
override float? Length [get]
 获取声音长度。 更多...
 
override float Time [get, set]
 获取或设置播放位置。 更多...
 
override bool Mute [get, set]
 获取或设置是否静音。 更多...
 
override bool Loop [get, set]
 获取或设置是否循环播放。 更多...
 
override int Priority [get, set]
 获取或设置声音优先级。 更多...
 
override float Volume [get, set]
 获取或设置音量大小。 更多...
 
override float Pitch [get, set]
 获取或设置声音音调。 更多...
 
override float PanStereo [get, set]
 获取或设置声音立体声声相。 更多...
 
override float SpatialBlend [get, set]
 获取或设置声音空间混合量。 更多...
 
override float MaxDistance [get, set]
 获取或设置声音最大距离。 更多...
 
override float DopplerLevel [get, set]
 获取或设置声音多普勒等级。 更多...
 
override AudioMixerGroup AudioMixerGroup [get, set]
 获取或设置声音代理辅助器所在的混音组。 更多...
 
override EventHandler< ResetSoundAgentEventArgsResetSoundAgent
 重置声音代理事件。 更多...
 
- 属性 继承自 SoundAgentHelperBase
abstract bool IsPlaying [get]
 获取当前是否正在播放。 更多...
 
abstract float Length [get]
 获取声音长度。 更多...
 
abstract float Time [get, set]
 获取或设置播放位置。 更多...
 
abstract bool Mute [get, set]
 获取或设置是否静音。 更多...
 
abstract bool Loop [get, set]
 获取或设置是否循环播放。 更多...
 
abstract int Priority [get, set]
 获取或设置声音优先级。 更多...
 
abstract float Volume [get, set]
 获取或设置音量大小。 更多...
 
abstract float Pitch [get, set]
 获取或设置声音音调。 更多...
 
abstract float PanStereo [get, set]
 获取或设置声音立体声声相。 更多...
 
abstract float SpatialBlend [get, set]
 获取或设置声音空间混合量。 更多...
 
abstract float MaxDistance [get, set]
 获取或设置声音最大距离。 更多...
 
abstract float DopplerLevel [get, set]
 获取或设置声音多普勒等级。 更多...
 
abstract AudioMixerGroup AudioMixerGroup [get, set]
 获取或设置声音代理辅助器所在的混音组。 更多...
 
- 属性 继承自 ISoundAgentHelper
bool IsPlaying [get]
 获取当前是否正在播放。 更多...
 
float Length [get]
 获取声音长度。 更多...
 
float Time [get, set]
 获取或设置播放位置。 更多...
 
bool Mute [get, set]
 获取或设置是否静音。 更多...
 
bool Loop [get, set]
 获取或设置是否循环播放。 更多...
 
int Priority [get, set]
 获取或设置声音优先级。 更多...
 
float Volume [get, set]
 获取或设置音量大小。 更多...
 
float Pitch [get, set]
 获取或设置声音音调。 更多...
 
float PanStereo [get, set]
 获取或设置声音立体声声相。 更多...
 
float SpatialBlend [get, set]
 获取或设置声音空间混合量。 更多...
 
float MaxDistance [get, set]
 获取或设置声音最大距离。 更多...
 
float DopplerLevel [get, set]
 获取或设置声音多普勒等级。 更多...
 

额外继承的成员函数

- 事件 继承自 SoundAgentHelperBase
abstract EventHandler< ResetSoundAgentEventArgsResetSoundAgent
 重置声音代理事件。 更多...
 
- 事件 继承自 ISoundAgentHelper
EventHandler< ResetSoundAgentEventArgsResetSoundAgent
 重置声音代理事件。 更多...
 

详细描述

默认声音代理辅助器。

成员函数说明

◆ Pause()

override void Pause ( float  fadeOutSeconds)
virtual

暂停播放声音。

参数
fadeOutSeconds声音淡出时间,以秒为单位。

实现了 SoundAgentHelperBase.

◆ Play()

override void Play ( float  fadeInSeconds)
virtual

播放声音。

参数
fadeInSeconds声音淡入时间,以秒为单位。

实现了 SoundAgentHelperBase.

◆ Reset()

override void Reset ( )
virtual

重置声音代理辅助器。

实现了 SoundAgentHelperBase.

◆ Resume()

override void Resume ( float  fadeInSeconds)
virtual

恢复播放声音。

参数
fadeInSeconds声音淡入时间,以秒为单位。

实现了 SoundAgentHelperBase.

◆ SetBindingEntity()

override void SetBindingEntity ( Entity  bindingEntity)
virtual

设置声音绑定的实体。

参数
bindingEntity声音绑定的实体。

实现了 SoundAgentHelperBase.

◆ SetSoundAsset()

override bool SetSoundAsset ( object  soundAsset)
virtual

设置声音资源。

参数
soundAsset声音资源。
返回
是否设置声音资源成功。

实现了 SoundAgentHelperBase.

◆ SetWorldPosition()

override void SetWorldPosition ( Vector3  worldPosition)
virtual

设置声音所在的世界坐标。

参数
worldPosition声音所在的世界坐标。

实现了 SoundAgentHelperBase.

◆ Stop()

override void Stop ( float  fadeOutSeconds)
virtual

停止播放声音。

参数
fadeOutSeconds声音淡出时间,以秒为单位。

实现了 SoundAgentHelperBase.

属性说明

◆ AudioMixerGroup

override AudioMixerGroup AudioMixerGroup
getset

获取或设置声音代理辅助器所在的混音组。

◆ DopplerLevel

override float DopplerLevel
getset

获取或设置声音多普勒等级。

◆ IsPlaying

override bool IsPlaying
get

获取当前是否正在播放。

◆ Length

override float? Length
get

获取声音长度。

◆ Loop

override bool Loop
getset

获取或设置是否循环播放。

◆ MaxDistance

override float MaxDistance
getset

获取或设置声音最大距离。

◆ Mute

override bool Mute
getset

获取或设置是否静音。

◆ PanStereo

override float PanStereo
getset

获取或设置声音立体声声相。

◆ Pitch

override float Pitch
getset

获取或设置声音音调。

◆ Priority

override int Priority
getset

获取或设置声音优先级。

◆ ResetSoundAgent

override EventHandler<ResetSoundAgentEventArgs> ResetSoundAgent
addremove

重置声音代理事件。

◆ SpatialBlend

override float SpatialBlend
getset

获取或设置声音空间混合量。

◆ Time

override float Time
getset

获取或设置播放位置。

◆ Volume

override float Volume
getset

获取或设置音量大小。