gs.audio.AudioObject

	Property	Defined by
		isPaused : Boolean [read-only] Check whether or not the sound is paused.	AudioObject
		isPlaying : Boolean [read-only] Check whether or not the sound is playing.	AudioObject
		panning : Number Panning.	AudioObject
		pixelsToFill : int The amount of pixels to fill for this audio object.	AudioObject
		pn : Number A tween property for panning.	AudioObject
		progressTimerInterval : int The interval for dispatching progress events.	AudioObject
		vl : Number A tween property for volume.	AudioObject
		volume : Number Volume.	AudioObject

	Method	Defined by
		AudioObject(_obj:*) Constructor for AudioObject instances.	AudioObject
		decreaseVolume(step:Number = .1):void Decrease the volume.	AudioObject
		dispose():void Dispose of this audible object.	AudioObject
		get(id:String):AudioObject [static] Get an audio object.	AudioObject
		increaseVolume(step:Number = .1):void Increase the volume.	AudioObject
		mute():void Mute.	AudioObject
		panTo(pan:Number, duration:Number = .3):void Tween the panning.	AudioObject
		pause():void Pause playing.	AudioObject
		percentPlayed():Number Get the percentage of the sound that has played.	AudioObject
		pixelsPlayed():int Get the amount of pixels that have played.	AudioObject
		play(_ops:Object = null):void Play this audio object.	AudioObject
		resume():void Resume playing.	AudioObject
		seek(position:Number):void Seek to a position in the sound.	AudioObject
		seekToPercent(percent:Number):void Seek to a percent of the sound.	AudioObject
		seekToPixel(pixel:Number):void Seek to a pixel (first set pixels to fill).	AudioObject
		set(id:String, ao:AudioObject):void [static] Save an audio object.	AudioObject
		setVolume(level:Number):void Set the volume.	AudioObject
		stop():void Stop playing.	AudioObject
		toggleMute():void Toggle mute.	AudioObject
		unMute():void Un-mute.	AudioObject
		unset(id:String):void [static] Unset (delete) an audio object.	AudioObject
		volumeTo(level:Number, duration:Number = .3):void Tween the volume.	AudioObject

Summary	Defined by
complete	Dispatched when the sound has completed playing.	AudioObject
looped	Dispatched when the sound has looped.	AudioObject
mute	Dispatched when the sound is muted.	AudioObject
panChange	Dispatched when the panning changes.	AudioObject
paused	Dispatched when the sound is paused.	AudioObject
progress	Dispatched for progress of the audio.	AudioObject
resumed	Dispatched when the sound is resumed.	AudioObject
start	Dispatched when the sound starts playing.	AudioObject
stop	Dispatched when the sound stops playing.	AudioObject
unmute	Dispatched when the sound is un-muted.	AudioObject
volumeChange	Dispatched when the volume changes	AudioObject

Property detail

isPaused

property

isPaused:Boolean [read-only]

Check whether or not the sound is paused.

Implementation
public function get isPaused():Boolean

isPlaying

property

isPlaying:Boolean [read-only]

Check whether or not the sound is playing.

Implementation
public function get isPlaying():Boolean

panning

property

panning:Number [read-write]

Panning.

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

pixelsToFill

property

pixelsToFill:int [read-write]

The amount of pixels to fill for this audio object.

Implementation
public function get pixelsToFill():int
public function set pixelsToFill(value:int):void

property

pn:Number [read-write]

A tween property for panning.

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

progressTimerInterval

property

progressTimerInterval:int [read-write]

The interval for dispatching progress events.

Implementation
public function get progressTimerInterval():int
public function set progressTimerInterval(value:int):void

property

vl:Number [read-write]

A tween property for volume.

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

volume

property

volume:Number [read-write]

Volume.

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

Constructor detail

AudioObject

()

constructor

public function AudioObject(_obj:*)

Constructor for AudioObject instances.

Parameters

_obj:* — The object to control.

Method detail

decreaseVolume

()

method

public function decreaseVolume(step:Number = .1):void

Decrease the volume.

Parameters

step:Number (default = .1) — The amount to decrease the volume by.

dispose

()

method

public function dispose():void

Dispose of this audible object.

get

()

method

public static function get(id:String):AudioObject

Get an audio object.

Parameters

id:String — The audio object id.

Returns

AudioObject

increaseVolume

()

method

public function increaseVolume(step:Number = .1):void

Increase the volume.

Parameters

step:Number (default = .1) — The amount to increase the volume by.

mute

()

method

public function mute():void

Mute.

panTo

()

method

public function panTo(pan:Number, duration:Number = .3):void

Tween the panning.

Parameters

	`pan:Number` — The new pan level.

	`duration:Number` (default = `.3`) — The time it takes to tween the panning.

pause

()

method

public function pause():void

Pause playing.

percentPlayed

()

method

public function percentPlayed():Number

Get the percentage of the sound that has played.

Returns

Number

pixelsPlayed

()

method

public function pixelsPlayed():int

Get the amount of pixels that have played.

Returns

int

play

()

method

public function play(_ops:Object = null):void

Play this audio object.

Available options:

volume (Number) - The volume to play the audio at.
startTime (Number) - A start offset in milliseconds to start playing the audio from.
loops (Number) - The number of times to loop the sound.
panning (Number) - A panning value for the audio.
restartIfPlaying (Boolean) - If this audible object is playing, and you call play again, it will (by defualt) not do anything, unless this option is true, which will restart the playing sound.

Parameters

_ops:Object (default = null) — Play options.

resume

()

method

public function resume():void

Resume playing.

seek

()

method

public function seek(position:Number):void

Seek to a position in the sound.

Parameters

position:Number — The position of the sound to seek to.

seekToPercent

()

method

public function seekToPercent(percent:Number):void

Seek to a percent of the sound.

Parameters

percent:Number — The percent to seek to.

seekToPixel

()

method

public function seekToPixel(pixel:Number):void

Seek to a pixel (first set pixels to fill).

Parameters

pixel:Number — The pixel to seek to.

set

()

method

public static function set(id:String, ao:AudioObject):void

Save an audio object.

Parameters

	`id:String` — The id of the audio group.

	`ao:AudioObject` — The audio group.

setVolume

()

method

public function setVolume(level:Number):void

Set the volume. This is a helper method in case you need to use setTimeout with volume.

Parameters

level:Number — The volume level.

stop

()

method

public function stop():void

Stop playing.

toggleMute

()

method

public function toggleMute():void

Toggle mute.

unMute

()

method

public function unMute():void

Un-mute.

unset

()

method

public static function unset(id:String):void

Unset (delete) an audio object.

Parameters

id:String — The audio object id.

volumeTo

()

method

public function volumeTo(level:Number, duration:Number = .3):void

Tween the volume.

Parameters

	`level:Number` — The new volume level.

	`duration:Number` (default = `.3`) — The time it takes to tween to the new level.

Event detail

complete

event

Event object type: gs.support.soundmanager.AudioEvent

Dispatched when the sound has completed playing.

looped

event

Event object type: gs.support.soundmanager.AudioEvent

Dispatched when the sound has looped.

mute

event

Event object type: gs.support.soundmanager.AudioEvent

Dispatched when the sound is muted.

panChange

event

Event object type: gs.support.soundmanager.AudioEvent

Dispatched when the panning changes.

paused

event

Event object type: gs.support.soundmanager.AudioEvent

Dispatched when the sound is paused.

progress

event

Event object type: gs.support.soundmanager.AudioEvent

Dispatched for progress of the audio.

resumed

event

Event object type: gs.support.soundmanager.AudioEvent

Dispatched when the sound is resumed.

start

event

Event object type: gs.support.soundmanager.AudioEvent

Dispatched when the sound starts playing.

stop

event

Event object type: gs.support.soundmanager.AudioEvent

Dispatched when the sound stops playing.

unmute

event

Event object type: gs.support.soundmanager.AudioEvent

Dispatched when the sound is un-muted.

volumeChange

event

Event object type: gs.support.soundmanager.AudioEvent

Dispatched when the volume changes

Guttershark Flash API Docs	All Packages \| All Classes \| Index \| Frames No Frames
Class AudioObject	Properties \| Methods \| Events

Package	gs.audio
Class	public class AudioObject
Inheritance	AudioObject flash.events.EventDispatcher