| Пакет | mx.effects |
| Класс | public class SoundEffect |
| Наследование | SoundEffect  Effect EventDispatcher Object |
| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Файл MP3 указывается с помощью свойства source. Если уже имеется встроенный файл MP3, с помощью ключевого слова Embed можно передать объект Class файла MP3 в свойство source. В противном случае, следует указать полный URL-адрес файла MP3.
Показать синтаксис MXML
Скрыть синтаксис MXMLThe <mx:SoundEffect> tag
inherits all of the tag attributes of its superclass,
and adds the following tag attributes:
<mx:SoundEffect
Properties
id="ID"
autoLoad="true|false"
bufferTime="1000"
loops="0"
panEasingFunction=""
panFrom="0"
source=""
startTime="0"
useDuration="true|false"
volumeEasingFunction="true|false"
volumeTo="1"
Events
complete="No default"
id3="No default"
ioError="No default"
progress="No default"
/>
Связанные элементы API
| Свойство | Определено | ||
|---|---|---|---|
| autoLoad : Boolean
Если значение равно true, то после указания источника загружается файл MP3. | SoundEffect | ||
| bufferTime : Number = 1000
Класс SoundEffect использует внутренний звуковой объект для управления файлом MP3. | SoundEffect | ||
 | className : String [только для чтения]
Имя класса эффекта, например Fade. | Effect | |
| constructor : Object
Ссылка на объект класса или функцию конструктора для данного экземпляра объекта. | Object | |
| customFilter : mx.effects:EffectTargetFilter
Указывает пользовательский объект фильтра типа EffectTargetFilter, используемый эффектом для определения целевых объектов, для которых должен воспроизводиться эффект. | Effect | |
| duration : Number
Продолжительность эффекта в миллисекундах. | Effect | |
| effectTargetHost : mx.effects:IEffectTargetHost
Свойства, позволяющие получить доступ к целевому элементу управления на основе списка для эффекта данных. | Effect | |
| filter : String
Указывает алгоритм фильтрации целевых объектов для эффекта. | Effect | |
| hideFocusRing : Boolean
Определяет, должен ли эффект скрыть кольцо фокуса при запуске. | Effect | |
| instanceClass : Class
Объект типа Class, указывающий класс класса экземпляра эффекта для данного класса эффекта. | Effect | |
| isLoading : Boolean [только для чтения]
Это свойство имеет значение true, если файл MP3 загружен. | SoundEffect | ||
| isPlaying : Boolean [только для чтения]
Флаг только для чтения, принимающий значение true, если какой-либо экземпляр эффекта воспроизводится в настоящее время, и false в противном случае. | Effect | |
| loops : int = 0
Число воспроизведений звукового эффекта в цикле: при значении 0 эффект воспроизводится однократно, при значении 1 – дважды и т. д. | SoundEffect | ||
| panEasingFunction : Function
Функция замедления для эффекта Pan. | SoundEffect | ||
| panFrom : Number
Начальное значение Pan звукового объекта. | SoundEffect | ||
| panTo : Number
Конечное значение Pan звукового объекта. | SoundEffect | ||
| perElementOffset : Number
Дополнительная задержка (в миллисекундах) для целевых объектов эффекта, обрабатываемых после первого целевого объекта эффекта. | Effect | |
| playheadTime : Number
Текущая позиция эффекта. | Effect | |
| relevantProperties : Array
Массив имен свойств, используемых при выполнении фильтрации. | Effect | |
| relevantStyles : Array
Массив имен стилей, используемых при выполнении фильтрации. | Effect | |
| repeatCount : int = 1
Число повторов эффекта. | Effect | |
| repeatDelay : int = 0
Время ожидания (в миллисекундах) перед повторением эффекта. | Effect | |
| sound : Sound [только для чтения]
Звуковой объект, в который был загружен файл MP3. | SoundEffect | ||
| source : Object
URL или класс воспроизводимого файла MP3. | SoundEffect | ||
| startDelay : int = 0
Время ожидания (в миллисекундах) перед запуском эффекта. | Effect | |
| startTime : Number = 0
Исходное положение в файле MP3 (в миллисекундах), с которого должно начинаться воспроизведение. | SoundEffect | ||
| suspendBackgroundProcessing : Boolean = false
Если значение равно true, блокирует всю фоновую обработку во время воспроизведения эффекта. | Effect | |
| target : Object
Объект, к которому применяется данный эффект. | Effect | |
| targets : Array
Массив объектов, являющихся целевыми объектами эффекта. | Effect | |
| triggerEvent : Event
Объект Event, переданный в Effect с помощью EffectManager при запуске эффекта, или null, если эффект воспроизводится без EffectManager. | Effect | |
| useDuration : Boolean = true
В случае значения true воспроизведение эффекта прекращается по истечении времени, указанного свойством duration. | SoundEffect | ||
| volumeEasingFunction : Function
Функция замедления для эффекта Volume. | SoundEffect | ||
| volumeFrom : Number
Начальное значение Volume звукового объекта. | SoundEffect | ||
| volumeTo : Number
Конечное значение Volume звукового объекта. | SoundEffect | ||
| Метод | Определено | ||
|---|---|---|---|
SoundEffect(target:Object = null)
Конструктор. | SoundEffect | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Регистрирует объект прослушивателя события на объекте EventDispatcher для получения прослушивателем уведомления о событии. | EventDispatcher | |
|
Обеспечивает сбор текущих значений соответствующих свойств целевых объектов эффекта и сохраняет их как конечные значения. | Effect | |
|
Обеспечивает сбор текущих значений соответствующих свойств дополнительного набора целевых объектов. Flex использует эту функцию при воспроизведении эффекта изменения данных.
| Effect | |
|
Обеспечивает сбор текущих значений соответствующих свойств для целевых объектов эффекта. | Effect | |
|
Создает отдельный экземпляр эффекта и инициализирует его. | Effect | |
|
Принимает массив целевых объектов и вызывает метод createInstance() для каждой цели. | Effect | |
|
Удаляет прослушиватели событий из экземпляра и удаляет экземпляр из списка экземпляров. | Effect | |
|
Посылает событие в поток событий. | EventDispatcher | |
|
Прерывает эффект, воспроизводящийся в настоящее время, и осуществляет немедленный переход в конец эффекта. | Effect | |
|
Возвращает массив строк, где каждая строка представляет собой имя свойства, которое было изменено данным эффектом. | Effect | |
|
Проверяет, имеет ли объект EventDispatcher прослушиватели, зарегистрированные для определенного типа события. | EventDispatcher | |
|
Показывает, определено ли заданное свойство для объекта. | Object | |
|
Показывает, есть ли экземпляр класса Object в цепи прототипов объекта, заданного в качестве параметра. | Object | |
Загружает MP3, если свойство source указывает на URL-адрес. | SoundEffect | ||
|
Приостанавливает эффект до вызова метода resume(). | Effect | |
|
Начинает воспроизведение эффекта | Effect | |
|
Показывает наличие заданного свойства и его перечисляемость. | Object | |
|
Удаляет прослушиватель из объекта EventDispatcher. | EventDispatcher | |
|
Продолжает воспроизведение эффекта после установки паузы путем вызова метода pause(). | Effect | |
|
Если эффект воспроизводится в настоящее время, воспроизводит эффект в обратном порядке, начиная с текущей позиции эффекта. | Effect | |
|
Задает доступность динамического свойства для операций цикла. | Object | |
|
Останавливает эффект, оставляя целевые объекты эффекта в текущем состоянии. | Effect | |
|
Возвращает строковое представление этого объекта, отформатированного в соответствии со стандартами, принятыми для данной локали. | Object | |
|
Возвращает строковое представление заданного объекта. | Object | |
|
Возвращает элементарное значение заданного объекта. | Object | |
|
Проверяет, зарегистрирован ли прослушиватель события для указанного типа события с данным объектом EventDispatcher или любым его предшественником. | EventDispatcher | |
| Событие | Сводка | Определено | ||
|---|---|---|---|---|
| [многоадресное событие] Отправляется, когда проигрыватель Flash Player или приложение AIR перемещается в фокус операционной системы и становится активным. | EventDispatcher | ||
| Отправляется по завершении загрузки звукового файла. | SoundEffect | |||
| [многоадресное событие] Отправляется, когда проигрыватель Flash Player или приложение AIR теряет фокус системы и становится неактивным. | EventDispatcher | ||
| Отправляется в момент завершения воспроизведения экземпляра эффекта, по завершении воспроизведения экземпляра или при прерывании воспроизведения эффекта посредством вызова метода end(). | Effect | ||
| Отправляется в момент начала воспроизведения эффекта. | Effect | ||
| Отправляется в момент прекращения воспроизведения эффекта, что происходит только в том случае, если воспроизведение эффекта было прервано посредством вызова метода stop(). | Effect | ||
| Отправляется, если для звукового файла MP3 доступны данные ID3. | SoundEffect | |||
| Отправляется, если при загрузке звукового файла произошла ошибка. | SoundEffect | |||
| Отправляется периодически по мере загрузки звукового файла. | SoundEffect | |||
autoLoad | свойство |
autoLoad:Boolean| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Если значение равно true, то после указания источника source загружается файл MP3.
Значением по умолчанию является true.
Реализация
public function get autoLoad():Boolean public function set autoLoad(value:Boolean):voidbufferTime | свойство |
public var bufferTime:Number = 1000| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Класс SoundEffect использует внутренний звуковой объект для управления файлом MP3. Это свойство указывает минимальное количество миллисекунд воспроизведения звуковых данных, содержащихся в буфере звукового объекта. Звуковой объект ожидает, пока не будет загружен как минимум этот объем данных, прежде чем воспроизведение начнется или возобновится после прерывания подключения к сети.
Значением по умолчанию является 1000.
isLoading | свойство |
loops | свойство |
public var loops:int = 0| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Число воспроизведений звукового эффекта в цикле: при значении 0 эффект воспроизводится однократно, при значении 1 – дважды и т. д. Если файл MP3 повторяется, для него по-прежнему используется значение свойства useDuration, определяющее время воспроизведения.
Свойство duration имеет приоритет над этим свойством. Если продолжительность эффекта не достаточна для, по крайней мере, однократного воспроизведения звука, звук не образует цикла.
Значением по умолчанию является 0.
panEasingFunction | свойство |
public var panEasingFunction:Function| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Функция замедления для эффекта Pan. Эта функция используется для интерполяции в диапазоне между значениями panFrom и panTo.
panFrom | свойство |
public var panFrom:Number| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Начальное значение Pan звукового объекта. Значение может принадлежать диапазону от -1.0 до 1.0; при значении -1.0 используется только левый канал, а при значении 1.0 – только правый канал, при значении 0.0 звук равномерно сбалансирован между этими двумя каналами.
Значением по умолчанию является 0.0.
panTo | свойство |
public var panTo:Number| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Конечное значение Pan звукового объекта. Значение может принадлежать диапазону от -1.0 до 1.0; при значении -1.0 используется только левый канал, а при значении 1.0 – только правый канал, при значении 0.0 звук равномерно сбалансирован между этими двумя каналами.
Значением по умолчанию является 0.0.
sound | свойство |
source | свойство |
source:Object| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
URL или класс воспроизводимого файла MP3. Если уже имеется встроенный файл MP3, с помощью ключевого слова Embed можно передать объект Class файла MP3 в свойство source. В противном случае, следует указать полный URL-адрес файла MP3.
Реализация
public function get source():Object public function set source(value:Object):voidstartTime | свойство |
public var startTime:Number = 0| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Исходное положение в файле MP3 (в миллисекундах), с которого должно начинаться воспроизведение.
Значением по умолчанию является 0.
useDuration | свойство |
public var useDuration:Boolean = true| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
В случае значения true воспроизведение эффекта прекращается по истечении времени, указанного свойством duration. Если значение равно false, воспроизведение эффекта прекращается после завершения воспроизведения файла MP3 или выполнения цикла.
Значением по умолчанию является true.
volumeEasingFunction | свойство |
public var volumeEasingFunction:Function| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Функция замедления для эффекта Volume. Эта функция используется для интерполяции в диапазоне между значениями volumeFrom и volumeTo.
volumeFrom | свойство |
public var volumeFrom:Number| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Начальное значение Volume звукового объекта. Допустимыми являются значения от 0,0 до 1,0.
Значением по умолчанию является 1.
volumeTo | свойство |
public var volumeTo:Number| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Конечное значение Volume звукового объекта. Допустимыми являются значения от 0,0 до 1,0.
Значением по умолчанию является 1.
SoundEffect | () | Конструктор |
load | () | метод |
public function load():void| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Загружает MP3, если свойство source указывает на URL-адрес.
complete | Событие |
flash.events.Eventсвойство Event.type =
flash.events.Event.COMPLETE| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Отправляется по завершении загрузки звукового файла.
КонстантаEvent.COMPLETE определяет значение свойства type объекта complete.
Это событие имеет следующие свойства:
| Свойство | Значение |
|---|---|
bubbles | false |
cancelable | false; поведение по умолчанию, подлежащее отмене, не определено. |
currentTarget | Объект, активно обрабатывающий объект Event с помощью прослушивателя событий. |
target | Сетевой объект, который завершил загрузку. |
id3 | Событие |
flash.events.Eventсвойство Event.type =
flash.events.Event.ID3| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Отправляется, если для звукового файла MP3 доступны данные ID3.
КонстантаEvent.ID3 определяет значение свойства type объекта события id3.
Это событие имеет следующие свойства:
| Свойство | Значение |
|---|---|
bubbles | false |
cancelable | false; поведение по умолчанию, подлежащее отмене, не определено. |
currentTarget | Объект, активно обрабатывающий объект Event с помощью прослушивателя событий. |
target | Объект Sound, загружающий MP3, для которого уже стали доступными данные ID3. Свойство target не всегда является объектом из списка отображения, для которого зарегистрирован прослушиватель событий. Используйте свойство currentTarget для обращения к объекту в списке отображения, обрабатывающему событие в данный момент. |
ioError | Событие |
flash.events.IOErrorEventсвойство IOErrorEvent.type =
flash.events.IOErrorEvent.IO_ERROR| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Отправляется, если при загрузке звукового файла произошла ошибка.
Задает значение свойстваtype для объекта события ioError.
Это событие имеет следующие свойства:
| Свойство | Значение |
|---|---|
bubbles | false |
cancelable | false; поведение по умолчанию, подлежащее отмене, не определено. |
currentTarget | Объект, активно обрабатывающий объект Event с помощью прослушивателя событий. |
errorID | Ссылочный номер, связываемый с конкретной ошибкой (только AIR). |
target | Сетевой объект, с которым произошла ошибка ввода/вывода. |
text | Текст, отображаемый в качестве сообщения об ошибке. |
progress | Событие |
flash.events.ProgressEventсвойство ProgressEvent.type =
flash.events.ProgressEvent.PROGRESS| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Отправляется периодически по мере загрузки звукового файла.
В объекте события можно получить доступ к информации о количестве загруженных в настоящее время байтов и об общем количестве байтов, которые требуется загрузить. Отправка события не является обязательной, т. е. событие complete может быть отправлено без отправки каких-либо событий progress.
type для объекта события progress.
Это событие имеет следующие свойства:
| Свойство | Значение |
|---|---|
bubbles | false |
bytesLoaded | Число элементов или байтов, загруженных на момент обработки события прослушивателем. |
bytesTotal | Общее число элементов или байтов, которые в итоге будут получены в случае успешного завершения загрузки. |
cancelable | false; поведение по умолчанию, подлежащее отмене, не определено. |
currentTarget | Объект, активно обрабатывающий объект Event с помощью прослушивателя событий. |
target | Объект, сообщающий сведения о прогрессе. |
<?xml version="1.0"?>
<!-- Simple example to demonstrate the SoundEffect effect. -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
xmlns:s="library://ns.adobe.com/flex/spark"
xmlns:mx="library://ns.adobe.com/flex/mx">
<fx:Declarations>
<mx:SoundEffect id="mySounds" source="@Embed(source='assets/jazz.mp3')"/>
</fx:Declarations>
<s:Panel title="Sound Effect Example" width="75%" height="75%" >
<s:VGroup left="20" right="20" top="20" bottom="20">
<s:Label width="100%" color="blue"
text="Click on the phone to hear the sound effect."/>
<mx:Image id="flex" source="@Embed(source='assets/Nokia_6630.png')"
mouseDownEffect="{mySounds}"/>
</s:VGroup>
</s:Panel>
</s:Application>
Tue Jun 12 2018, 11:34 AM Z