SoundOutput interface in ClanLib.  
 More...
#include <soundoutput.h>
SoundOutput interface in ClanLib. 
SoundOutput is the interface to a sound output device. It is used to control the main mixer volume and other global settings.
◆ SoundOutput() [1/3]
      
        
          | clan::SoundOutput::SoundOutput | ( |  | ) |  | 
      
 
Constructs a null instance. 
 
 
◆ SoundOutput() [2/3]
      
        
          | clan::SoundOutput::SoundOutput | ( | int | mixing_frequency, | 
        
          |  |  | int | latency = 50 ) | 
      
 
Constructs a SoundOutput. 
- Parameters
- 
  
    | mixing_frequency | = value |  | latency | = value |  
 
 
 
◆ SoundOutput() [3/3]
◆ ~SoundOutput()
  
  | 
        
          | virtual clan::SoundOutput::~SoundOutput | ( |  | ) |  |  | virtual | 
 
 
◆ add_filter()
      
        
          | void clan::SoundOutput::add_filter | ( | SoundFilter & | filter | ) |  | 
      
 
Adds the sound filter to the sound output. 
- Parameters
- 
  
    | filter | Sound filter to pass sound through. |  
 
 
 
◆ get_global_pan()
      
        
          | float clan::SoundOutput::get_global_pan | ( |  | ) | const | 
      
 
Returns the main panning position of the sound output. 
 
 
◆ get_global_volume()
      
        
          | float clan::SoundOutput::get_global_volume | ( |  | ) | const | 
      
 
Returns the main volume of the sound output. 
 
 
◆ get_mixing_frequency()
      
        
          | int clan::SoundOutput::get_mixing_frequency | ( |  | ) | const | 
      
 
Returns the mixing frequency for the sound output device. 
 
 
◆ get_mixing_latency()
      
        
          | int clan::SoundOutput::get_mixing_latency | ( |  | ) | const | 
      
 
Returns the mixing latency in milliseconds. 
 
 
◆ get_name()
      
        
          | const std::string & clan::SoundOutput::get_name | ( |  | ) | const | 
      
 
Name of the output device. 
 
 
◆ is_null()
  
  | 
        
          | bool clan::SoundOutput::is_null | ( |  | ) | const |  | inline | 
 
Returns true if this object is invalid. 
 
 
◆ remove_filter()
      
        
          | void clan::SoundOutput::remove_filter | ( | SoundFilter & | filter | ) |  | 
      
 
Remove the sound filter from the session. 
 
 
◆ set_global_pan()
      
        
          | void clan::SoundOutput::set_global_pan | ( | float | pan | ) |  | 
      
 
Sets the main panning position on the sound output. 
 
 
◆ set_global_volume()
      
        
          | void clan::SoundOutput::set_global_volume | ( | float | volume | ) |  | 
      
 
Sets the main/mixer volume on the sound output. 
 
 
◆ stop_all()
      
        
          | void clan::SoundOutput::stop_all | ( |  | ) |  | 
      
 
Stops all sample playbacks on the sound output. 
 
 
◆ throw_if_null()
      
        
          | void clan::SoundOutput::throw_if_null | ( |  | ) | const | 
      
 
Throw an exception if this object is invalid. 
 
 
◆ Sound
◆ SoundBuffer
◆ SoundBuffer_Session
The documentation for this class was generated from the following file: