C# Class FlatRedBall.Audio.PositionedSound

A sound which has a position enabling effects such as doppler effect and distance-based volume adjustments.
Inheritance: PositionedObject
Show file Open project: vchelaru/FlatRedBall Class Usage Examples

Public Properties

Property Type Description
Variables SoundVariableCollection

Protected Properties

Property Type Description
mEmitter Microsoft.Xna.Framework.Audio.AudioEmitter
mSound Sound

Public Methods

Method Description
Pause ( ) : void

Pauses playback of this sound
Play ( ) : void

Begins playback of this sound, or resumes playback (if it has been paused)
PositionedSound ( Cue cue, String cueName, string soundBankFile ) : System
Stop ( ) : void

Stops playing this sound immediately
StopAsAuthored ( ) : void

Stops playing this sound as authored in the XACT project
StopImmediately ( ) : void

Stops playing this sound immediately

Private Methods

Method Description
UpdateAudio ( ) : void

Method Details

Pause() public method

Pauses playback of this sound
public Pause ( ) : void
return void

Play() public method

Begins playback of this sound, or resumes playback (if it has been paused)
public Play ( ) : void
return void

PositionedSound() public method

public PositionedSound ( Cue cue, String cueName, string soundBankFile ) : System
cue Microsoft.Xna.Framework.Audio.Cue
cueName String
soundBankFile string
return System

Stop() public method

Stops playing this sound immediately
public Stop ( ) : void
return void

StopAsAuthored() public method

Stops playing this sound as authored in the XACT project
public StopAsAuthored ( ) : void
return void

StopImmediately() public method

Stops playing this sound immediately
public StopImmediately ( ) : void
return void

Property Details

Variables public property

public SoundVariableCollection,FlatRedBall.Audio Variables
return SoundVariableCollection

mEmitter protected property

protected AudioEmitter,Microsoft.Xna.Framework.Audio mEmitter
return Microsoft.Xna.Framework.Audio.AudioEmitter

mSound protected property

protected Sound mSound
return Sound