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

Functions

function IXAudioEngine SetPlayerType (type) 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) end
 
function IXAudioEngine RemoveAudio (source) end
 
function IXAudioEngine SetAudioListener (Location, Up, Front) end
 
function IXAudioEngine GetOrCreateAudioListener () end
 

Variables

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

Function Documentation

◆ CreateAudio()

function IXAudioEngine CreateAudio ( szfileName  ,
loop  ,
volume   
)

创建一个音频源

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

◆ GetBackgroundMusicCurrentPosition()

function IXAudioEngine GetBackgroundMusicCurrentPosition ( )

IXAudioEngine_GetBackgroundMusicCurrentPosition00

Returns
number

◆ GetBackgroundMusicDuration()

function IXAudioEngine GetBackgroundMusicDuration ( )

IXAudioEngine_GetBackgroundMusicDuration00

Returns
number

◆ GetBackgroundMusicVolume()

function IXAudioEngine GetBackgroundMusicVolume ( )

IXAudioEngine_GetBackgroundMusicVolume00

Returns
number

◆ GetEffectsVolume()

function IXAudioEngine GetEffectsVolume ( )

IXAudioEngine_GetEffectsVolume00

Returns
number

◆ GetOrCreateAudioListener()

function IXAudioEngine GetOrCreateAudioListener ( )

获取音频监听

Returns
IXAudioListener 音频监听

◆ IsBackgroundMusicPlaying()

function IXAudioEngine IsBackgroundMusicPlaying ( )

IXAudioEngine_IsBackgroundMusicPlaying00

Returns
boolean

◆ PauseAllEffects()

function IXAudioEngine PauseAllEffects ( )

IXAudioEngine_PauseAllEffects00

Returns
void

◆ PauseBackgroundMusic()

function IXAudioEngine PauseBackgroundMusic ( )

IXAudioEngine_PauseBackgroundMusic00

Returns
void

◆ PauseEffect()

function IXAudioEngine PauseEffect ( soundId  )

IXAudioEngine_PauseEffect00

Parameters
soundIdnumber
Returns
void

◆ PlayBackgroundMusic()

function IXAudioEngine PlayBackgroundMusic ( filePath  ,
loop   
)

IXAudioEngine_PlayBackgroundMusic00

Parameters
filePathstring
loopboolean
Returns
void

◆ PlayEffect()

function IXAudioEngine PlayEffect ( filePath  ,
loop  ,
gain   
)

IXAudioEngine_PlayEffect00

Parameters
filePathstring
loopboolean
gainnumber
Returns
number

◆ PreloadEffect()

function IXAudioEngine PreloadEffect ( filePath  )

IXAudioEngine_PreloadEffect00

Parameters
filePathstring
Returns
void

◆ RemoveAudio()

function IXAudioEngine RemoveAudio ( source  )

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

Parameters
sourceIXAudioSource 音频资源
Returns
void

◆ ResumeAllEffects()

function IXAudioEngine ResumeAllEffects ( )

IXAudioEngine_ResumeAllEffects00

Returns
void

◆ ResumeBackgroundMusic()

function IXAudioEngine ResumeBackgroundMusic ( )

IXAudioEngine_ResumeBackgroundMusic00

Returns
void

◆ ResumeEffect()

function IXAudioEngine ResumeEffect ( soundId  )

IXAudioEngine_ResumeEffect00

Parameters
soundIdnumber
Returns
void

◆ RewindBackgroundMusic()

function IXAudioEngine RewindBackgroundMusic ( )

IXAudioEngine_RewindBackgroundMusic00

Returns
void

◆ SetAudioListener()

function IXAudioEngine SetAudioListener ( Location  ,
Up  ,
Front   
)

设置音频监听

Parameters
LocationXVECTOR3
UpXVECTOR3
FrontXVECTOR3
Returns
void

◆ SetBackgroundMusicCurrentPosition()

function IXAudioEngine SetBackgroundMusicCurrentPosition ( position  )

IXAudioEngine_SetBackgroundMusicCurrentPosition00

Parameters
positionnumber
Returns
void

◆ SetBackgroundMusicVolume()

function IXAudioEngine SetBackgroundMusicVolume ( volume  )

IXAudioEngine_SetBackgroundMusicVolume00

Parameters
volumenumber
Returns
void

◆ SetEffectsVolume()

function IXAudioEngine SetEffectsVolume ( volume  )

IXAudioEngine_SetEffectsVolume00

Parameters
volumenumber
Returns
void

◆ SetPlayerType()

function IXAudioEngine SetPlayerType ( type  )

IXAudioEngine_SetPlayerType00

Parameters
typenumber
Returns
void

◆ StopAllEffects()

function IXAudioEngine StopAllEffects ( )

IXAudioEngine_StopAllEffects00

Returns
void

◆ StopBackgroundMusic()

function IXAudioEngine StopBackgroundMusic ( releaseData  )

IXAudioEngine_StopBackgroundMusic00

Parameters
releaseDataboolean
Returns
void

◆ StopEffect()

function IXAudioEngine StopEffect ( soundId  )

IXAudioEngine_StopEffect00

Parameters
soundIdnumber
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