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

Music object used for large music files, streaming from the file system More...

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

Public Member Functions

void Play ()
 Play the Music
void Pause ()
 Pause the Music
void Stop ()
 Stop the Music
void Dispose ()
 Used to explicitly free all resources currently in use by this object before destruction
bool IsDisposed ()
 Is this Music 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

TimeSpan Duration [get]
 Total duration of the music file
uint ChannelCount [get]
 Get the number of channels used by the music
uint SampleRate [get]
 Get the sample rate of the music file
SoundStatus Status [get]
 Get the current status of the Music object
TimeSpan PlayPosition [get, set]
 Get the current time position in the music object
bool Loop [get, set]
 Set if the music should loop when finished
float Pitch [get, set]
 Set the pitch of the music object
float Volume [get, set]
 Set the volume of the music object
float Attenuation [get, set]
 Find out the attenuation of the music object
bool Disposed [get, set]
 Is this Music disposed?

Detailed Description

Music object used for large music files, streaming from the file system

Member Function Documentation

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

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

bool MuGameFramework.Audio.Music.IsDisposed ( )

Is this Music disposed?

Returns
Is this Music disposed?

Implements MuGameFramework.IContent.

void MuGameFramework.Audio.Music.Pause ( )

Pause the Music

void MuGameFramework.Audio.Music.Play ( )

Play the Music

void MuGameFramework.Audio.Music.Stop ( )

Stop the Music

Property Documentation

float MuGameFramework.Audio.Music.Attenuation
getset

Find out the attenuation of the music object

uint MuGameFramework.Audio.Music.ChannelCount
get

Get the number of channels used by the music

bool MuGameFramework.Audio.Music.Disposed
getset

Is this Music disposed?

TimeSpan MuGameFramework.Audio.Music.Duration
get

Total duration of the music file

bool MuGameFramework.Audio.Music.Loop
getset

Set if the music should loop when finished

float MuGameFramework.Audio.Music.Pitch
getset

Set the pitch of the music object

TimeSpan MuGameFramework.Audio.Music.PlayPosition
getset

Get the current time position in the music object

uint MuGameFramework.Audio.Music.SampleRate
get

Get the sample rate of the music file

SoundStatus MuGameFramework.Audio.Music.Status
get

Get the current status of the Music object

float MuGameFramework.Audio.Music.Volume
getset

Set the volume of the music object


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