Game Framework  2021.05.31
ISoundAgent接口 参考

声音代理接口。 更多...

Public 成员函数

void Play ()
 播放声音。 更多...
 
void Play (float fadeInSeconds)
 播放声音。 更多...
 
void Stop ()
 停止播放声音。 更多...
 
void Stop (float fadeOutSeconds)
 停止播放声音。 更多...
 
void Pause ()
 暂停播放声音。 更多...
 
void Pause (float fadeOutSeconds)
 暂停播放声音。 更多...
 
void Resume ()
 恢复播放声音。 更多...
 
void Resume (float fadeInSeconds)
 恢复播放声音。 更多...
 
void Reset ()
 重置声音代理。 更多...
 

属性

ISoundGroup SoundGroup [get]
 获取所在的声音组。 更多...
 
int SerialId [get]
 获取声音的序列编号。 更多...
 
bool IsPlaying [get]
 获取当前是否正在播放。 更多...
 
float Length [get]
 获取声音长度。 更多...
 
float Time [get, set]
 获取或设置播放位置。 更多...
 
bool Mute [get]
 获取或设置是否静音。 更多...
 
bool MuteInSoundGroup [get, set]
 获取或设置在声音组内是否静音。 更多...
 
bool Loop [get, set]
 获取或设置是否循环播放。 更多...
 
int Priority [get, set]
 获取或设置声音优先级。 更多...
 
float Volume [get]
 获取音量大小。 更多...
 
float VolumeInSoundGroup [get, set]
 获取或设置在声音组内音量大小。 更多...
 
float Pitch [get, set]
 获取或设置声音音调。 更多...
 
float PanStereo [get, set]
 获取或设置声音立体声声相。 更多...
 
float SpatialBlend [get, set]
 获取或设置声音空间混合量。 更多...
 
float MaxDistance [get, set]
 获取或设置声音最大距离。 更多...
 
float DopplerLevel [get, set]
 获取或设置声音多普勒等级。 更多...
 
ISoundAgentHelper Helper [get]
 获取声音代理辅助器。 更多...
 

详细描述

声音代理接口。

成员函数说明

◆ Pause() [1/2]

void Pause ( )

暂停播放声音。

◆ Pause() [2/2]

void Pause ( float  fadeOutSeconds)

暂停播放声音。

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

◆ Play() [1/2]

void Play ( )

播放声音。

◆ Play() [2/2]

void Play ( float  fadeInSeconds)

播放声音。

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

◆ Reset()

void Reset ( )

重置声音代理。

◆ Resume() [1/2]

void Resume ( )

恢复播放声音。

◆ Resume() [2/2]

void Resume ( float  fadeInSeconds)

恢复播放声音。

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

◆ Stop() [1/2]

void Stop ( )

停止播放声音。

◆ Stop() [2/2]

void Stop ( float  fadeOutSeconds)

停止播放声音。

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

属性说明

◆ DopplerLevel

float DopplerLevel
getset

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

◆ Helper

ISoundAgentHelper Helper
get

获取声音代理辅助器。

◆ IsPlaying

bool IsPlaying
get

获取当前是否正在播放。

◆ Length

float Length
get

获取声音长度。

◆ Loop

bool Loop
getset

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

◆ MaxDistance

float MaxDistance
getset

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

◆ Mute

bool Mute
get

获取或设置是否静音。

◆ MuteInSoundGroup

bool MuteInSoundGroup
getset

获取或设置在声音组内是否静音。

◆ PanStereo

float PanStereo
getset

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

◆ Pitch

float Pitch
getset

获取或设置声音音调。

◆ Priority

int Priority
getset

获取或设置声音优先级。

◆ SerialId

int SerialId
get

获取声音的序列编号。

◆ SoundGroup

ISoundGroup SoundGroup
get

获取所在的声音组。

◆ SpatialBlend

float SpatialBlend
getset

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

◆ Time

float Time
getset

获取或设置播放位置。

◆ Volume

float Volume
get

获取音量大小。

◆ VolumeInSoundGroup

float VolumeInSoundGroup
getset

获取或设置在声音组内音量大小。