Game Framework  2021.05.31
Public 成员函数 | 属性 | 事件 | 所有成员列表
SoundAgentHelperBase类 参考abstract

声音代理辅助器基类。 更多...

类 SoundAgentHelperBase 继承关系图:
ISoundAgentHelper DefaultSoundAgentHelper

Public 成员函数

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

属性

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]
 获取或设置声音多普勒等级。 更多...
 

事件

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

详细描述

声音代理辅助器基类。

成员函数说明

◆ Pause()

abstract void Pause ( float  fadeOutSeconds)
pure virtual

暂停播放声音。

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

实现了 ISoundAgentHelper.

在 DefaultSoundAgentHelper 内被实现.

◆ Play()

abstract void Play ( float  fadeInSeconds)
pure virtual

播放声音。

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

实现了 ISoundAgentHelper.

在 DefaultSoundAgentHelper 内被实现.

◆ Reset()

abstract void Reset ( )
pure virtual

重置声音代理辅助器。

实现了 ISoundAgentHelper.

在 DefaultSoundAgentHelper 内被实现.

◆ Resume()

abstract void Resume ( float  fadeInSeconds)
pure virtual

恢复播放声音。

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

实现了 ISoundAgentHelper.

在 DefaultSoundAgentHelper 内被实现.

◆ SetBindingEntity()

abstract void SetBindingEntity ( Entity  bindingEntity)
pure virtual

设置声音绑定的实体。

参数
bindingEntity声音绑定的实体。

在 DefaultSoundAgentHelper 内被实现.

◆ SetSoundAsset()

abstract bool SetSoundAsset ( object  soundAsset)
pure virtual

设置声音资源。

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

实现了 ISoundAgentHelper.

在 DefaultSoundAgentHelper 内被实现.

◆ SetWorldPosition()

abstract void SetWorldPosition ( Vector3  worldPosition)
pure virtual

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

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

在 DefaultSoundAgentHelper 内被实现.

◆ Stop()

abstract void Stop ( float  fadeOutSeconds)
pure virtual

停止播放声音。

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

实现了 ISoundAgentHelper.

在 DefaultSoundAgentHelper 内被实现.

属性说明

◆ AudioMixerGroup

abstract AudioMixerGroup AudioMixerGroup
getset

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

◆ DopplerLevel

abstract float DopplerLevel
getset

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

◆ IsPlaying

abstract bool IsPlaying
get

获取当前是否正在播放。

◆ Length

abstract float Length
get

获取声音长度。

◆ Loop

abstract bool Loop
getset

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

◆ MaxDistance

abstract float MaxDistance
getset

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

◆ Mute

abstract bool Mute
getset

获取或设置是否静音。

◆ PanStereo

abstract float PanStereo
getset

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

◆ Pitch

abstract float Pitch
getset

获取或设置声音音调。

◆ Priority

abstract int Priority
getset

获取或设置声音优先级。

◆ SpatialBlend

abstract float SpatialBlend
getset

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

◆ Time

abstract float Time
getset

获取或设置播放位置。

◆ Volume

abstract float Volume
getset

获取或设置音量大小。

事件说明

◆ ResetSoundAgent

abstract EventHandler<ResetSoundAgentEventArgs> ResetSoundAgent

重置声音代理事件。