| 
 | Nestopia Core API | |||||||
| FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||
Base
   |
   +--Nes::Api::Sound
Sound interface.
| Inner Classes, Typedefs, and Enums | |
| enum | Nes::Api::Sound::ChannelSound channel types. | 
| typedef | Nes::Api::Sound::OutputSound output context. | 
| enum | Nes::Api::Sound::SpeakerSpeaker type. | 
| Constructor Summary | |
| Sound( T& instance )Interface constructor. | |
| Method Summary | |
|  void | EmptyBuffer()Empties the internal sound buffer. | 
|  uint | GetSampleBits() constReturns the sample bits. | 
|  ulong | GetSampleRate() constReturns the sample rate. | 
|  Nes::Api::Sound::Speaker | GetSpeaker() constReturns the speaker type. | 
|  uint | GetSpeed() constReturns the current speed. | 
|  uint | GetVolume( uint channel ) constReturns the volume of a channel. | 
|  bool | IsAudible() constChecks if sound is audible at all. | 
|  bool | IsAutoTransposing() constChecks if automatic transposing is enabled. | 
|  bool | IsMuted() constChecks if sound is muted. | 
|  void | Mute( bool mute )Mutes all sound. | 
|  void | SetAutoTranspose( bool state )Enables automatic transposition. | 
|  Result | SetSampleBits( uint bits )Sets the sample bits. | 
|  Result | SetSampleRate( ulong rate )Sets the sample rate. | 
|  void | SetSpeaker( Nes::Api::Sound::Speaker speaker )Sets the speaker type. | 
|  Result | SetSpeed( uint speed )Sets the speed. | 
|  Result | SetVolume( uint channels, uint volume )Sets one or more channel volumes. | 
| Constructor Detail | 
public Sound( T& instance );
instance - emulator instance| Method Detail | 
public void EmptyBuffer() throw();
public uint GetSampleBits() const throw();
public ulong GetSampleRate() const throw();
public Nes::Api::Sound::Speaker GetSpeaker() const throw();
public uint GetSpeed() const throw();
public uint GetVolume( uint channel ) const throw();
channel - channelpublic bool IsAudible() const throw();
public bool IsAutoTransposing() const throw();
public bool IsMuted() const throw();
public void Mute( bool mute ) throw();
mute - true to mute soundpublic void SetAutoTranspose( bool state ) throw();
state - true to enablepublic Result SetSampleBits( uint bits ) throw();
bits - value of 8 or 16, default is 16public Result SetSampleRate( ulong rate ) throw();
rate - value in the range 11025 to 96000, default is 44100public void SetSpeaker( Nes::Api::Sound::Speaker speaker ) throw();
speaker - speaker type, default is SPEAKER_MONOpublic Result SetSpeed( uint speed ) throw();
speed - speed in the range 30 to 240, set to DEFAULT_SPEED for automatic adjustmentpublic Result SetVolume( uint channels, uint volume ) throw();
channels - OR:ed channels
volume - volume in the range 0 to 100, default is 85| 
 | Nestopia Core API | |||||||
| FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||