MuGameFramework  1.0
MuGameFramework is a 2D game framework built upon C# and SFML
 All Classes Namespaces Files Functions Variables Enumerations Properties
MuGameFramework.Audio.SoundBuffer Class Reference

SoundBuffer object for holding a music file in memory More...

Inheritance diagram for MuGameFramework.Audio.SoundBuffer:
MuGameFramework.IContent

Public Member Functions

Sound GetSoundEffect ()
 Get a new copy of this sound effect to play
void Dispose ()
 Used to explicitly free all resources currently in use by this object before destruction
bool IsDisposed ()
 Is this AudioObject disposed?
- Public Member Functions inherited from MuGameFramework.IContent
void LoadContent (string fileToLoad)
 Load a file into this object (if file is not already loaded into it)

Protected Member Functions

virtual void Dispose (bool disposing)
 Dispose any and all objects, either managed or unmanaged at the end of this objects lifespan

Properties

bool Disposed [get, set]
 Is this Texture disposed?
uint ChannelCount [get]
 Get the number of channels used by the sound
uint Duration [get]
 Get the duration of the sound file
uint SampleRate [get]
 Get the sample rate of the sound file
int SampleCount [get]
 Get the number of samples used by the sound file

Detailed Description

SoundBuffer object for holding a music file in memory

Member Function Documentation

virtual void MuGameFramework.Audio.SoundBuffer.Dispose ( bool  disposing)
protectedvirtual

Dispose any and all objects, either managed or unmanaged at the end of this objects lifespan

Parameters
disposingDispose of Managed objects?
void MuGameFramework.Audio.SoundBuffer.Dispose ( )

Used to explicitly free all resources currently in use by this object before destruction

Sound MuGameFramework.Audio.SoundBuffer.GetSoundEffect ( )

Get a new copy of this sound effect to play

Returns
New copy of this sound effect
bool MuGameFramework.Audio.SoundBuffer.IsDisposed ( )

Is this AudioObject disposed?

Returns
Is this AudioObject disposed?

Implements MuGameFramework.IContent.

Property Documentation

uint MuGameFramework.Audio.SoundBuffer.ChannelCount
get

Get the number of channels used by the sound

bool MuGameFramework.Audio.SoundBuffer.Disposed
getset

Is this Texture disposed?

uint MuGameFramework.Audio.SoundBuffer.Duration
get

Get the duration of the sound file

int MuGameFramework.Audio.SoundBuffer.SampleCount
get

Get the number of samples used by the sound file

uint MuGameFramework.Audio.SoundBuffer.SampleRate
get

Get the sample rate of the sound file


The documentation for this class was generated from the following file: