Packageru.antkarlov.anthill
Classpublic class AntSoundManager
InheritanceAntSoundManager Inheritance Object

Language Version : ActionScript 3
Since : 05.09.2012
Runtime Versions : AIR 1.0, Flash Player 9.0.0

Звуковой менеджер используется для взаимодействия со звуковыми сущностями.



Public Properties
 PropertyDefined By
  baseURL : String
Базовый путь для потоковых звуков если они все находятся в одном месте.
AntSoundManager
  listeners : Array
Массив с указателями на слушателей звуков.
AntSoundManager
  mute : Boolean
Флаг определяющий возможно ли воспроизведение звуков.
AntSoundManager
  numSounds : int
Количество звуков в менеджере.
AntSoundManager
  radius : Number
Радиус в пределах которого слушатели могут слышать звуки.
AntSoundManager
  sounds : Array
Массив со всеми звуками которыми управляет данный менеджер.
AntSoundManager
  volume : Number
Общая громкость для всех звуков.
AntSoundManager
Protected Properties
 PropertyDefined By
  _classes : AntStorage
Хранилище классов на заэмбендженные звуки.
AntSoundManager
  _streams : AntStorage
Хранилище названий/путей до потоковых звуков.
AntSoundManager
Public Methods
 MethodDefined By
  
AntSoundManager
  
Добавляет экземпляр звука в менеджер.
AntSoundManager
  
addEmbedded(aSoundClass:Class, aName:String = null):void
Добавляет оригинальный класс звука.
AntSoundManager
  
Добавляет слушателя звуков в менеджер.
AntSoundManager
  
addStream(aURL:String, aName:String = null):void
Добавляет имя файла до потокового звука размещенного где-либо.
AntSoundManager
  
clear():void
Очищает все звуки и слушателей.
AntSoundManager
  
containsListener(aListener:AntEntity):Boolean
Проверяет наличие слушателя в менеджере.
AntSoundManager
  
getAvailable(aName:String):AntSound
Возвращает доступный звук с указанным именем.
AntSoundManager
  
isPlaying(aName:String, aSource:AntEntity = null):Boolean
Проверяет проигрывается ли звук с указанным именем.
AntSoundManager
  
numDead():int
Возвращает количество "мертвых" звуков.
AntSoundManager
  
numLiving():int
Возвращает количество воспроизводимых звуков.
AntSoundManager
  
pause():void
Ставит воспроизведение всех звуков на паузу.
AntSoundManager
  
play(aName:String, aSource:AntEntity = null, aSingle:Boolean = false, aRepeats:int = 1):AntSound
Запускает воспроизведение звука с указанным именем.
AntSoundManager
  
recycle(aName:String):AntSound
Возвращает ранее использованный или новый звук для нового использования.
AntSoundManager
  
remove(aSound:AntSound, aSplice:Boolean = false):AntSound
Удаляет экземпляр звука из менеджера.
AntSoundManager
  
removeListener(aListener:AntEntity, aSplice:Boolean = false):AntEntity
Удаляет слушателя звуков из менеджера.
AntSoundManager
  
resume():void
Возобновляет воспроизведение всех звуков.
AntSoundManager
  
stop(aName:String, aSource:AntEntity = null):void
Останавливает воспроизведение всех звуков с указанным именем.
AntSoundManager
  
stopAll(aSource:AntEntity = null):void
Останавливает воспроизведение всех звуков.
AntSoundManager
  
update():void
Обработчик всех звуков.
AntSoundManager
Protected Methods
 MethodDefined By
  
extractSound(aName:String):Sound
Извлекает звук с указанным именем из хранилища заэмбедженных звуков или из потоков.
AntSoundManager
Property Detail
_classesproperty
protected var _classes:AntStorage

Хранилище классов на заэмбендженные звуки.

_streamsproperty 
protected var _streams:AntStorage

Хранилище названий/путей до потоковых звуков.

baseURLproperty 
public var baseURL:String

Базовый путь для потоковых звуков если они все находятся в одном месте.

The default value is "".

listenersproperty 
public var listeners:Array

Массив с указателями на слушателей звуков. Если нет ни одного слушателя, то для звуков с источниками рассчитывается стерео-эффект исходя из наличия и положения камер.

muteproperty 
public var mute:Boolean

Флаг определяющий возможно ли воспроизведение звуков.

The default value is false.

numSoundsproperty 
public var numSounds:int

Количество звуков в менеджере. Может отличаться от реального количества звуков.

radiusproperty 
public var radius:Number

Радиус в пределах которого слушатели могут слышать звуки. Используется для рассчета стерео-эффекта.

The default value is 500.

soundsproperty 
public var sounds:Array

Массив со всеми звуками которыми управляет данный менеджер.

volumeproperty 
public var volume:Number

Общая громкость для всех звуков.

The default value is 1.

Constructor Detail
AntSoundManager()Constructor
public function AntSoundManager()

Method Detail
add()method
public function add(aSound:AntSound):AntSound

Добавляет экземпляр звука в менеджер.

Parameters

aSound:AntSound

Returns
AntSound — Возвращает указатель на добавленный экземпляр звука.
addEmbedded()method 
public function addEmbedded(aSoundClass:Class, aName:String = null):void

Добавляет оригинальный класс звука.

Parameters

aSoundClass:Class — Оригинальный класс звука который включен в fla или swc.
 
aName:String (default = null) — Имя звука по которому можно вызвать его воспроизведение. Если имя не указано, то звук будет доступен по имени оригинального класса.

addListener()method 
public function addListener(aListener:AntEntity):AntEntity

Добавляет слушателя звуков в менеджер. Слушателем звуков является персонаж или некий объект исходя из положения которого рассчитывается стерео-эффект для звуков.

Примечание: Если менеджер звуков не имеет ни одного слушателя, то стерео-эффект для звуков рассчитывается на основе камер. То есть в таком случае слушателями будут центры камер.

Внимание: Стерео-эффект рассчитывается для звуков только в том случае, если для них указан объект источник.

Parameters

aListener:AntEntity — Слушатель которого необходимо добавить.

Returns
AntEntity — Возвращает указатель на добавленного слушателя.
addStream()method 
public function addStream(aURL:String, aName:String = null):void

Добавляет имя файла до потокового звука размещенного где-либо.

Внимание: В качестве потоковых звуков могут быть файлы только в формате mp3.

Parameters

aURL:String — Путь и/или имя файла.
 
aName:String (default = null) — Имя звука по которому можно вызвать его воспроизведение. Если имя не указано, то звук будет доступен по указанному пути и/или имени файла.

clear()method 
public function clear():void

Очищает все звуки и слушателей.

containsListener()method 
public function containsListener(aListener:AntEntity):Boolean

Проверяет наличие слушателя в менеджере.

Parameters

aListener:AntEntity — Слушател наличие которого необходимо проверить.

Returns
Boolean — Возвращает true если слушатель уже добавлен в менеджер.
extractSound()method 
protected function extractSound(aName:String):Sound

Извлекает звук с указанным именем из хранилища заэмбедженных звуков или из потоков.

Parameters

aName:String — Имя звука который необходимо получить.

Returns
Sound — Возвращает указатель на экземпляр звука.
getAvailable()method 
public function getAvailable(aName:String):AntSound

Возвращает доступный звук с указанным именем.

Parameters

aName:String — Имя звука который необходимо получить.

Returns
AntSound — Возвращает указатель на доступный звук или null если доступных звуков с указанным именем нет.
isPlaying()method 
public function isPlaying(aName:String, aSource:AntEntity = null):Boolean

Проверяет проигрывается ли звук с указанным именем. Если источник звука не указан, то проверяются все звуки с указанным именем, иначе проигрывание звуков с указанным имемен для указанного источника.

Parameters

aName:String — Сущность для которой необходимо проверить наличие проигрываемого звука.
 
aSource:AntEntity (default = null)

Returns
Boolean — Возвращает true если звук с указанным именем проигрывается
numDead()method 
public function numDead():int

Возвращает количество "мертвых" звуков.

Returns
int — Возвращает количество не используемых звуков.
numLiving()method 
public function numLiving():int

Возвращает количество воспроизводимых звуков.

Returns
int — Возвращает количество звуков которые воспроизводятся в данный момент времени.
pause()method 
public function pause():void

Ставит воспроизведение всех звуков на паузу.

play()method 
public function play(aName:String, aSource:AntEntity = null, aSingle:Boolean = false, aRepeats:int = 1):AntSound

Запускает воспроизведение звука с указанным именем.

Parameters

aName:String — Имя звука который необходимо воспроизвести.
 
aSource:AntEntity (default = null) — Объект-источник звука.
 
aSingle:Boolean (default = false) — Флаг определяющий могут ли быть запущены иные копии данного звука.
 
aRepeats:int (default = 1) — Количество повторов воспроизведения звука.

Returns
AntSound — Возвращает указатель на экземпляр звука.
recycle()method 
public function recycle(aName:String):AntSound

Возвращает ранее использованный или новый звук для нового использования.

Parameters

aName:String — Имя звука который необходимо получить.

Returns
AntSound — Возвращает указатель на экземпляр звука для использования.
remove()method 
public function remove(aSound:AntSound, aSplice:Boolean = false):AntSound

Удаляет экземпляр звука из менеджера.

Parameters

aSound:AntSound — Звук который необходимо удалить.
 
aSplice:Boolean (default = false) — Флаг определяющий необходимо ли удалить так же ячейку которую занимал удаляемый звук.

Returns
AntSound — Возвращает указатель на удаленный звук.
removeListener()method 
public function removeListener(aListener:AntEntity, aSplice:Boolean = false):AntEntity

Удаляет слушателя звуков из менеджера.

Parameters

aListener:AntEntity — Слушатель которого необходимо удалить.
 
aSplice:Boolean (default = false) — Если true, то ячейка занимаемая слушателем звуков в массиве так же будет удалена.

Returns
AntEntity — Возвращает указатель на удаленного слушателя.
resume()method 
public function resume():void

Возобновляет воспроизведение всех звуков.

stop()method 
public function stop(aName:String, aSource:AntEntity = null):void

Останавливает воспроизведение всех звуков с указанным именем. Если источник звука не указан, то будут остановлены все звуки с указанным именем, иначе только звуки с указанным именем для указанного источника звука.

Parameters

aName:String — Имя звуков которые необходимо остановить.
 
aSource:AntEntity (default = null) — Сущность для которой необходимо остановить воспроизведение звуков с указанным именем.

stopAll()method 
public function stopAll(aSource:AntEntity = null):void

Останавливает воспроизведение всех звуков. Если указан источник звука, то будет остановлено воспроизведение всех звуков только для указанного источника. Если источник звука не указан, то будут остановлены абсолютно все звуки.

Parameters

aSource:AntEntity (default = null) — Сущность для которой необходимо остановить воспроизведение всех звуков.

update()method 
public function update():void

Обработчик всех звуков.