Arcade
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
GameAPI.BudgetBoy.Audio Class Reference

Peripheral providing an interface with the BudgetBoy audio hardware. More...

Inheritance diagram for GameAPI.BudgetBoy.Audio:
GameAPI.AudioBase< TGame, TImplementation > GameAPI.Peripheral< TGame, TProvider, TImplementation > GameAPI.Peripheral

Classes

class  SoundPlayedEventArgs
 
class  SoundStoppedEventArgs
 

Public Member Functions

Sound GetSound (String location)
 Get a Sound resource from the specified location. Supports .wav and .mp3 files. More...
 
- Public Member Functions inherited from GameAPI.AudioBase< TGame, TImplementation >
void CopyEvent (Stream stream)
 
- Public Member Functions inherited from GameAPI.Peripheral< TGame, TProvider, TImplementation >
override void Dispose ()
 

Protected Member Functions

override void OnRegisterResourceTypes (ResourceManager library)
 
override void OnLoadResources (Resources volume)
 
override void OnSerializeSetup (Stream stream)
 
- Protected Member Functions inherited from GameAPI.AudioBase< TGame, TImplementation >
override void OnCopyFrame (Stream stream)
 
override void OnUpdateFrame (double dt)
 
- Protected Member Functions inherited from GameAPI.Peripheral< TGame, TProvider, TImplementation >
override void OnInitialize ()
 
virtual void OnAttachImplementation ()
 
- Protected Member Functions inherited from GameAPI.Peripheral
void ClearFrameWriter ()
 
virtual void OnReset ()
 
virtual void OnDeserializeSetup (Stream stream)
 
virtual void OnStartControlling ()
 
virtual void OnStopControlling ()
 
virtual void OnDeserializeFrame (Stream stream)
 
virtual void OnSerializeFrame (Stream stream)
 

Additional Inherited Members

- Properties inherited from GameAPI.AudioBase< TGame, TImplementation >
int MaxChannels [get]
 The maximum number of individual sounds that can play concurrently. More...
 
- Properties inherited from GameAPI.Peripheral< TGame, TProvider, TImplementation >
virtual bool ShouldUpdate [get]
 
- Properties inherited from GameAPI.Peripheral
BinaryWriter FrameWriter [get]
 

Detailed Description

Peripheral providing an interface with the BudgetBoy audio hardware.

Member Function Documentation

Sound GameAPI.BudgetBoy.Audio.GetSound ( String  location)
inline

Get a Sound resource from the specified location. Supports .wav and .mp3 files.

Parameters
locationFile location relative to your game's root folder, without an extension.

// Retrieves a sound from "sounds/jump.wav" var jump = Audio.GetSound("sounds/jump");

override void GameAPI.BudgetBoy.Audio.OnLoadResources ( Resources  volume)
inlineprotectedvirtual

Reimplemented from GameAPI.Peripheral.

override void GameAPI.BudgetBoy.Audio.OnRegisterResourceTypes ( ResourceManager  library)
inlineprotectedvirtual

Reimplemented from GameAPI.Peripheral.

override void GameAPI.BudgetBoy.Audio.OnSerializeSetup ( Stream  stream)
inlineprotectedvirtual