📚 Client/Audio

在沙盘引擎的音频系统中，所有的实例默认是以uuid: string的形式作为存储介质的。

除此之外，也可以根据情况使用tag\id绑定及查询功能。

除此之外，通常使用以下方法进行存储音频实例：

let mySound = Audio.PlaySound(10); //播放声音并储存到变量mySound（返回：字符串UUID）
Audio.StopSound(mySound); //停止播放声音

音频系统主要分为Sound、Music、Natural三个主要类型，并且遵循《沙盘引擎》客户端的音量设置规范。

注意：音频系统中Music是完全独立的，在场景\世界切换后，正在播放的音乐不会被停止，其他类型的音频则会自动停止（Sound\Natural）。

📒 World端音频控制

为了丰富World端的开发实用性，World/Player增加了类似player.PlaySound()等方法映射（为某个联机玩家单独播放声音\音乐等），这些方法的参数及用法与本文档内容基本一致，唯一的区别是可以从World脚本直接为某个玩家播放\停止声音。

需要注意的是，由于World端的服务器同步性，绝大多数World端下的音频控制并不能取得返回数据，这就导致World端音频控制更多只能【播放、暂停、继续、停止】（而不能直接：获取音量、检查声音是否正在播放等），从而并不能完全使用Client/Audio下的所有功能。

如有实际的更多特殊需求，可以考虑使用【自定义函数\数据传输】的方式来扩展。

📒 Function

📘 PlaySound()

function PlaySound( audioID: int, loop: bool = false, volume: float = 1, tag: string = null ): string
/*
	audioID：声音ID
	loop: 是否循环播放
	volume：自身相对音量（0.0~1.0），而非全局控制音量
	tag：设定标签（可空）
*/

📘 PlayPureSound()

function PlayPureSound( audioID: int, loop: bool = false, volume: float = 1, tag: string = null ): string
/*
	audioID：声音ID
	loop: 是否循环播放
	volume：自身相对音量（0.0~1.0），而非全局控制音量
	tag：设定标签（可空）
*/

📘 Play3DSound()

function Play3DSound( audioID: int, pos: Vector, radius: float = 80, loop: bool = false, volume: float = 1, tag: string = null ): string
/*
	audioID：声音ID
	pos：3D坐标
	radius：3D声音范围
	loop: 是否循环播放
	volume：自身相对音量（0.0~1.0），而非全局控制音量
	tag：设定标签（可空）
*/

📘 StopSound()

function StopSound( uuid: string, fadeTime: float = 0 )

📘 StopSoundByID()

function StopSoundByID( audioID: int, fadeTime: float = 0 )

📘 StopSoundByTag()

function StopSoundByTag( tag: string, fadeTime: float = 0 )

PlaySound( 10, false, 1, "TempSound" );
PlaySound( 15, false, 1, "TempSound" );
PlaySound( 18, false, 1, "TempSound" );
 
//以上三个实例全部会被停止播放
StopSoundByTag("TempSound");

📘 StopAllSound()

function StopAllSound( fadeTime: float = 0 )

📘 ExistSound()

function ExistSound( uuid: string ): bool

📘 ExistSoundByID()

function ExistSoundByID( audioID: int ): bool

📘 ExistSoundByTag()

function ExistSoundByTag( tag: string ): bool

📘 PlayMusic()

function PlayMusic( audioID: int, loop: bool = false, fadeTime: float = 3, volume: float = 1 ): string
/*
	audioID：声音ID
	loop：是否循环播放
	fadeTime：过渡时间（秒）
	volume：自身相对音量（0.0~1.0），而非全局控制音量
*/

📘 Play3DMusic()

function Play3DSound( audioID: int, pos: Vector, radius: float = 80, loop: bool = false, fadeTime: float = 3, volume: float = 1 ): string
/*
	audioID：声音ID
	pos：3D坐标
	radius：3D声音范围
	loop：是否循环播放
	fadeTime：过渡时间（秒）
	volume：自身相对音量（0.0~1.0），而非全局控制音量
*/

📘 StopMusic()

function StopMusic( fadeTime: float = 3 )

📘 PauseMusic()

function PauseMusic( fadeTime: float = 3 )

📘 ResumeMusic()

function ResumeMusic( fadeTime: float = 3 )

📘 GetPlayingMusic()

function GetPlayingMusic(): int

📘 PlayNatural()

function PlayNatural( audioID: int, channel: int, loop: bool = true, fadeTime: float = 3 ): string
/*
	audioID：声音ID
	channel：音轨ID（自定义数字）
	loop：是否循环播放
	fadeTime：过渡时间（秒）
*/

📘 StopNatural()

function StopNatural( channel: int, fadeTime: float = 3 )
/*
	channel：音轨ID（指定播放的音轨）
	fadeTime：过渡时间（秒）
*/

Audio.PlayNatural(10, 0); //假设：0号音轨播放的是城市喧嚣背景
Audio.PlayNatural(20, 3); //假设：3号音轨
 
Audio.StopNatural(0); //停止0号音轨的播放声音，3号音轨不会受到影响

📘 StopAllNatural()

function StopAllNatural( fadeTime: float = 3 )

📘 GetTotalVolume()

function GetTotalVolume(): int

📘 GetSoundVolume()

function GetSoundVolume(): int

📘 GetMusicVolume()

function GetMusicVolume(): int

📘 GetNaturalVolume()

function GetNaturalVolume(): int