C# Class RecordRobot.AudioManager

Inheritance: Microsoft.Xna.Framework.GameComponent

Show file Open project: scastle/EECS290_Project1 Class Usage Examples

Public Properties

Property	Type	Description
PauseMusicVolumeBackup	float

Public Methods

Method	Description
AudioManager ( Microsoft.Xna.Framework.Game game ) : System	Creates a new Audio Manager.
FadeSong ( float targetVolume, System.TimeSpan duration ) : void	Smoothly transition between two volumes.
LoadSong ( string songName ) : void	Load a Song
LoadSong ( string songName, string songPath ) : void	Loads a Song
LoadSound ( string soundName, string soundPath ) : void	Loads a SoundEffect
PauseSong ( ) : void	Pauses the currently playing song. This is a no-op if the song is already paused, or if no song is currently playing.
PlaySound ( string soundType ) : void	Plays the sound of the given name
PlaySound ( string soundType, float volume ) : void	Plays the sound of the given name at the given volume
PlaySound ( string soundName, float volume, float pitch, float pan ) : void	Plays the sound of the given name with parameters
ResumeSong ( ) : void	Resumes the currently paused song. This is a no-op if the song is not paused, or if no song is currently playing.
SongPlay ( string songName ) : void	Starts playing the song with the given name. If it is already playing, this method does nothing. If another song is currently playing, it is stopped first.
SongPlay ( string songName, bool loop ) : void	Starts playing the song with the given name. If it is already playing, this method does nothing. If another song is currently playing, it is stopped first.
StopAllSounds ( ) : void	Stops all currently playing sounds.
StopSong ( ) : void	Stops the currently playing song. This is a no-op if no song is currently playing.
Update ( GameTime gameTime ) : void	Called per loop unless Enabled is set to false.

Protected Methods

Method	Description
OnEnabledChanged ( object sender, EventArgs args ) : void

Private Methods

Method	Description
GetAvailableSoundIndex ( ) : int

Method Details

AudioManager() public method

Creates a new Audio Manager.

public AudioManager ( Microsoft.Xna.Framework.Game game ) : System
game	Microsoft.Xna.Framework.Game	The Game
return	System

FadeSong() public method

Smoothly transition between two volumes.

public FadeSong ( float targetVolume, System.TimeSpan duration ) : void
targetVolume	float	Target volume, 0.0f to 1.0f
duration	System.TimeSpan	Length of volume transition
return	void

LoadSong() public method

Load a Song

public LoadSong ( string songName ) : void
songName	string	Name of the song to load
return	void

LoadSong() public method

Loads a Song

public LoadSong ( string songName, string songPath ) : void
songName	string	Name of the song
songPath	string	Path to the song
return	void

LoadSound() public method

Loads a SoundEffect

public LoadSound ( string soundName, string soundPath ) : void
soundName	string	Name of the sound to load
soundPath	string	Path to the song asset file
return	void

OnEnabledChanged() protected method

protected OnEnabledChanged ( object sender, EventArgs args ) : void
sender	object
args	System.EventArgs
return	void

PauseSong() public method

Pauses the currently playing song. This is a no-op if the song is already paused, or if no song is currently playing.

public PauseSong ( ) : void
return	void

PlaySound() public method

Plays the sound of the given name

public PlaySound ( string soundType ) : void
soundType	string
return	void

PlaySound() public method

Plays the sound of the given name at the given volume

public PlaySound ( string soundType, float volume ) : void
soundType	string
volume	float	Volume, 0.0f to 1.0f
return	void

PlaySound() public method

Plays the sound of the given name with parameters

public PlaySound ( string soundName, float volume, float pitch, float pan ) : void
soundName	string	Name of the sound
volume	float	Volume, 0.0f to 1.0f
pitch	float	Pitch, -1.0f (down one octave) to 1.0f (up one octave)
pan	float	Pan, -1.0f (full left) to 1.0f (full right)
return	void

ResumeSong() public method

Resumes the currently paused song. This is a no-op if the song is not paused, or if no song is currently playing.

public ResumeSong ( ) : void
return	void

SongPlay() public method

Starts playing the song with the given name. If it is already playing, this method does nothing. If another song is currently playing, it is stopped first.

public SongPlay ( string songName ) : void
songName	string	Name of the song to play
return	void

SongPlay() public method

Starts playing the song with the given name. If it is already playing, this method does nothing. If another song is currently playing, it is stopped first.

public SongPlay ( string songName, bool loop ) : void
songName	string	Name of the song to play
loop	bool	True if song should loop, false otherwise
return	void

StopAllSounds() public method

Stops all currently playing sounds.

public StopAllSounds ( ) : void
return	void

StopSong() public method

Stops the currently playing song. This is a no-op if no song is currently playing.

public StopSong ( ) : void
return	void

Update() public method

Called per loop unless Enabled is set to false.

public Update ( GameTime gameTime ) : void
gameTime	Microsoft.Xna.Framework.GameTime	Time elapsed since last frame
return	void

Property Details

PauseMusicVolumeBackup public property

public float PauseMusicVolumeBackup
return	float