Loading...
Searching...
No Matches
Audio module

Namespaces

namespace  sf::Listener
 The audio listener is the point in the scene from where all the sounds are heard.
 

Classes

class  sf::AudioResource
 Base class for classes that require an audio device. More...
 
class  sf::InputSoundFile
 Provide read access to sound files. More...
 
class  sf::Music
 Streamed music played from an audio file. More...
 
class  sf::OutputSoundFile
 Provide write access to sound files. More...
 
class  sf::Sound
 Regular sound that can be played in the audio environment. More...
 
class  sf::SoundBuffer
 Storage for audio samples defining a sound. More...
 
class  sf::SoundBufferRecorder
 Specialized SoundRecorder which stores the captured audio data into a sound buffer. More...
 
class  sf::SoundFileFactory
 Manages and instantiates sound file readers and writers. More...
 
class  sf::SoundFileReader
 Abstract base class for sound file decoding. More...
 
class  sf::SoundFileWriter
 Abstract base class for sound file encoding. More...
 
class  sf::SoundRecorder
 Abstract base class for capturing sound data. More...
 
class  sf::SoundSource
 Base class defining a sound's properties. More...
 
class  sf::SoundStream
 Abstract base class for streamed audio sources. More...
 

Enumerations

enum class  sf::SoundChannel {
  sf::SoundChannel::Unspecified , sf::SoundChannel::Mono , sf::SoundChannel::FrontLeft , sf::SoundChannel::FrontRight ,
  sf::SoundChannel::FrontCenter , sf::SoundChannel::FrontLeftOfCenter , sf::SoundChannel::FrontRightOfCenter , sf::SoundChannel::LowFrequencyEffects ,
  sf::SoundChannel::BackLeft , sf::SoundChannel::BackRight , sf::SoundChannel::BackCenter , sf::SoundChannel::SideLeft ,
  sf::SoundChannel::SideRight , sf::SoundChannel::TopCenter , sf::SoundChannel::TopFrontLeft , sf::SoundChannel::TopFrontRight ,
  sf::SoundChannel::TopFrontCenter , sf::SoundChannel::TopBackLeft , sf::SoundChannel::TopBackRight , sf::SoundChannel::TopBackCenter
}
 Types of sound channels that can be read/written from sound buffers/files. More...
 

Detailed Description

Sounds, streaming (musics or custom sources), recording, spatialization.

Enumeration Type Documentation

◆ SoundChannel

enum class sf::SoundChannel
strong

Types of sound channels that can be read/written from sound buffers/files.

In multi-channel audio, each sound channel can be assigned a position. The position of the channel is used to determine where to place a sound when it is spatialized. Assigning an incorrect sound channel will result in multi-channel audio being positioned incorrectly when using spatialization.

Enumerator
Unspecified 
Mono 
FrontLeft 
FrontRight 
FrontCenter 
FrontLeftOfCenter 
FrontRightOfCenter 
LowFrequencyEffects 
BackLeft 
BackRight 
BackCenter 
SideLeft 
SideRight 
TopCenter 
TopFrontLeft 
TopFrontRight 
TopFrontCenter 
TopBackLeft 
TopBackRight 
TopBackCenter 

Definition at line 41 of file SoundChannel.hpp.