函数
function IXAudioEngine	SetPlayerType (type) end

function IXAudioEngine	PreloadBackgroundMusic (filePath) end

function IXAudioEngine	PlayBackgroundMusic (filePath, loop) end

function IXAudioEngine	GetBackgroundMusicDuration () end

function IXAudioEngine	GetBackgroundMusicCurrentPosition () end

function IXAudioEngine	SetBackgroundMusicCurrentPosition (position) end

function IXAudioEngine	StopBackgroundMusic (releaseData) end

function IXAudioEngine	PauseBackgroundMusic () end

function IXAudioEngine	ResumeBackgroundMusic () end

function IXAudioEngine	RewindBackgroundMusic () end

function IXAudioEngine	IsBackgroundMusicPlaying () end

function IXAudioEngine	GetBackgroundMusicVolume () end

function IXAudioEngine	SetBackgroundMusicVolume (volume) end

function IXAudioEngine	PreloadEffect (filePath) end

function IXAudioEngine	GetEffectsVolume () end

function IXAudioEngine	SetEffectsVolume (volume) end

function IXAudioEngine	PlayEffect (filePath, loop, gain) end

function IXAudioEngine	PauseEffect (soundId) end

function IXAudioEngine	PauseAllEffects () end

function IXAudioEngine	ResumeEffect (soundId) end

function IXAudioEngine	ResumeAllEffects () end

function IXAudioEngine	StopEffect (soundId) end

function IXAudioEngine	UnloadEffect (filePath) end

function IXAudioEngine	StopAllEffects () end

function IXAudioEngine	CreateAudio (szfileName, loop, volume, sourceRelative) end

function IXAudioEngine	RemoveAudio (source) end

function IXAudioEngine	SetAudioListener (Location, Up, Front) end

function IXAudioEngine	GetOrCreateAudioListener () end

function IXAudioEngine	PreloadAudio (filePath, callback) end

function IXAudioEngine	SetEffectMaxNum (n) end

function IXAudioEngine	GetEffectMaxNum () end

变量
	IXAudioEngine = {}

IXAudioEngine	XAudioEnginePlayerTypeUninit = 0

IXAudioEngine	XAudioEnginePlayerTypeOpenAL = 0

IXAudioEngine	XAudioEnginePlayerTypeUser = 0

函数说明

◆ CreateAudio()

function IXAudioEngine CreateAudio	(	szfileName	,
		loop	,
		volume	,
		sourceRelative
	)

创建一个3D音频源

参数

szfileName	string 音频资源名称
loop	boolean 是否循环播放
volume	number 音量
sourceRelative	boolean

返回: IXAudioSource 音频源指针，创建失败返回NULL

◆ GetBackgroundMusicCurrentPosition()

function IXAudioEngine GetBackgroundMusicCurrentPosition ( )

获取背景音乐当前播放进度

返回: number 毫秒

◆ GetBackgroundMusicDuration()

function IXAudioEngine GetBackgroundMusicDuration ( )

获取背景音乐总时长

返回: number 毫秒

◆ GetBackgroundMusicVolume()

function IXAudioEngine GetBackgroundMusicVolume ( )

获取背景音乐音量

返回: number 0～1

◆ GetEffectMaxNum()

function IXAudioEngine GetEffectMaxNum ( )

IXAudioEngine_GetEffectMaxNum00

返回: number

◆ GetEffectsVolume()

function IXAudioEngine GetEffectsVolume ( )

获取音效音量

返回: number 0～1

◆ GetOrCreateAudioListener()

function IXAudioEngine GetOrCreateAudioListener ( )

获取音频聆听者

返回: IXAudioListener 音频聆听者

◆ IsBackgroundMusicPlaying()

function IXAudioEngine IsBackgroundMusicPlaying ( )

背景音乐是否正在播放

返回: boolean

◆ PauseAllEffects()

function IXAudioEngine PauseAllEffects ( )

暂停所有音效

返回: void

◆ PauseBackgroundMusic()

function IXAudioEngine PauseBackgroundMusic ( )

暂停背景音乐播放

返回: void

◆ PauseEffect()

function IXAudioEngine PauseEffect ( soundId )

暂停音效播放

参数

soundId number 音效ID

返回: void

◆ PlayBackgroundMusic()

function IXAudioEngine PlayBackgroundMusic	(	filePath	,
		loop
	)

播放背景音乐

参数

filePath	string 文件路径
loop	boolean 是否循环播放

返回: void

◆ PlayEffect()

function IXAudioEngine PlayEffect	(	filePath	,
		loop	,
		gain
	)

播放音效

参数

filePath	string 音效文件路径
loop	boolean 是否循环播放
gain	number 音量0～1

返回: number 音效ID

◆ PreloadAudio()

function IXAudioEngine PreloadAudio	(	filePath	,
		callback
	)

@manual xelua_XEngine_IXAudioEngine_PreloadAudio_manual IXAudioEngine_PreloadAudio_manual

参数

filePath	string
callback	std::function<void(xbool, std::string)>

返回: boolean

◆ PreloadBackgroundMusic()

function IXAudioEngine PreloadBackgroundMusic ( filePath )

IXAudioEngine_PreloadBackgroundMusic00

参数

filePath string

返回: void

◆ PreloadEffect()

function IXAudioEngine PreloadEffect ( filePath )

IXAudioEngine_PreloadEffect00

参数

filePath string

返回: void

◆ RemoveAudio()

function IXAudioEngine RemoveAudio ( source )

删除一个3D音频源，但并不释放音频缓存，音频缓存可用于快速加载播放

参数

source IXAudioSource 音频资源

返回: void

◆ ResumeAllEffects()

function IXAudioEngine ResumeAllEffects ( )

恢复所有音效播放

返回: void

◆ ResumeBackgroundMusic()

function IXAudioEngine ResumeBackgroundMusic ( )

恢复背景音乐播放

返回: void

◆ ResumeEffect()

function IXAudioEngine ResumeEffect ( soundId )

恢复音效播放

参数

soundId number 音效ID

返回: void

◆ RewindBackgroundMusic()

function IXAudioEngine RewindBackgroundMusic ( )

回滚背景音乐

返回: void

◆ SetAudioListener()

function IXAudioEngine SetAudioListener	(	Location	,
		Up	,
		Front
	)

设置3D音频聆听者

参数

Location	XVECTOR3
Up	XVECTOR3
Front	XVECTOR3

返回: void

◆ SetBackgroundMusicCurrentPosition()

function IXAudioEngine SetBackgroundMusicCurrentPosition ( position )

设置背景音乐当前播放进度

参数

position number 毫秒

返回: void

◆ SetBackgroundMusicVolume()

function IXAudioEngine SetBackgroundMusicVolume ( volume )

设置背景音乐播放音量

参数

volume number 0～1

返回: void

◆ SetEffectMaxNum()

function IXAudioEngine SetEffectMaxNum ( n )

IXAudioEngine_SetEffectMaxNum00

参数

n number

返回: void

◆ SetEffectsVolume()

function IXAudioEngine SetEffectsVolume ( volume )

设置音效音量 0～1

参数

volume number

返回: void

◆ SetPlayerType()

function IXAudioEngine SetPlayerType ( type )

IXAudioEngine_SetPlayerType00

参数

type number

返回: void

◆ StopAllEffects()

function IXAudioEngine StopAllEffects ( )

停止所有音效播放

返回: void

◆ StopBackgroundMusic()

function IXAudioEngine StopBackgroundMusic ( releaseData )

停止播放背景音乐

参数

releaseData boolean 是否释放资源

返回: void

◆ StopEffect()

function IXAudioEngine StopEffect ( soundId )

停止音效播放

参数

soundId number 音效ID

返回: void

◆ UnloadEffect()

function IXAudioEngine UnloadEffect ( filePath )

IXAudioEngine_UnloadEffect00

参数

filePath string

返回: void

变量说明

◆ IXAudioEngine

IXAudioEngine = {}

◆ XAudioEnginePlayerTypeOpenAL

IXAudioEngine XAudioEnginePlayerTypeOpenAL = 0

◆ XAudioEnginePlayerTypeUninit

IXAudioEngine XAudioEnginePlayerTypeUninit = 0

◆ XAudioEnginePlayerTypeUser

IXAudioEngine XAudioEnginePlayerTypeUser = 0