Packageru.antkarlov.anthill
Classpublic class AntSound
InheritanceAntSound Inheritance AntBasic Inheritance Object

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

Сущность звука.

Примечание: Напрямую работать со звуками не рекомендуется. Работайте со звуками используя менеджер звуков AntSoundManager. Стандартный менеджер звуков инициализируется автоматически и доступен через AntG.sounds.



Public Properties
 PropertyDefined By
 Inheritedactive : Boolean
Определяет активность объекта.
AntBasic
 Inheritedalive : Boolean
Определяет "живой" объект или нет.
AntBasic
 InheritedallowDebugDraw : Boolean
Определяет следует ли для объекта выполнять отладочную отрисовку.
AntBasic
 Inheritedcameras : Array
Указатель на массив камер AntG.cameras.
AntBasic
 Inheritedexists : Boolean
Определеяет существование объекта.
AntBasic
  listeners : Array
Указатель на массив слушателей в менеджере звуков.
AntSound
  name : String
Имя звука.
AntSound
 InheritedNUM_OF_ACTIVE : int = 0
[static] Используется для автоматического подсчета активных объектов.
AntBasic
 InheritedNUM_OF_VISIBLE : int = 0
[static] Используется для автоматического подсчета видимых объектов.
AntBasic
 InheritedNUM_ON_SCREEN : int = 0
[static] Используется для автоматического подсчета количества объектов видимых камерами.
AntBasic
  parent : AntSoundManager
Указатель на менеджер звуков который управляет данным звуком.
AntSound
  source : AntEntity
[read-only] Возвращает указатель на источник звука.
AntSound
 Inheritedtag : int
Любое пользовательское значение которое может идентифицировать объект.
AntBasic
 InheriteduserData : Object
Указатель на любые пользовательские данные.
AntBasic
 Inheritedvisible : Boolean
Определяет видимость объекта.
AntBasic
  volume : Number
Определяет громкость звука.
AntSound
Protected Properties
 PropertyDefined By
  _fadeInTimer : Number
Помошник для реализации плавного увеличения громкости звука звука.
AntSound
  _fadeInTotal : Number
Помошник для реализации плавного увеличения громкости звука звука.
AntSound
  _fadeOutTimer : Number
Помошник для реализации плавного уменьшения громкости звука звука.
AntSound
  _fadeOutTotal : Number
Помошник для реализации плавного уменьшения громкости звука звука.
AntSound
  _panAdjust : Number
Текущее параномирование звука исходя из положения источника звука.
AntSound
  _paused : Boolean
Флаг определяющий установлено ли воспроизведение звука на паузу.
AntSound
  _pauseOnFadeOut : Boolean
Флаг определяющий следует ли поставить воспроизведение звука на паузу после того как будет завершено уменьшение громкости.
AntSound
  _pausePosition : Number
Позиция на которой звук был поставлен на паузу, используется для возобновления проигрывания с места где воспроизведение было остановлено.
AntSound
  _ratingPan : AntRating
Помошник для определения среднего параномирования при нескольких слушателях или камер.
AntSound
  _ratingVolume : AntRating
Помошник для определения среднего уровня громкости при нескольких слушателях или камер.
AntSound
  _repeats : int
Количество повторов воспроизведения звука.
AntSound
  _sound : Sound
Звук.
AntSound
  _soundChannel : SoundChannel
Звуковой канал.
AntSound
  _soundTransform : SoundTransform
Звуковая трансформация.
AntSound
  _source : AntEntity
Указатель на источник звука для рассчета стерео эффекта.
AntSound
  _volumeAdjust : Number
Текущая громкость звука исходя из положения источника звука.
AntSound
Public Methods
 MethodDefined By
  
AntSound(aName:String, aSound:Sound)
AntSound
 Inherited
debugDraw(aCamera:AntCamera):void
Отладочная отрисовка.
AntBasic
  
destroy():void
[override] Используется для уничтожения объекта и освобождения занимаемых им ресурсов.
AntSound
 Inherited
draw(aCamera:AntCamera):void
Вызывается каждый кадр после вызова метода postUpdate() для отрисовки объекта.
AntBasic
  
fadeIn(aSeconds:Number):void
Запускает плавное увеличение громкости звука.
AntSound
  
fadeOut(aSeconds:Number, aOnPause:Boolean = false):void
Запускает плавное уменьшение громкости звука.
AntSound
  
kill():void
[override] Вызывается когда объект необходимо временно "убить" и освободить для повторного использования.
AntSound
  
pause():void
Ставит проигрывание звука на паузу.
AntSound
  
play(aSource:AntEntity = null, aPosition:Number = 0, aRepeats:int = 1, aVolume:Number = 1):void
Запускает проигрывание звука.
AntSound
 Inherited
postUpdate():void
Вызывается каждый кадр сразу после вызова метода update();
AntBasic
 Inherited
preUpdate():void
Вызывается каждый кадр перед вызовом метода update().
AntBasic
  
resume():void
Продолжает проигрывание звука если он на паузе.
AntSound
 Inherited
revive():void
Воскрешает объект после "убийства" для повторного использования.
AntBasic
  
stop():void
Останавливает проигрывание звука.
AntSound
  
update():void
[override] Вызывается каждый кадр.
AntSound
  
Обработка стерео эффекта для звука.
AntSound
Protected Methods
 MethodDefined By
  
soundCompleteHandler(event:Event):void
Обработка события завершения воспроизведения звука.
AntSound
  
Рассчет стерео-эффекта для звука без слушателей.
AntSound
  
Рассчет стерео эффекта для звука со слушателями.
AntSound
  
updateFade():Number
Обработка затухания или увеличения громкости звука.
AntSound
  
Обновление трансформации звука.
AntSound
Property Detail
_fadeInTimerproperty
protected var _fadeInTimer:Number

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

_fadeInTotalproperty 
protected var _fadeInTotal:Number

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

_fadeOutTimerproperty 
protected var _fadeOutTimer:Number

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

_fadeOutTotalproperty 
protected var _fadeOutTotal:Number

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

_panAdjustproperty 
protected var _panAdjust:Number

Текущее параномирование звука исходя из положения источника звука.

_pausedproperty 
protected var _paused:Boolean

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

_pauseOnFadeOutproperty 
protected var _pauseOnFadeOut:Boolean

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

_pausePositionproperty 
protected var _pausePosition:Number

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

_ratingPanproperty 
protected var _ratingPan:AntRating

Помошник для определения среднего параномирования при нескольких слушателях или камер.

_ratingVolumeproperty 
protected var _ratingVolume:AntRating

Помошник для определения среднего уровня громкости при нескольких слушателях или камер.

_repeatsproperty 
protected var _repeats:int

Количество повторов воспроизведения звука.

_soundproperty 
protected var _sound:Sound

Звук.

_soundChannelproperty 
protected var _soundChannel:SoundChannel

Звуковой канал.

_soundTransformproperty 
protected var _soundTransform:SoundTransform

Звуковая трансформация.

_sourceproperty 
protected var _source:AntEntity

Указатель на источник звука для рассчета стерео эффекта. Если источник не указан, то стерео эффект не рассчитывается.

The default value is null.

_volumeAdjustproperty 
protected var _volumeAdjust:Number

Текущая громкость звука исходя из положения источника звука.

listenersproperty 
public var listeners:Array

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

nameproperty 
public var name:String

Имя звука.

parentproperty 
public var parent:AntSoundManager

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

sourceproperty 
source:AntEntity  [read-only]

Возвращает указатель на источник звука.


Implementation
    public function get source():AntEntity
volumeproperty 
volume:Number

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


Implementation
    public function get volume():Number
    public function set volume(value:Number):void
Constructor Detail
AntSound()Constructor
public function AntSound(aName:String, aSound:Sound)

Parameters
aName:String
 
aSound:Sound
Method Detail
destroy()method
override public function destroy():void

Используется для уничтожения объекта и освобождения занимаемых им ресурсов. Перекройте этот метод чтобы корректно освобождать используемые ресурсы при уничтожении объекта.

fadeIn()method 
public function fadeIn(aSeconds:Number):void

Запускает плавное увеличение громкости звука.

Parameters

aSeconds:Number — Время в секундах в течении которого будет выполнятся увеличение громкости.

fadeOut()method 
public function fadeOut(aSeconds:Number, aOnPause:Boolean = false):void

Запускает плавное уменьшение громкости звука.

Parameters

aSeconds:Number — Время в секундах в течении которого будет выполнятся уменьшение громкости.
 
aOnPause:Boolean (default = false) — Флаг определяющий необходимо ли поставить воспроизводимый звук на паузу после завершения процесса затухания.

kill()method 
override public function kill():void

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

pause()method 
public function pause():void

Ставит проигрывание звука на паузу.

play()method 
public function play(aSource:AntEntity = null, aPosition:Number = 0, aRepeats:int = 1, aVolume:Number = 1):void

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

Parameters

aSource:AntEntity (default = null) — Источник звука, необходимо указывать для рассчета стерео эффекта.
 
aPosition:Number (default = 0) — Позиция с какого места начинать проигрывание звука.
 
aRepeats:int (default = 1) — Количество повторов проигрывания.
 
aVolume:Number (default = 1) — Громкость воспроизведения звука.

resume()method 
public function resume():void

Продолжает проигрывание звука если он на паузе.

soundCompleteHandler()method 
protected function soundCompleteHandler(event:Event):void

Обработка события завершения воспроизведения звука.

Parameters

event:Event

soundForCenter()method 
protected function soundForCenter():void

Рассчет стерео-эффекта для звука без слушателей.

soundForListeners()method 
protected function soundForListeners():void

Рассчет стерео эффекта для звука со слушателями.

stop()method 
public function stop():void

Останавливает проигрывание звука.

update()method 
override public function update():void

Вызывается каждый кадр.

updateFade()method 
protected function updateFade():Number

Обработка затухания или увеличения громкости звука.

Returns
Number
updateSound()method 
public function updateSound():void

Обработка стерео эффекта для звука.

updateTransform()method 
protected function updateTransform():void

Обновление трансформации звука.