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

Sound object for playing a Soundbuffer from mebory - used for small soundbytes, sound effects More...

Public Member Functions

void Play ()
 Play the Sound Effect
void Pause ()
 Pause the Sound Effect
void Stop ()
 Stop the Sound Effect
void Dispose ()
 Used to explicitly free all resources currently in use by this object before destruction
bool IsDisposed ()
 Is this Music disposed?

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

SoundStatus Status [get]
 Get the current status of the Audio object
TimeSpan PlayPosition [get, set]
 Get the current time position in the audio object
bool Loop [get, set]
 Set if the audio should loop when finished
float Pitch [get, set]
 Set the pitch of the audio object
float Volume [get, set]
 Set the volume of the audio object
float Attenuation [get, set]
 Find out the attenuation of the audio object
bool Disposed [get, set]
 Is this Audio disposed?

Detailed Description

Sound object for playing a Soundbuffer from mebory - used for small soundbytes, sound effects

Member Function Documentation

virtual void MuGameFramework.Audio.Sound.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.Sound.Dispose ( )

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

bool MuGameFramework.Audio.Sound.IsDisposed ( )

Is this Music disposed?

Returns
Is this Music disposed?
void MuGameFramework.Audio.Sound.Pause ( )

Pause the Sound Effect

void MuGameFramework.Audio.Sound.Play ( )

Play the Sound Effect

void MuGameFramework.Audio.Sound.Stop ( )

Stop the Sound Effect

Property Documentation

float MuGameFramework.Audio.Sound.Attenuation
getset

Find out the attenuation of the audio object

bool MuGameFramework.Audio.Sound.Disposed
getset

Is this Audio disposed?

bool MuGameFramework.Audio.Sound.Loop
getset

Set if the audio should loop when finished

float MuGameFramework.Audio.Sound.Pitch
getset

Set the pitch of the audio object

TimeSpan MuGameFramework.Audio.Sound.PlayPosition
getset

Get the current time position in the audio object

SoundStatus MuGameFramework.Audio.Sound.Status
get

Get the current status of the Audio object

float MuGameFramework.Audio.Sound.Volume
getset

Set the volume of the audio object


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