smk::Sound Class Reference

#include <Sound.hpp>

Represent a sound being played. More...

Description

Represent a sound being played.

See also

SoundBuffer

Example

// Load a sound file.
auto sound_buffer = smk::SoundBuffer(asset::water_mp3);
 
// Create a sound source.
auto sound = smk::Sound(sound_buffer);
 
// Start playing.
sound.Play()

Please make sure to init OpenAL in main() by creating a smk::Audio.

Examples

sound.cpp.

Definition at line 31 of file Sound.hpp.

Public Member Functions
	Sound ()
	Create a null Sound. More...
	Sound (const SoundBuffer &buffer)
	Create a sound reading data from a SoundBuffer. More...
void	Play ()
	Start playing the sound. More...
void	Stop ()
	Stop playing the sound. More...
void	SetLoop (bool looping)
	Specify whether the sound must restart when it has reached the end. More...
bool	IsPlaying () const
void	SetVolume (float volume)
	Sound (Sound &&) noexcept
	Sound (const Sound &)=delete
Sound &	operator= (Sound &&) noexcept
Sound &	operator= (const Sound &)=delete

Constructor & Destructor Documentation

Sound() [1/3]

smk::Sound::Sound ( )

default

Create a null Sound.

Sound() [2/3]

smk::Sound::Sound

(

const SoundBuffer &

buffer

)

Create a sound reading data from a SoundBuffer.

Parameters

buffer

The SoundBuffer to read the data from.

Definition at line 39 of file Sound.cpp.

: buffer_(&buffer) {}

~Sound()

smk::Sound::~Sound

(

)

Definition at line 41 of file Sound.cpp.

              {
  Stop();
  if (source_) {
    alDeleteSources(1, &source_);
  }
}

Sound() [3/3]

smk::Sound::Sound ( Sound &&  o )

noexcept

Definition at line 89 of file Sound.cpp.

                               {
  operator=(std::move(o));
}

Member Function Documentation

IsPlaying()

bool smk::Sound::IsPlaying

(

)

const

Returns

return whether the sound is currently playing something or not.

Definition at line 80 of file Sound.cpp.

                            {
  if (!source_) {
    return false;
  }
  ALint state = {};
  alGetSourcei(source_, AL_SOURCE_STATE, &state);
  return (state == AL_PLAYING);
}

operator=()

Sound & smk::Sound::operator= ( Sound &&  o )

noexcept

Definition at line 93 of file Sound.cpp.

                                          {
  std::swap(buffer_, o.buffer_);
  std::swap(source_, o.source_);
  std::swap(is_playing_, o.is_playing_);
  return *this;
}

Play()

void smk::Sound::Play

(

)

Start playing the sound.

Definition at line 49 of file Sound.cpp.

                 {
  if (!buffer_ || !buffer_->buffer()) {
    return;
  }
  if (is_playing_) {
    Stop();
  }
  EnsureSourceIsCreated();
  alSourcei(source_, AL_BUFFER, ALint(buffer_->buffer()));
  alSourcePlay(source_);
  is_playing_ = true;
}

SetLoop()

void smk::Sound::SetLoop

(

bool

looping

)

Specify whether the sound must restart when it has reached the end.

Parameters

looping

whether the sound must restart when it has reached the end.

Definition at line 74 of file Sound.cpp.

                                {
  EnsureSourceIsCreated();
  alSourcei(source_, AL_LOOPING, looping);
}

SetVolume()

void smk::Sound::SetVolume

(

float

volume

)

Definition at line 100 of file Sound.cpp.

                                  {
  if (!source_) {
    return;
  }
  EnsureSourceIsCreated();
  alSourcef(source_, AL_GAIN, volume);
}

Stop()

void smk::Sound::Stop

(

)

Stop playing the sound.

Definition at line 63 of file Sound.cpp.

                 {
  if (!source_ || !buffer_ || !is_playing_) {
    return;
  }
  alSourceStop(source_);
  alSourcei(source_, AL_BUFFER, 0);
  is_playing_ = false;
}

---

The documentation for this class was generated from the following files:

• /home/arthursonzogni/programmation/real/smk/include/smk/Sound.hpp
• /home/arthursonzogni/programmation/real/smk/src/smk/Sound.cpp