跳转到内容

Audio

音频

控制本地音频音效播放

枚举列表

Audio.TARGET_TYPE

  • 描述: 目标类型
成员名称成员说明
Character角色
Creature生物
Element元件

Audio.ATT_MODE

  • 描述: 衰减模式
成员名称成员说明
None
Linear线性
BrickWall断崖
CloseDrop近处快速
FarDrop远处快速

函数列表

PlaySFXAudio3DInTarget

  • 描述: 播放一个指定音效,音效需挂载在角色,生物,元件对象上。

  • 范围: 客户端

参数列表:

参数类型说明
AudioIdnumber音效Id
TargetTypeAudio.TARGET_TYPE目标类型
TargetIdnumber目标id
Distancenumber传播距离
AttenuationModeAudio.ATT_MODE衰减模式
Durationnumber播放持续时间,单位s,默认为0。
Volumenumber音量大小,最小值为0,最大值为100,默认为0。
Tunenumber音效变调,最小值为-48,最大值为48,默认为0。

返回字段:

返回字段字段类型说明
playIdnumber播放音效id,-1表示播放失败
local AudioId = 700001
local TargetType = Audio.TARGET_TYPE.Element
local TargetID = 262
--如果在角色身上播放修改 TargetType = Audio.TARGET_TYPE.Character TargetID = 610140737498231334(玩家id)
local Volume = 100
local Duration = 4
local AttenuationMode = Audio.ATT_MODE.Linear
local Distance = 50
local Tune = 0
local playId = Audio:PlaySFXAudio3DInTarget(AudioId, TargetType, TargetID, Distance, AttenuationMode, Duration, Volume, Tune)

PlaySFXAudio2D

  • 描述: 播放一个指定2D音效。

  • 范围: 客户端

参数列表:

参数类型说明
AudioIdnumber音效Id
Durationnumber播放持续时间,单位s,默认为0。
Volumenumber音量大小,最小值为0,最大值为100,默认为0。
Tunenumber音效变调,最小值为-48,最大值为48,默认为0。

返回字段:

返回字段字段类型说明
playIdnumber播放音效id,-1表示播放失败
local AudioId = 700001
local Duration = 4
local Volume = 100
local Tune = 0
local playId = Audio:PlaySFXAudio2D(AudioId, Duration, Volume, Tune)

StopSFXAudio

  • 描述: 停止播放音效。

  • 范围: 客户端

参数列表:

参数类型说明
PlayIdnumber调用播放接口时返回的Id
Audio:StopSFXAudio(PlayId)