AR_Engine_SDK
Functions | Variables
XAudioEngine.lua File Reference
类 IXAudioEngine 继承关系图:
Inheritance graph

Functions

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
 

Variables

 IXAudioEngine = {}
 
IXAudioEngine XAudioEnginePlayerTypeUninit = 0
 
IXAudioEngine XAudioEnginePlayerTypeOpenAL = 0
 
IXAudioEngine XAudioEnginePlayerTypeUser = 0
 
IXAudioEngine XAudioEnginePlayerTypeNative = 0
 

Function Documentation

◆ CreateAudio()

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

创建一个3D音频源

Parameters
szfileNamestring 音频资源名称
loopboolean 是否循环播放
volumenumber 音量
sourceRelativeboolean
Returns
IXAudioSource 音频源指针，创建失败返回NULL

◆ GetBackgroundMusicCurrentPosition()

function IXAudioEngine GetBackgroundMusicCurrentPosition ( )

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

Returns
number 毫秒

◆ GetBackgroundMusicDuration()

function IXAudioEngine GetBackgroundMusicDuration ( )

获取背景音乐总时长

Returns
number 毫秒

◆ GetBackgroundMusicVolume()

function IXAudioEngine GetBackgroundMusicVolume ( )

获取背景音乐音量

Returns
number 0～1

◆ GetEffectMaxNum()

function IXAudioEngine GetEffectMaxNum ( )

IXAudioEngine_GetEffectMaxNum00

Returns
number

◆ GetEffectsVolume()

function IXAudioEngine GetEffectsVolume ( )

获取音效音量

Returns
number 0～1

◆ GetOrCreateAudioListener()

function IXAudioEngine GetOrCreateAudioListener ( )

获取音频聆听者

Returns
IXAudioListener 音频聆听者

◆ IsBackgroundMusicPlaying()

function IXAudioEngine IsBackgroundMusicPlaying ( )

背景音乐是否正在播放

Returns
boolean

◆ PauseAllEffects()

function IXAudioEngine PauseAllEffects ( )

暂停所有音效

Returns
void

◆ PauseBackgroundMusic()

function IXAudioEngine PauseBackgroundMusic ( )

暂停背景音乐播放

Returns
void

◆ PauseEffect()

function IXAudioEngine PauseEffect ( soundId  )

暂停音效播放

Parameters
soundIdnumber 音效ID
Returns
void

◆ PlayBackgroundMusic()

function IXAudioEngine PlayBackgroundMusic ( filePath  ,
loop   
)

播放背景音乐

Parameters
filePathstring 文件路径
loopboolean 是否循环播放
Returns
void

◆ PlayEffect()

function IXAudioEngine PlayEffect ( filePath  ,
loop  ,
gain   
)

播放音效

Parameters
filePathstring 音效文件路径
loopboolean 是否循环播放
gainnumber 音量0～1
Returns
number 音效ID

◆ PreloadAudio()

function IXAudioEngine PreloadAudio ( filePath  ,
callback   
)

@manual xelua_XEngine_IXAudioEngine_PreloadAudio_manual IXAudioEngine_PreloadAudio_manual

Parameters
filePathstring
callbackstd::function<void(xbool, std::string)>
Returns
boolean

◆ PreloadBackgroundMusic()

function IXAudioEngine PreloadBackgroundMusic ( filePath  )

IXAudioEngine_PreloadBackgroundMusic00

Parameters
filePathstring
Returns
void

◆ PreloadEffect()

function IXAudioEngine PreloadEffect ( filePath  )

IXAudioEngine_PreloadEffect00

Parameters
filePathstring
Returns
void

◆ RemoveAudio()

function IXAudioEngine RemoveAudio ( source  )

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

Parameters
sourceIXAudioSource 音频资源
Returns
void

◆ ResumeAllEffects()

function IXAudioEngine ResumeAllEffects ( )

恢复所有音效播放

Returns
void

◆ ResumeBackgroundMusic()

function IXAudioEngine ResumeBackgroundMusic ( )

恢复背景音乐播放

Returns
void

◆ ResumeEffect()

function IXAudioEngine ResumeEffect ( soundId  )

恢复音效播放

Parameters
soundIdnumber 音效ID
Returns
void

◆ RewindBackgroundMusic()

function IXAudioEngine RewindBackgroundMusic ( )

回滚背景音乐

Returns
void

◆ SetAudioListener()

function IXAudioEngine SetAudioListener ( Location  ,
Up  ,
Front   
)

设置3D音频聆听者

Parameters
LocationXVECTOR3
UpXVECTOR3
FrontXVECTOR3
Returns
void

◆ SetBackgroundMusicCurrentPosition()

function IXAudioEngine SetBackgroundMusicCurrentPosition ( position  )

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

Parameters
positionnumber 毫秒
Returns
void

◆ SetBackgroundMusicVolume()

function IXAudioEngine SetBackgroundMusicVolume ( volume  )

设置背景音乐播放音量

Parameters
volumenumber 0～1
Returns
void

◆ SetEffectMaxNum()

function IXAudioEngine SetEffectMaxNum ( n  )

IXAudioEngine_SetEffectMaxNum00

Parameters
nnumber
Returns
void

◆ SetEffectsVolume()

function IXAudioEngine SetEffectsVolume ( volume  )

设置音效音量 0～1

Parameters
volumenumber
Returns
void

◆ SetPlayerType()

function IXAudioEngine SetPlayerType ( type  )

IXAudioEngine_SetPlayerType00

Parameters
typenumber
Returns
void

◆ StopAllEffects()

function IXAudioEngine StopAllEffects ( )

停止所有音效播放

Returns
void

◆ StopBackgroundMusic()

function IXAudioEngine StopBackgroundMusic ( releaseData  )

停止播放背景音乐

Parameters
releaseDataboolean 是否释放资源
Returns
void

◆ StopEffect()

function IXAudioEngine StopEffect ( soundId  )

停止音效播放

Parameters
soundIdnumber 音效ID
Returns
void

◆ UnloadEffect()

function IXAudioEngine UnloadEffect ( filePath  )

IXAudioEngine_UnloadEffect00

Parameters
filePathstring
Returns
void

Variable Documentation

◆ IXAudioEngine

IXAudioEngine = {}

◆ XAudioEnginePlayerTypeNative

IXAudioEngine XAudioEnginePlayerTypeNative = 0

◆ XAudioEnginePlayerTypeOpenAL

IXAudioEngine XAudioEnginePlayerTypeOpenAL = 0

◆ XAudioEnginePlayerTypeUninit

IXAudioEngine XAudioEnginePlayerTypeUninit = 0

◆ XAudioEnginePlayerTypeUser

IXAudioEngine XAudioEnginePlayerTypeUser = 0
Generated by   doxygen 1.8.15