Jypeli 10
The simple game programming library
Julkiset jäsenfunktiot | Paketin funktiot | Ominaisuudet | Tapahtumat | Yksityiset jäsenfunktiot | Yksityiset attribuutit | Staattiset yksityiset attribuutit | Lista kaikista jäsenistä
Jypeli.SoundEffect luokkareferenssi

Ääniefekti. Yhdestä efektistä voi luoda CreateSound-metodilla monta ääntä (Sound), jotka voivat soida yhtäaikaa. Ääntä ei tarvitse kuitenkaan luoda itse, jos vain kutsuu Play-metodia. Lisää...

Julkiset jäsenfunktiot

Sound CreateSound ()
 Luo Sound-tyyppisen olion. Oliolla on ominaisuuksia kuten voimakkuus ja korkeus joita voidaan muuttaa soiton aikana. Lisää...
 
bool Play ()
 Soittaa äänen. Lisää...
 
bool Play (double volume, double pitch, double pan)
 Soittaa äänen. Lisää...
 
void Stop ()
 Pysäyttää äänen toistamisen. Lisää...
 

Paketin funktiot

 SoundEffect (string assetName)
 
 SoundEffect (XnaSoundEffect effect)
 

Ominaisuudet

TimeSpan Duration [get]
 Ääniefektin kesto sekunteina. Lisää...
 
bool IsPlaying [getprivate set]
 Toistetaanko ääntä parhaillaan. Lisää...
 
static double MasterVolume [getset]
 Äänenvoimakkuuden taso 0.0 - 1.0 Lisää...
 
DoubleMeter Position [getset]
 Paikka äänessä sekunteina (missä kohtaa toistoa ollaan). Ei voi asettaa. Lisää...
 

Tapahtumat

Action Finished
 Tapahtuu kun ääniefekti on toistettu loppuun. Lisää...
 

Yksityiset jäsenfunktiot

void DoLoad ()
 
void EffectPlayed ()
 
XnaSoundEffect FromContent (string assetname)
 
void IncrementPosition ()
 
void InitPosition ()
 
void StartPlaying (Sound sound)
 

Yksityiset attribuutit

string assetName
 
List< Sound > Instances = new List<Sound>()
 
Timer posTimer
 
XnaSoundEffect xnaEffect
 

Staattiset yksityiset attribuutit

static string[] soundExtensions = { ".wav", ".mp3", ".xnb" }
 

Yksityiskohtainen selite

Ääniefekti. Yhdestä efektistä voi luoda CreateSound-metodilla monta ääntä (Sound), jotka voivat soida yhtäaikaa. Ääntä ei tarvitse kuitenkaan luoda itse, jos vain kutsuu Play-metodia.

Määrittely tiedoston SoundEffect.cs rivillä 16.

Rakentajien & purkajien dokumentaatio

◆ SoundEffect() [1/2]

Jypeli.SoundEffect.SoundEffect ( string  assetName)
package

Määrittely tiedoston SoundEffect.cs rivillä 67.

Viittaukset Jypeli.SoundEffect.assetName ja Jypeli.SoundEffect.InitPosition().

◆ SoundEffect() [2/2]

Jypeli.SoundEffect.SoundEffect ( XnaSoundEffect  effect)
package

Määrittely tiedoston SoundEffect.cs rivillä 74.

Viittaukset Jypeli.SoundEffect.InitPosition(), Jypeli.SoundEffect.Position ja Jypeli.SoundEffect.xnaEffect.

Jäsenfunktioiden dokumentaatio

◆ CreateSound()

Sound Jypeli.SoundEffect.CreateSound ( )

Luo Sound-tyyppisen olion. Oliolla on ominaisuuksia kuten voimakkuus ja korkeus joita voidaan muuttaa soiton aikana.

Palauttaa

Määrittely tiedoston SoundEffect.cs rivillä 110.

Viittaukset Jypeli.Game.AudioEnabled, Jypeli.SoundEffect.DoLoad(), Jypeli.Game.Instance, Jypeli.Game.OnNoAudioHardwareException() ja Jypeli.SoundEffect.xnaEffect.

Viitattu Jypeli.SoundEffect.Play() ja Jypeli.MediaPlayer.Play().

◆ DoLoad()

void Jypeli.SoundEffect.DoLoad ( )
private

Määrittely tiedoston SoundEffect.cs rivillä 46.

Viittaukset Jypeli.SoundEffect.assetName, Jypeli.SoundEffect.FromContent(), Jypeli.Meter< ValueType >.MaxValue, Jypeli.SoundEffect.Position ja Jypeli.SoundEffect.xnaEffect.

Viitattu Jypeli.SoundEffect.CreateSound() ja Jypeli.SoundEffect.Play().

◆ EffectPlayed()

void Jypeli.SoundEffect.EffectPlayed ( )
private

Määrittely tiedoston SoundEffect.cs rivillä 96.

Viittaukset Jypeli.SoundEffect.Finished, Jypeli.SoundEffect.Instances, Jypeli.SoundEffect.IsPlaying, Jypeli.SoundEffect.Position, Jypeli.SoundEffect.posTimer, Jypeli.Meter< ValueType >.Reset() ja Jypeli.Timer.Stop().

Viitattu Jypeli.SoundEffect.InitPosition() ja Jypeli.SoundEffect.Stop().

◆ FromContent()

XnaSoundEffect Jypeli.SoundEffect.FromContent ( string  assetname)
private

Määrittely tiedoston SoundEffect.cs rivillä 58.

Viittaukset Jypeli.SoundEffect.assetName, Jypeli.Game.FileExtensionCheck() ja Jypeli.SoundEffect.soundExtensions.

Viitattu Jypeli.SoundEffect.DoLoad().

◆ IncrementPosition()

void Jypeli.SoundEffect.IncrementPosition ( )
private

Määrittely tiedoston SoundEffect.cs rivillä 91.

Viittaukset Jypeli.Timer.Interval, Jypeli.SoundEffect.Position, Jypeli.SoundEffect.posTimer ja Jypeli.Meter< ValueType >.Value.

Viitattu Jypeli.SoundEffect.InitPosition().

◆ InitPosition()

void Jypeli.SoundEffect.InitPosition ( )
private

Määrittely tiedoston SoundEffect.cs rivillä 82.

Viittaukset Jypeli.SoundEffect.EffectPlayed(), Jypeli.SoundEffect.IncrementPosition(), Jypeli.Timer.Interval, Jypeli.SoundEffect.Position, Jypeli.SoundEffect.posTimer, Jypeli.Timer.Timeout ja Jypeli.Meter< ValueType >.UpperLimit.

Viitattu Jypeli.SoundEffect.SoundEffect().

◆ Play() [1/2]

bool Jypeli.SoundEffect.Play ( )

Soittaa äänen.

Palauttaa

Määrittely tiedoston SoundEffect.cs rivillä 131.

Viittaukset Jypeli.SoundEffect.CreateSound(), Jypeli.SoundEffect.DoLoad() ja Jypeli.SoundEffect.StartPlaying().

Viitattu Jypeli.Game.PlaySound(), Jypeli.Assets.CollisionHandler.PlaySound() ja Jypeli.Assets.Weapon.Shoot().

◆ Play() [2/2]

bool Jypeli.SoundEffect.Play ( double  volume,
double  pitch,
double  pan 
)

Soittaa äänen.

Parametrit
volumeÄänenvoimakkuus 0.0 - 1.0
pitchÄänen taajuusmuutos. -1.0 = oktaavi alaspäin, 1.0 = oktaavi ylöspäin, 0.0 = normaali.
panBalanssi eli kummasta kaiuttimesta ääni kuuluu enemmän. -1.0 = kokonaan vasemmasta, 1.0 = kokonaan oikeasta, 0.0 = yhtä paljon kummastakin
Palauttaa

Määrittely tiedoston SoundEffect.cs rivillä 148.

Viittaukset Jypeli.SoundEffect.CreateSound(), Jypeli.SoundEffect.DoLoad(), Jypeli.Sound.Pan, Jypeli.Sound.Pitch, Jypeli.SoundEffect.StartPlaying() ja Jypeli.Sound.Volume.

◆ StartPlaying()

void Jypeli.SoundEffect.StartPlaying ( Sound  sound)
private

Määrittely tiedoston SoundEffect.cs rivillä 162.

Viittaukset Jypeli.SoundEffect.Instances, Jypeli.SoundEffect.IsPlaying, Jypeli.Sound.Play(), Jypeli.SoundEffect.Position, Jypeli.SoundEffect.posTimer, Jypeli.Meter< ValueType >.Reset() ja Jypeli.Timer.Start().

Viitattu Jypeli.SoundEffect.Play().

◆ Stop()

void Jypeli.SoundEffect.Stop ( )

Pysäyttää äänen toistamisen.

Määrittely tiedoston SoundEffect.cs rivillä 182.

Viittaukset Jypeli.SoundEffect.EffectPlayed() ja Jypeli.SoundEffect.Instances.

Jäsendatan dokumentaatio

◆ assetName

string Jypeli.SoundEffect.assetName
private

Määrittely tiedoston SoundEffect.cs rivillä 20.

Viitattu Jypeli.SoundEffect.SoundEffect(), Jypeli.SoundEffect.DoLoad() ja Jypeli.SoundEffect.FromContent().

◆ Instances

List<Sound> Jypeli.SoundEffect.Instances = new List<Sound>()
private

Määrittely tiedoston SoundEffect.cs rivillä 18.

Viitattu Jypeli.SoundEffect.EffectPlayed(), Jypeli.SoundEffect.StartPlaying() ja Jypeli.SoundEffect.Stop().

◆ posTimer

Timer Jypeli.SoundEffect.posTimer
private

Määrittely tiedoston SoundEffect.cs rivillä 22.

Viitattu Jypeli.SoundEffect.EffectPlayed(), Jypeli.SoundEffect.IncrementPosition(), Jypeli.SoundEffect.InitPosition() ja Jypeli.SoundEffect.StartPlaying().

◆ soundExtensions

string [] Jypeli.SoundEffect.soundExtensions = { ".wav", ".mp3", ".xnb" }
staticprivate

Määrittely tiedoston SoundEffect.cs rivillä 44.

Viitattu Jypeli.SoundEffect.FromContent().

◆ xnaEffect

XnaSoundEffect Jypeli.SoundEffect.xnaEffect
private

Määrittely tiedoston SoundEffect.cs rivillä 21.

Viitattu Jypeli.SoundEffect.SoundEffect(), Jypeli.SoundEffect.CreateSound() ja Jypeli.SoundEffect.DoLoad().

Ominaisuuksien dokumentaatio

◆ Duration

TimeSpan Jypeli.SoundEffect.Duration
get

Ääniefektin kesto sekunteina.

Määrittely tiedoston SoundEffect.cs rivillä 32.

◆ IsPlaying

bool Jypeli.SoundEffect.IsPlaying
getprivate set

Toistetaanko ääntä parhaillaan.

Määrittely tiedoston SoundEffect.cs rivillä 42.

Viitattu Jypeli.SoundEffect.EffectPlayed() ja Jypeli.SoundEffect.StartPlaying().

◆ MasterVolume

double Jypeli.SoundEffect.MasterVolume
staticgetset

Äänenvoimakkuuden taso 0.0 - 1.0

Määrittely tiedoston SoundEffect.cs rivillä 195.

◆ Position

DoubleMeter Jypeli.SoundEffect.Position
getset

Paikka äänessä sekunteina (missä kohtaa toistoa ollaan). Ei voi asettaa.

Määrittely tiedoston SoundEffect.cs rivillä 37.

Viitattu Jypeli.SoundEffect.SoundEffect(), Jypeli.SoundEffect.DoLoad(), Jypeli.SoundEffect.EffectPlayed(), Jypeli.SoundEffect.IncrementPosition(), Jypeli.SoundEffect.InitPosition() ja Jypeli.SoundEffect.StartPlaying().

Tapahtumien dokumentaatio

◆ Finished

Action Jypeli.SoundEffect.Finished

Tapahtuu kun ääniefekti on toistettu loppuun.

Määrittely tiedoston SoundEffect.cs rivillä 27.

Viitattu Jypeli.SoundEffect.EffectPlayed().

Dokumentaatio tälle luokalle luotiin seuraavasta tiedostosta: