ISoundController

PropertiesEvents
Packageispring.presenter.player.sound
Interfacepublic interface ISoundController extends flash.events.IEventDispatcher

Language Version : ActionScript 3.0
Product Versions : iSpring Pro 6.0.3, iSpring Platform 6.0
Runtime Versions : AIR 1.0, Flash Player 10.1

The ISoundController interface is used to control the sound volume level of the presentation.

To obtain the ISoundController interface from the presentation view use the soundController property on the IPresentationView interface. To obtain the ISoundController interface from the standalone slide view use the soundController property on the IStandaloneSlideView interface.

See also

ispring.presenter.player.IPresentationView.soundController
ispring.presenter.player.IStandaloneSlideView.soundController

Public Properties
PropertyDefined By
mute : Boolean
Indicates whether the sound is muted.
ISoundController
realVolume : Number
[read-only] Returns the real sound volume taking the mute state into account.
ISoundController
volume : Number
The volume, ranging from 0 (silent) to 1 (full volume).
ISoundController
Events
Event Summary Defined By
 
muteStateToggled
Dispatched when the mute state of the sound controller is toggled.ISoundController
 
realVolumeChanged
Dispatched when the real sound volume level is changed.ISoundController
 
volumeChanged
Dispatched when the sound volume level is changed.ISoundController
Property Detail
muteproperty
mute:Boolean

Language Version : ActionScript 3.0
Product Versions : iSpring Pro 6.0.3, iSpring Platform 6.0
Runtime Versions : AIR 1.0, Flash Player 10.1

Indicates whether the sound is muted.


Implementation
    public function get mute():Boolean
    public function set mute(value:Boolean):void

See also

volume
realVolume
realVolumeproperty 
realVolume:Number  [read-only]

Language Version : ActionScript 3.0
Product Versions : iSpring Pro 6.0.3, iSpring Platform 6.0
Runtime Versions : AIR 1.0, Flash Player 10.1

Returns the real sound volume taking the mute state into account.

If the sound is muted the realVolume property returns 0. Otherwise the value of the volume property is returned.


Implementation
    public function get realVolume():Number

See also

mute
volume
volumeproperty 
volume:Number

Language Version : ActionScript 3.0
Product Versions : iSpring Pro 6.0.3, iSpring Platform 6.0
Runtime Versions : AIR 1.0, Flash Player 10.1

The volume, ranging from 0 (silent) to 1 (full volume).


Implementation
    public function get volume():Number
    public function set volume(value:Number):void

See also

realVolume
mute
Event Detail
muteStateToggled Event
Event Object Type: ispring.presenter.player.sound.SoundControllerEvent
SoundControllerEvent.type property = ispring.presenter.player.sound.SoundControllerEvent.MUTE_STATE_TOGGLED

Language Version : ActionScript 3.0
Product Versions : iSpring Pro 6.0.3, iSpring Platform 6.0
Runtime Versions : AIR 1.0, Flash Player 10.1

Dispatched when the mute state of the sound controller is toggled.

The SoundControllerEvent.MUTE_STATE_TOGGLED constant defines the value of the type property of the event object for a muteStateToggled event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

See also

mute
realVolumeChanged Event  
Event Object Type: ispring.presenter.player.sound.SoundControllerEvent
SoundControllerEvent.type property = ispring.presenter.player.sound.SoundControllerEvent.REAL_VOLUME_CHANGED

Language Version : ActionScript 3.0
Product Versions : iSpring Pro 6.0.3, iSpring Platform 6.0
Runtime Versions : AIR 1.0, Flash Player 10.1

Dispatched when the real sound volume level is changed.

The SoundControllerEvent.REAL_VOLUME_CHANGED constant defines the value of the type property of the event object for a realVolumeChanged event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

See also

realVolume
volumeChanged Event  
Event Object Type: ispring.presenter.player.sound.SoundControllerEvent
SoundControllerEvent.type property = ispring.presenter.player.sound.SoundControllerEvent.VOLUME_CHANGED

Language Version : ActionScript 3.0
Product Versions : iSpring Pro 6.0.3, iSpring Platform 6.0
Runtime Versions : AIR 1.0, Flash Player 10.1

Dispatched when the sound volume level is changed.

The SoundControllerEvent.VOLUME_CHANGED constant defines the value of the type property of the event object for a volumeChanged event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

See also

volume




Tue Dec 4 2012, 06:27 PM +04:00