跳转到内容

Music

音乐

对游戏内音乐播放进行控制操作

函数列表

PlayMusic

  • 描述: 播放指定音乐(支持淡入效果)

  • 范围: 客户端

参数列表:

参数类型说明
MusicIndexnumber推荐音乐列表中的歌曲序号(从1开始)
Music:PlayMusic(1)

PlayMusicByStartTime

  • 描述: 从指定时间点开始播放音乐

  • 范围: 客户端

参数列表:

参数类型说明
MusicIndexnumber推荐音乐列表中的歌曲序号(从1开始)
StartTimenumber音乐从哪个时间开始播放,此时间最好小于音乐时长
Music:PlayMusicByStartTime(1,0)

StopMusic

  • 描述: 停止当前音乐(支持淡出效果)

  • 范围: 客户端

Music:StopMusic()

SetMusicFadeInTime

  • 描述: 设置指定音乐的淡入时间

  • 范围: 客户端

参数列表:

参数类型说明
MusicIndexnumber推荐音乐列表中的歌曲序号(从1开始)
FadeInTimenumber淡入时间(秒,1~5)
Music:SetMusicFadeInTime(2,3)

SetMusicFadeOutTime

  • 描述: 设置指定音乐的淡出时间

  • 范围: 客户端

参数列表:

参数类型说明
MusicIndexnumber推荐音乐列表中的歌曲序号(从1开始)
FadeOutTimenumber淡出时间(秒,1~5)
Music:SetMusicFadeOutTime(2,3)

GetMusicDurationTime

  • 描述: 获取音乐总时长

  • 范围: 客户端

参数列表:

参数类型说明
MusicIndexnumber推荐音乐列表中的歌曲序号(从1开始)

返回字段:

返回字段字段类型说明
musicDurationnumber音乐总时长(秒)
local musicDuration = Music:GetMusicDurationTime(1)
Log:PrintLog("musicDuration value is ",musicDuration)

JumpMusicToSpecifyTime

  • 描述: 跳转到当前音乐的指定时间点(需在音乐开始播放后才能生效)

  • 范围: 客户端

参数列表:

参数类型说明
WantJumpTimenumber目标时间(秒)
Music:JumpMusicToSpecifyTime(50)

GetMusicName

  • 描述: 获取音乐名字

  • 范围: 客户端

参数列表:

参数类型说明
MusicIndexnumber推荐音乐列表中的歌曲序号(从1开始)

返回字段:

返回字段字段类型说明
musicNamestring音乐名字
local musicName = Music:GetMusicName(1)
Log:PrintLog("musicName is ", musicName)