The SoundChannel class controls a sound in an application. Every sound is assigned to a sound channel, and the application can have multiple sound channels that are mixed together. The SoundChannel class contains a stop() method, properties for monitoring the amplitude (volume) of the channel, and a property for assigning a SoundTransform object to the channel.


SoundChannel inherited from EventDispatcher


Can be created from Sound.play method.


Created SoundChannel has properties:

leftPeak

The current amplitude(volume) of the left channel, from 0(silent) to 1 (full amplitude).

read-only

rightPeak

The current amplitude (volume) of the right channel, from 0 (silent) to 1 (full amplitude).

read-only

position

When the sound is playing, the position property indicates in milliseconds the current point that is being played in the sound file.

read-only

soundTransform

The SoundTransform object assigned to the sound channel. A SoundTransform object includes properties for setting volume, panning.


methods:

stop()

Stops the sound playing in the channel.


events:

Lib.Media.Events.Event.SOUND_COMPLETE

Dispatched when a sound has finished playing.

Created with the Personal Edition of HelpNDoc: Easy EBook and documentation generator