Game Framework  2019.11.26
SoundComponent类 参考

声音组件。 更多...

类 SoundComponent 继承关系图:
GameFrameworkComponent GameFrameworkComponent

Public 成员函数

bool HasSoundGroup (string soundGroupName)
 是否存在指定声音组。 更多...
 
ISoundGroup GetSoundGroup (string soundGroupName)
 获取指定声音组。 更多...
 
ISoundGroup[] GetAllSoundGroups ()
 获取所有声音组。 更多...
 
void GetAllSoundGroups (List< ISoundGroup > results)
 获取所有声音组。 更多...
 
bool AddSoundGroup (string soundGroupName, int soundAgentHelperCount)
 增加声音组。 更多...
 
bool AddSoundGroup (string soundGroupName, bool soundGroupAvoidBeingReplacedBySamePriority, bool soundGroupMute, float soundGroupVolume, int soundAgentHelperCount)
 增加声音组。 更多...
 
int[] GetAllLoadingSoundSerialIds ()
 获取所有正在加载声音的序列编号。 更多...
 
void GetAllLoadingSoundSerialIds (List< int > results)
 获取所有正在加载声音的序列编号。 更多...
 
bool IsLoadingSound (int serialId)
 是否正在加载声音。 更多...
 
int PlaySound (string soundAssetName, string soundGroupName)
 播放声音。 更多...
 
int PlaySound (string soundAssetName, string soundGroupName, int priority)
 播放声音。 更多...
 
int PlaySound (string soundAssetName, string soundGroupName, PlaySoundParams playSoundParams)
 播放声音。 更多...
 
int PlaySound (string soundAssetName, string soundGroupName, Entity bindingEntity)
 播放声音。 更多...
 
int PlaySound (string soundAssetName, string soundGroupName, Vector3 worldPosition)
 播放声音。 更多...
 
int PlaySound (string soundAssetName, string soundGroupName, object userData)
 播放声音。 更多...
 
int PlaySound (string soundAssetName, string soundGroupName, int priority, PlaySoundParams playSoundParams)
 播放声音。 更多...
 
int PlaySound (string soundAssetName, string soundGroupName, int priority, PlaySoundParams playSoundParams, object userData)
 播放声音。 更多...
 
int PlaySound (string soundAssetName, string soundGroupName, int priority, PlaySoundParams playSoundParams, Entity bindingEntity)
 播放声音。 更多...
 
int PlaySound (string soundAssetName, string soundGroupName, int priority, PlaySoundParams playSoundParams, Entity bindingEntity, object userData)
 播放声音。 更多...
 
int PlaySound (string soundAssetName, string soundGroupName, int priority, PlaySoundParams playSoundParams, Vector3 worldPosition)
 播放声音。 更多...
 
int PlaySound (string soundAssetName, string soundGroupName, int priority, PlaySoundParams playSoundParams, Vector3 worldPosition, object userData)
 播放声音。 更多...
 
bool StopSound (int serialId)
 停止播放声音。 更多...
 
bool StopSound (int serialId, float fadeOutSeconds)
 停止播放声音。 更多...
 
void StopAllLoadedSounds ()
 停止所有已加载的声音。 更多...
 
void StopAllLoadedSounds (float fadeOutSeconds)
 停止所有已加载的声音。 更多...
 
void StopAllLoadingSounds ()
 停止所有正在加载的声音。 更多...
 
void PauseSound (int serialId)
 暂停播放声音。 更多...
 
void PauseSound (int serialId, float fadeOutSeconds)
 暂停播放声音。 更多...
 
void ResumeSound (int serialId)
 恢复播放声音。 更多...
 
void ResumeSound (int serialId, float fadeInSeconds)
 恢复播放声音。 更多...
 

Protected 成员函数

override void Awake ()
 游戏框架组件初始化。 更多...
 

属性

int SoundGroupCount [get]
 获取声音组数量。 更多...
 
AudioMixer AudioMixer [get]
 获取声音混响器。 更多...
 

详细描述

声音组件。

成员函数说明

◆ AddSoundGroup() [1/2]

bool AddSoundGroup ( string  soundGroupName,
bool  soundGroupAvoidBeingReplacedBySamePriority,
bool  soundGroupMute,
float  soundGroupVolume,
int  soundAgentHelperCount 
)

增加声音组。

参数
soundGroupName声音组名称。
soundGroupAvoidBeingReplacedBySamePriority声音组中的声音是否避免被同优先级声音替换。
soundGroupMute声音组是否静音。
soundGroupVolume声音组音量。
soundAgentHelperCount声音代理辅助器数量。
返回
是否增加声音组成功。

◆ AddSoundGroup() [2/2]

bool AddSoundGroup ( string  soundGroupName,
int  soundAgentHelperCount 
)

增加声音组。

参数
soundGroupName声音组名称。
soundAgentHelperCount声音代理辅助器数量。
返回
是否增加声音组成功。

◆ Awake()

override void Awake ( )
protectedvirtual

游戏框架组件初始化。

重载 GameFrameworkComponent .

◆ GetAllLoadingSoundSerialIds() [1/2]

int [] GetAllLoadingSoundSerialIds ( )

获取所有正在加载声音的序列编号。

返回
所有正在加载声音的序列编号。

◆ GetAllLoadingSoundSerialIds() [2/2]

void GetAllLoadingSoundSerialIds ( List< int >  results)

获取所有正在加载声音的序列编号。

参数
results所有正在加载声音的序列编号。

◆ GetAllSoundGroups() [1/2]

ISoundGroup [] GetAllSoundGroups ( )

获取所有声音组。

返回
所有声音组。

◆ GetAllSoundGroups() [2/2]

void GetAllSoundGroups ( List< ISoundGroup results)

获取所有声音组。

参数
results所有声音组。

◆ GetSoundGroup()

ISoundGroup GetSoundGroup ( string  soundGroupName)

获取指定声音组。

参数
soundGroupName声音组名称。
返回
要获取的声音组。

◆ HasSoundGroup()

bool HasSoundGroup ( string  soundGroupName)

是否存在指定声音组。

参数
soundGroupName声音组名称。
返回
指定声音组是否存在。

◆ IsLoadingSound()

bool IsLoadingSound ( int  serialId)

是否正在加载声音。

参数
serialId声音序列编号。
返回
是否正在加载声音。

◆ PauseSound() [1/2]

void PauseSound ( int  serialId)

暂停播放声音。

参数
serialId要暂停播放声音的序列编号。

◆ PauseSound() [2/2]

void PauseSound ( int  serialId,
float  fadeOutSeconds 
)

暂停播放声音。

参数
serialId要暂停播放声音的序列编号。
fadeOutSeconds声音淡出时间,以秒为单位。

◆ PlaySound() [1/12]

int PlaySound ( string  soundAssetName,
string  soundGroupName 
)

播放声音。

参数
soundAssetName声音资源名称。
soundGroupName声音组名称。
返回
声音的序列编号。

◆ PlaySound() [2/12]

int PlaySound ( string  soundAssetName,
string  soundGroupName,
Entity  bindingEntity 
)

播放声音。

参数
soundAssetName声音资源名称。
soundGroupName声音组名称。
bindingEntity声音绑定的实体。
返回
声音的序列编号。

◆ PlaySound() [3/12]

int PlaySound ( string  soundAssetName,
string  soundGroupName,
int  priority 
)

播放声音。

参数
soundAssetName声音资源名称。
soundGroupName声音组名称。
priority加载声音资源的优先级。
返回
声音的序列编号。

◆ PlaySound() [4/12]

int PlaySound ( string  soundAssetName,
string  soundGroupName,
int  priority,
PlaySoundParams  playSoundParams 
)

播放声音。

参数
soundAssetName声音资源名称。
soundGroupName声音组名称。
priority加载声音资源的优先级。
playSoundParams播放声音参数。
返回
声音的序列编号。

◆ PlaySound() [5/12]

int PlaySound ( string  soundAssetName,
string  soundGroupName,
int  priority,
PlaySoundParams  playSoundParams,
Entity  bindingEntity 
)

播放声音。

参数
soundAssetName声音资源名称。
soundGroupName声音组名称。
priority加载声音资源的优先级。
playSoundParams播放声音参数。
bindingEntity声音绑定的实体。
返回
声音的序列编号。

◆ PlaySound() [6/12]

int PlaySound ( string  soundAssetName,
string  soundGroupName,
int  priority,
PlaySoundParams  playSoundParams,
Entity  bindingEntity,
object  userData 
)

播放声音。

参数
soundAssetName声音资源名称。
soundGroupName声音组名称。
priority加载声音资源的优先级。
playSoundParams播放声音参数。
bindingEntity声音绑定的实体。
userData用户自定义数据。
返回
声音的序列编号。

◆ PlaySound() [7/12]

int PlaySound ( string  soundAssetName,
string  soundGroupName,
int  priority,
PlaySoundParams  playSoundParams,
object  userData 
)

播放声音。

参数
soundAssetName声音资源名称。
soundGroupName声音组名称。
priority加载声音资源的优先级。
playSoundParams播放声音参数。
userData用户自定义数据。
返回
声音的序列编号。

◆ PlaySound() [8/12]

int PlaySound ( string  soundAssetName,
string  soundGroupName,
int  priority,
PlaySoundParams  playSoundParams,
Vector3  worldPosition 
)

播放声音。

参数
soundAssetName声音资源名称。
soundGroupName声音组名称。
priority加载声音资源的优先级。
playSoundParams播放声音参数。
worldPosition声音所在的世界坐标。
返回
声音的序列编号。

◆ PlaySound() [9/12]

int PlaySound ( string  soundAssetName,
string  soundGroupName,
int  priority,
PlaySoundParams  playSoundParams,
Vector3  worldPosition,
object  userData 
)

播放声音。

参数
soundAssetName声音资源名称。
soundGroupName声音组名称。
priority加载声音资源的优先级。
playSoundParams播放声音参数。
worldPosition声音所在的世界坐标。
userData用户自定义数据。
返回
声音的序列编号。

◆ PlaySound() [10/12]

int PlaySound ( string  soundAssetName,
string  soundGroupName,
object  userData 
)

播放声音。

参数
soundAssetName声音资源名称。
soundGroupName声音组名称。
userData用户自定义数据。
返回
声音的序列编号。

◆ PlaySound() [11/12]

int PlaySound ( string  soundAssetName,
string  soundGroupName,
PlaySoundParams  playSoundParams 
)

播放声音。

参数
soundAssetName声音资源名称。
soundGroupName声音组名称。
playSoundParams播放声音参数。
返回
声音的序列编号。

◆ PlaySound() [12/12]

int PlaySound ( string  soundAssetName,
string  soundGroupName,
Vector3  worldPosition 
)

播放声音。

参数
soundAssetName声音资源名称。
soundGroupName声音组名称。
worldPosition声音所在的世界坐标。
返回
声音的序列编号。

◆ ResumeSound() [1/2]

void ResumeSound ( int  serialId)

恢复播放声音。

参数
serialId要恢复播放声音的序列编号。

◆ ResumeSound() [2/2]

void ResumeSound ( int  serialId,
float  fadeInSeconds 
)

恢复播放声音。

参数
serialId要恢复播放声音的序列编号。
fadeInSeconds声音淡入时间,以秒为单位。

◆ StopAllLoadedSounds() [1/2]

void StopAllLoadedSounds ( )

停止所有已加载的声音。

◆ StopAllLoadedSounds() [2/2]

void StopAllLoadedSounds ( float  fadeOutSeconds)

停止所有已加载的声音。

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

◆ StopAllLoadingSounds()

void StopAllLoadingSounds ( )

停止所有正在加载的声音。

◆ StopSound() [1/2]

bool StopSound ( int  serialId)

停止播放声音。

参数
serialId要停止播放声音的序列编号。
返回
是否停止播放声音成功。

◆ StopSound() [2/2]

bool StopSound ( int  serialId,
float  fadeOutSeconds 
)

停止播放声音。

参数
serialId要停止播放声音的序列编号。
fadeOutSeconds声音淡出时间,以秒为单位。
返回
是否停止播放声音成功。

属性说明

◆ AudioMixer

AudioMixer AudioMixer
get

获取声音混响器。

◆ SoundGroupCount

int SoundGroupCount
get

获取声音组数量。