构造函数

new Sound(game, key, volume, loop)

声音类构造函数。

参数

名称 类型 参数 默认值 描述
game Phaser.Game 参照当前游戏实例。
key string 健全的资产密钥。
volume number <optional> 1 默认值为1至0。
loop boolean <optional> false 声音是否会循环。

公共属性

allowMultiple : boolean

这会让你有一个声音的多个实例,在一次播放。这是唯一有用的,当在网络音频运行时,我们建议您实现一个本地池系统,以不淹没的声音通道。

Source code: sound/Sound.js (Line 149)

autoplay : boolean

表示声音是否应该自动开始。

Source code: sound/Sound.js (Line 62)

context :AudioContext

参照audiocontext实例。

Source code: sound/Sound.js (Line 57)

currentMarker : string

当前播放标记的字符串标识,如果有。

Source code: sound/Sound.js (Line 126)

currentTime : number

目前的声音是在。

Source code: sound/Sound.js (Line 78)

duration : number

秒的当前声音标记的持续时间。

Source code: sound/Sound.js (Line 83)

durationMS : number

当前声音标记的持续时间。

Source code: sound/Sound.js (Line 88)

externalNode : Object

如果定义了这个声音不会连接到soundmanager主增益节点,而是连接到externalnode。

Source code: sound/Sound.js (Line 165)

fadeTween : Phaser.Tween

它的音频吐温,通过sound.fadein和sound.fadeout。

Source code: sound/Sound.js (Line 131)

gainNode : Object

网络音频系统中的增益节点。

Source code: sound/Sound.js (Line 175)

game : Phaser.Game

一个参考目前正在运行的游戏。

Source code: sound/Sound.js (Line 27)

[readonly] isDecoded : boolean

如果声音文件已被解码,则返回真。

Source code: sound/Sound.js (Line 1044)

[readonly] isDecoding : boolean

如果声音文件仍然解码,返回真。

Source code: sound/Sound.js (Line 1031)

isPlaying : boolean

如果声音是当前播放,否则假。

Source code: sound/Sound.js (Line 120)

key : string

健全的资产密钥。

Source code: sound/Sound.js (Line 37)

loop : boolean

声音或声音标志是否会循环。

Source code: sound/Sound.js (Line 42)

markers : Object

声音标记。

Source code: sound/Sound.js (Line 52)

masterGainNode : Object

网络音频系统中的主控增益节点。

Source code: sound/Sound.js (Line 170)

mute : boolean

获取或设置此声音的静音状态。

Source code: sound/Sound.js (Line 1057)

name : string

声音的名字。

Source code: sound/Sound.js (Line 32)

onDecoded : Phaser.Signal

事件的ondecoded派遣时完成了声音解码(通常是MP3文件)

Source code: sound/Sound.js (Line 225)

onFadeComplete : Phaser.Signal

事件的onfadecomplete派遣当这声音结束衰落或退出。

Source code: sound/Sound.js (Line 265)

onLoop : Phaser.Signal

该事件是当这声音派遣半实物循环播放中。

Source code: sound/Sound.js (Line 245)

onMarkerComplete : Phaser.Signal

事件的onmarkercomplete内发出这声标记完成时播放。

Source code: sound/Sound.js (Line 260)

onMute : Phaser.Signal

的小鼠事件派遣这声音时静音。

Source code: sound/Sound.js (Line 255)

onPause : Phaser.Signal

OnPause事件调度这声音停下来的时候。

Source code: sound/Sound.js (Line 235)

onPlay : Phaser.Signal

事件的onplay派遣每次播放声音。

Source code: sound/Sound.js (Line 230)

onResume : Phaser.Signal

的onResume事件出动时,这声音是从暂停状态恢复。

Source code: sound/Sound.js (Line 240)

onStop : Phaser.Signal

该事件是当这声音onStop派遣停止播放。

Source code: sound/Sound.js (Line 250)

override : boolean

如果你在播放这声音的时候,它总是从一开始就开始。

Source code: sound/Sound.js (Line 143)

paused : boolean

如果声音被暂停,否则为假。

Source code: sound/Sound.js (Line 104)

pausedPosition : number

当它被暂停时的声音已达到的位置。

Source code: sound/Sound.js (Line 109)

pausedTime : number

声音被暂停的游戏时间。

Source code: sound/Sound.js (Line 114)

[readonly] pendingPlayback : boolean

如果声音文件正在播放

Source code: sound/Sound.js (Line 137)

position : number

当前声音标记的位置。

Source code: sound/Sound.js (Line 93)

startTime : number

声音开始的时间(通常为0,除非从一个标记开始)

Source code: sound/Sound.js (Line 73)

stopTime : number

声音停止的时候。

Source code: sound/Sound.js (Line 98)

totalDuration : number

声音的总持续时间秒。

Source code: sound/Sound.js (Line 67)

usingAudioTag : boolean

如果声音被播放通过音频标签。

Source code: sound/Sound.js (Line 160)

[readonly] usingWebAudio : boolean

真的,如果这个声音是播放与网络音频。

Source code: sound/Sound.js (Line 155)

[readonly] volume : number

获取或设置此声音的音量,介于0和1之间的值。

Source code: sound/Sound.js (Line 1112)

volume : number

声音或声音标记体积。0(沉默)和1(全卷)之间的值。

Source code: sound/Sound.js (Line 47)

公共方法

addMarker(name, start, duration, volume, loop)

将一个标记添加到当前声音中。一个标记是由一个独特的键和一个开始时间和持续时间。

参数

名称 类型 参数 默认值 描述
name string 这个标记的唯一名称,即“爆炸”、“射击”等。
start number 在几秒钟内,该标记在音频文件中的起始点。2.5 = 0.5 = 2500ms,500ms,等。

duration number 在几秒钟内标记的持续时间。2.5 = 0.5 = 2500ms,500ms,等。

volume number <optional>
1 音量的声音会回放,0(无声)和1(全卷)。
loop boolean <optional>
false 如果声音会循环,则设置。

Source code: sound/Sound.js (Line 347)


destroy(remove)

破坏这声音和所有相关的事件,并将其从soundmanager。

参数

名称 类型 参数 默认值 描述
remove boolean <optional>
true
如果真的这声音是从soundmanager自动删除。

Source code: sound/Sound.js (Line 992)


fadeIn(duration, loop, marker)

开始播放声音(或重新启动它如果已经这样做了),设置为零的体积。

参数

名称 类型 参数 默认值 描述
duration number <optional>
1000 在几毫秒的时间里,声音应该逐渐消失。
loop boolean <optional>
false 如果声音被设置为循环?请注意,这不会导致褪色的重复。
marker string <optional>
(current marker) 该标记为开始,默认为当前(最后一个播放)标记。从开始播放时,指定一个“代码”的标记。

Source code: sound/Sound.js (Line 903)


fadeOut(duration)

此声音的音量从其当前值减少到0,超过指定的时间。

参数

名称 类型 参数 默认值 描述
duration number <optional>
1000 在几毫秒的时间里,声音会逐渐消失。

Source code: sound/Sound.js (Line 931)


fadeTo(duration, volume)

从其当前值到指定的时间,将此声音的音量从其当前值中消失。

参数

名称 类型 参数 默认值 描述
duration number <optional>
1000 在毫秒的时间内,声音应该逐渐消失。
volume number <optional>
声音应该逐渐消失的音量。这是0和1之间的值。

Source code: sound/Sound.js (Line 945)


loopFull(volume) → {Phaser.Sound}

这整个声音。如果你需要循环它的一个部分,然后用sound.play和标记和回路参数。

参数

名称 类型 参数 默认值 描述
volume number <optional>
1 你要演奏的声音的音量。如果没有给出它将使用的音量时,它被创建(默认为1,如果没有指定)。

Source code: sound/Sound.js (Line 476)


<internal> onEndedHandler()

自动调用的audiocontext当声音停止播放。

Source code: sound/Sound.js (Line 386)


pause()

停顿的声音。

Source code: sound/Sound.js (Line 744)


play(marker, position, volume, loop, forceRestart) → {Phaser.Sound}

播放这个声音,或一个标记的部分。

参数

名称 类型 参数 默认值 描述
marker string <optional>
'' 如果你想打一个标记,然后把钥匙给你,否则留下空白的播放完整的声音。
position number <optional>
0 如果你提供了一个标记,你就可以开始发挥其良好的位置。
volume number <optional>
1 你要演奏的声音的音量。如果没有给出它将使用的音量时,它被创建(默认为1,如果没有指定)。
loop boolean <optional>
false 当完成播放时,循环?如果不使用标记/音频雪碧循环将通过webaudio环路特性,否则时间基础。

forceRestart boolean <optional>
true

如果声音已经可以设置forcerestart重新启动从一开始。

Source code: sound/Sound.js (Line 489)


removeMarker(name)

从声音中移除一个标记。

参数

名称 类型 参数 默认值 描述
name string <标记的键,以除去。

Source code: sound/Sound.js (Line 375)


restart(marker, position, volume, loop)

重新启动声音,或一个标记的部分。

参数

名称 类型 参数 默认值 描述
marker string <optional>
'' 如果你想打一个标记,然后把钥匙给你,否则留下空白的播放完整的声音。
position number <optional>
0 如果你提供了一个标记,你就可以开始发挥其良好的位置。
volume number <optional>
1 你要播放的声音的音量。
loop boolean <optional>
false 当它结束时,循环?< /对

Source code: sound/Sound.js (Line 724)


resume()

恢复健康。

Source code: sound/Sound.js (Line 762)


<internal> soundHasUnlocked(key)

当这个声音被解锁时自动调用。

参数

名称 类型 参数 默认值 描述
key string

相位器。声音文件的缓存键检查解码。

Source code: sound/Sound.js (Line 331)


stop()

停止播放这个声音。

Source code: sound/Sound.js (Line 837)


<internal> update()

通过phaser.soundmanager自动调用。

Source code: sound/Sound.js (Line 402)