Game Framework  2021.05.31
ISoundAgentHelper接口 参考

声音代理辅助器接口。 更多...

类 ISoundAgentHelper 继承关系图:
SoundAgentHelperBase DefaultSoundAgentHelper

Public 成员函数

void Play (float fadeInSeconds)
 播放声音。 更多...
 
void Stop (float fadeOutSeconds)
 停止播放声音。 更多...
 
void Pause (float fadeOutSeconds)
 暂停播放声音。 更多...
 
void Resume (float fadeInSeconds)
 恢复播放声音。 更多...
 
void Reset ()
 重置声音代理辅助器。 更多...
 
bool SetSoundAsset (object soundAsset)
 设置声音资源。 更多...
 

属性

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

事件

EventHandler< ResetSoundAgentEventArgsResetSoundAgent
 重置声音代理事件。 更多...
 

详细描述

声音代理辅助器接口。

成员函数说明

◆ Pause()

void Pause ( float  fadeOutSeconds)

暂停播放声音。

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

SoundAgentHelperBase , 以及 DefaultSoundAgentHelper 内被实现.

◆ Play()

void Play ( float  fadeInSeconds)

播放声音。

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

SoundAgentHelperBase , 以及 DefaultSoundAgentHelper 内被实现.

◆ Reset()

void Reset ( )

重置声音代理辅助器。

SoundAgentHelperBase , 以及 DefaultSoundAgentHelper 内被实现.

◆ Resume()

void Resume ( float  fadeInSeconds)

恢复播放声音。

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

SoundAgentHelperBase , 以及 DefaultSoundAgentHelper 内被实现.

◆ SetSoundAsset()

bool SetSoundAsset ( object  soundAsset)

设置声音资源。

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

SoundAgentHelperBase , 以及 DefaultSoundAgentHelper 内被实现.

◆ Stop()

void Stop ( float  fadeOutSeconds)

停止播放声音。

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

SoundAgentHelperBase , 以及 DefaultSoundAgentHelper 内被实现.

属性说明

◆ DopplerLevel

float DopplerLevel
getset

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

◆ IsPlaying

bool IsPlaying
get

获取当前是否正在播放。

◆ Length

float Length
get

获取声音长度。

◆ Loop

bool Loop
getset

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

◆ MaxDistance

float MaxDistance
getset

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

◆ Mute

bool Mute
getset

获取或设置是否静音。

◆ PanStereo

float PanStereo
getset

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

◆ Pitch

float Pitch
getset

获取或设置声音音调。

◆ Priority

int Priority
getset

获取或设置声音优先级。

◆ SpatialBlend

float SpatialBlend
getset

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

◆ Time

float Time
getset

获取或设置播放位置。

◆ Volume

float Volume
getset

获取或设置音量大小。

事件说明

◆ ResetSoundAgent

EventHandler<ResetSoundAgentEventArgs> ResetSoundAgent

重置声音代理事件。