Класс: Phaser.Sound

Конструктор

new Sound(game, key, volume, loop)

Конструктор класса Sound.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
`game`	Phaser.Game			Ссылка на текущую инстанцию игры.
`key`	string			Ключ актива для звука.
`volume`	number	<optional>	1	Значение громкости по умолчанию, от 0 до 1.
`loop`	boolean	<optional>	false	Циклическое воспроизведение звука.

Исходный код: sound/Sound.js (Строка 17)

Свойства публичного доступа

allowMultiple : boolean

Это позволит вам одновременно воспроизводить несколько экземпляров этого звука. Это полезно только при работе под Web Audio, и мы рекомендуем вам реализовать локальную систему пула, чтобы не перегружать звуковые каналы.

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

autoplay : boolean

Логическое значение, указывающее, следует ли автоматически запускать звук.

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

context :AudioContext

Ссылка на экземпляр AudioContext.

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

currentMarker : string

Строковый ID текущего воспроизводимого маркера, если таковой имеется.

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

currentTime : number

Текущее время воспроизведения звука.

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

duration : number

Длительность текущего маркера звука в секундах.

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

durationMS : number

Длительность текущего маркера звука в мс.

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

externalNode : Object

Если определено, этот звук не будет подключаться к главному узлу усиления SoundManager, а вместо этого будет подключаться к externalNode.

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

fadeTween : Phaser.Tween

Твин, который затухает аудио, устанавливается через Sound.fadeIn и Sound.fadeOut.

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

gainNode : Object

Узел усиления в системе Web Audio.

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

game : Phaser.Game

Ссылка на запущенную игру.

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

[readonly] isDecoded : boolean

Возвращает true, если звуковой файл декодирован.

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

[readonly] isDecoding : boolean

Возвращает true, если звуковой файл все еще декодируется.

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

isPlaying : boolean

true, если звук в данный момент воспроизводится, иначе false.

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

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 47)

masterGainNode : Object

Главный узел усиления в системе Web Audio.

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

mute : boolean

Получает или устанавливает состояние отключения звука.

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

name : string

Имя звука.

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

onDecoded : Phaser.Signal

Событие onDecoded отправляется, когда звук завершил декодирование (обычно для файлов mp3).

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

onFadeComplete : Phaser.Signal

Событие onFadeComplete отправляется, когда этот звук завершает затухание или нарастание.

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

onLoop : Phaser.Signal

Событие onLoop отправляется, когда этот звук зацикливается во время воспроизведения.

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

onMarkerComplete : Phaser.Signal

Событие onMarkerComplete отправляется, когда маркер в этом звуке завершает воспроизведение.

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

onMute : Phaser.Signal

Событие onMute отправляется, когда этот звук отключается.

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

onPause : Phaser.Signal

Событие onPause срабатывает, когда этот звук приостановлен.

Исходный код: sound/Sound.js (Строка 230)

onPlay : Phaser.Signal

Событие onPlay срабатывает каждый раз, когда этот звук воспроизводится.

Исходный код: sound/Sound.js (Строка 225)

onResume : Phaser.Signal

Событие onResume срабатывает, когда этот звук возобновляется после приостановки.

Исходный код: sound/Sound.js (Строка 235)

onStop : Phaser.Signal

Событие onStop срабатывает, когда воспроизведение этого звука завершается.

Исходный код: sound/Sound.js (Строка 245)

override : boolean

Если true, при воспроизведении этого звука он всегда будет начинаться с начала.

Исходный код: sound/Sound.js (Строка 138)

paused : boolean

true, если звук приостановлен, иначе false.

Исходный код: sound/Sound.js (Строка 99)

pausedPosition : number

Позиция звука в момент его приостановки.

Исходный код: sound/Sound.js (Строка 104)

pausedTime : number

Время в игре, когда звук был приостановлен.

Исходный код: sound/Sound.js (Строка 109)

[readonly] pendingPlayback : boolean

true, если файл звука ожидает воспроизведения

Исходный код: sound/Sound.js (Строка 132)

position : number

Позиция текущей метки звука.

Исходный код: sound/Sound.js (Строка 88)

startTime : number

Время начала звука (обычно 0, если не используется метка)

Исходный код: sound/Sound.js (Строка 68)

stopTime : number

Время остановки звука.

Исходный код: sound/Sound.js (Строка 93)

totalDuration : number

Общая продолжительность звука в секундах.

Исходный код: sound/Sound.js (Строка 62)

usingAudioTag : boolean

true, если звук воспроизводится через тег Audio.

Исходный код: sound/Sound.js (Строка 155)

[readonly] usingWebAudio : boolean

true, если этот звук воспроизводится с помощью Web Audio.

Исходный код: sound/Sound.js (Строка 150)

volume : number

Получает или задаёт громкость этого звука, значение от 0 до 1. Заданное значение ограничено диапазоном от 0 до 1.

Исходный код: sound/Sound.js (Строка 1155)

Публичные методы

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

Добавляет маркер в текущий звук. Маркер представляется уникальным ключом, временем начала и продолжительностью.
Это позволяет объединять несколько звуков в один аудиофайл и использовать маркеры для перехода между ними при воспроизведении.

Параметры

Name	Type	Argument	Default	Description
`name`	string			Уникальное имя для этого маркера, например, 'взрыв', 'выстрел' и т.д.
`start`	number			Начальная точка этого маркера в аудиофайле, заданная в секундах. 2.5 = 2500 мс, 0.5 = 500 мс и т.д.
`duration`	number	<optional>	1	Продолжительность маркера в секундах. 2.5 = 2500 мс, 0.5 = 500 мс и т.д.
`volume`	number	<optional>	1	Громкость, с которой будет воспроизводиться звук, от 0 (без звука) до 1 (полная громкость).
`loop`	boolean	<optional>	false	Устанавливает, будет ли звук циклически повторяться или нет.

Исходный код: sound/Sound.js (Строка 348)

destroy(remove)

Уничтожает этот звук и все связанные с ним события, а также удаляет его из SoundManager.

Параметры

Name	Type	Argument	Default	Description
`remove`	boolean	<optional>	true	Если true, этот звук автоматически удаляется из SoundManager.

Исходный код: sound/Sound.js (Строка 1035)

fadeIn(duration, loop, marker)

Начинает воспроизведение этого звука (или перезапускает его, если он уже воспроизводится) и устанавливает громкость на ноль.
Затем увеличивает громкость от 0 до 1 в течение указанной продолжительности.

В конце затухания Sound.onFadeComplete отправляется с этим объектом Sound в качестве первого параметра,
и конечной громкостью (1) в качестве второго параметра.

Параметры

Name	Type	Argument	Default	Description
`duration`	number	<optional>	1000	Время в миллисекундах, за которое звук должен плавно увеличиться в громкости.
`loop`	boolean	<optional>	false	Должен ли звук быть установлен на циклическое повторение? Обратите внимание, что это не приводит к повторению затухания.
`marker`	string	<optional>	(current marker)	Маркер, с которого следует начать; по умолчанию используется текущий (последний воспроизведенный) маркер. Чтобы начать воспроизведение с начала, укажите маркер `''`.

Исходный код: sound/Sound.js (Строка 924)

fadeOut(duration)

Уменьшает громкость этого звука от текущего значения до 0 в течение указанной продолжительности.
В конце затухания Sound.onFadeComplete отправляется с этим объектом Sound в качестве первого параметра,
и конечной громкостью (0) в качестве второго параметра.

Параметры

Name	Type	Argument	Default	Description
`duration`	number	<optional>	1000	Время в миллисекундах, за которое звук должен плавно уменьшиться в громкости.

Исходный код: sound/Sound.js (Строка 952)

fadeTo(duration, volume)

Плавно изменяет громкость этого звука от текущего значения до заданной громкости в течение указанной продолжительности.
В конце затухания Sound.onFadeComplete отправляется с этим объектом Sound в качестве первого параметра,
и конечной громкостью (volume) в качестве второго параметра.

Параметры

Name	Type	Argument	Default	Description
`duration`	number	<optional>	1000	Время в миллисекундах, за которое звук должен плавно уменьшиться в громкости.
`volume`	number	<optional>		Громкость, до которой должен плавно уменьшиться звук. Это значение от 0 до 1.

Исходный код: sound/Sound.js (Строка 966)

loopFull(volume) → {Phaser.Sound}

Зацикливает весь этот звук. Если вам нужно зациклить его часть, используйте Sound.play и параметры marker и loop.

Параметры

Name	Type	Argument	Default	Description
`volume`	number	<optional>	1	Громкость звука, который вы хотите воспроизвести. Если значение не указано, будет использоваться громкость, заданная для звука при его создании (по умолчанию 1, если значение не указано).

Возвращает

Phaser.Sound -

Этот экземпляр звука.

Исходный код: sound/Sound.js (Строка 492)

<internal> onEndedHandler()

Вызывается автоматически AudioContext, когда звук прекращает воспроизведение.
Не вызывается, если звук установлен на циклическое повторение или является частью Audio Sprite.

Внутренний:

Этот член является внутренним (защищенным) и может быть изменен или удален в будущем.

Исходный код: sound/Sound.js (Строка 388)

pause()

Приостанавливает звук.

Исходный код: sound/Sound.js (Строка 763)

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 loop, в противном случае — по времени.
`forceRestart`	boolean	<optional>	true	Если звук уже воспроизводится, можно установить forceRestart для его перезапуска с начала.

Возвращаемое значение

Phaser.Sound -

Экземпляр этого звука.

Исходный код: sound/Sound.js (Строка 505)

removeMarker(name)

Удаляет маркер из звука.

Параметры

Имя	Тип	Описание
`name`	string	Ключ удаляемого маркера.

Исходный код: sound/Sound.js (Строка 377)

restart(marker, position, volume, loop)

Перезапускает звук или отмеченный фрагмент.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
`marker`	string	<optional>	''	Если вы хотите воспроизвести маркер, укажите его ключ здесь, иначе оставьте пустым, чтобы воспроизвести весь звук.
`position`	number	<optional>	0	Начальная позиция для воспроизведения звука — игнорируется, если вы указали маркер.
`volume`	number	<optional>	1	Громкость воспроизводимого звука.
`loop`	boolean	<optional>	false	Циклическое воспроизведение по окончании?