Sound.hpp

Warning

This page refers to an old version of SFML. Click here to switch to the latest version.

• Main Page
• Namespaces
• Classes
• Files

• File List
• File Members

• SFML
• include
• SFML
• Audio

Sound.hpp

Go to the documentation of this file.

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2009 Laurent Gomila (laurent.gom@gmail.com)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#ifndef SFML_SOUND_HPP
#define SFML_SOUND_HPP

// Headers
#include <SFML/System/Resource.hpp>
#include <SFML/System/Vector3.hpp>
#include <SFML/Audio/AudioResource.hpp>
#include <cstdlib>
 
 
namespace sf
{
class SoundBuffer;

class SFML_API Sound : public AudioResource
{
public :

    enum Status
    {
        Stopped, 
        Paused,  
        Playing  
    };

    Sound();

    explicit Sound(const SoundBuffer& Buffer, bool Loop = false, float Pitch = 1.f, float Volume = 100.f, const Vector3f& Position = Vector3f(0, 0, 0));

    Sound(const Sound& Copy);

    ~Sound();

    void Play();

    void Pause();

    void Stop();

    void SetBuffer(const SoundBuffer& Buffer);

    void SetLoop(bool Loop);

    void SetPitch(float Pitch);

    void SetVolume(float Volume);

    void SetPosition(float X, float Y, float Z);

    void SetPosition(const Vector3f& Position);

    void SetRelativeToListener(bool Relative);

    void SetMinDistance(float MinDistance);

    void SetAttenuation(float Attenuation);

    void SetPlayingOffset(float TimeOffset);

    const SoundBuffer* GetBuffer() const;

    bool GetLoop() const;

    float GetPitch() const;

    float GetVolume() const;

    Vector3f GetPosition() const;

    bool IsRelativeToListener() const;

    float GetMinDistance() const;

    float GetAttenuation() const;

    Status GetStatus() const;

    float GetPlayingOffset() const;

    Sound& operator =(const Sound& Other);

    void ResetBuffer();
 
private :
 
    friend class SoundStream;

    // Member data
    unsigned int             mySource; 
    ResourcePtr<SoundBuffer> myBuffer; 
};
 
} // namespace sf
 
 
#endif // SFML_SOUND_HPP