documentation.HELP! SFML v1.6 Documentation

SFML - Simple and Fast Multimedia Library

SFML v1.6

previous page next page

sf::SoundBuffer Class Reference

SoundBuffer is the low-level for loading and manipulating sound buffers. More...

#include <SoundBuffer.hpp>

Inheritance diagram for sf::SoundBuffer:

List of all members.

Public Member Functions
	SoundBuffer ()
	Default constructor.
	SoundBuffer (const SoundBuffer &Copy)
	Copy constructor.
	~SoundBuffer ()
	Destructor.
bool	LoadFromFile (const std::string &Filename)
	Load the sound buffer from a file.
bool	LoadFromMemory (const char *Data, std::size_t SizeInBytes)
	Load the sound buffer from a file in memory.
bool	LoadFromSamples (const Int16 *Samples, std::size_t SamplesCount, unsigned int ChannelsCount, unsigned int SampleRate)
	Load the sound buffer from an array of samples - assumed format for samples is 16 bits signed integer.
bool	SaveToFile (const std::string &Filename) const
	Save the sound buffer to a file.
const Int16 *	GetSamples () const
	Return the sound samples.
std::size_t	GetSamplesCount () const
	Return the samples count.
unsigned int	GetSampleRate () const
	Get the sample rate.
unsigned int	GetChannelsCount () const
	Return the number of channels (1 = mono, 2 = stereo, .
float	GetDuration () const
	Get the sound duration.
SoundBuffer &	operator= (const SoundBuffer &Other)
	Assignment operator.
Friends
class	Sound

---

Detailed Description

SoundBuffer is the low-level for loading and manipulating sound buffers.

Definition at line 46 of file SoundBuffer.hpp.

---

Constructor & Destructor Documentation

sf::SoundBuffer::SoundBuffer

(

)

Default constructor.

Definition at line 42 of file SoundBuffer.cpp.

sf::SoundBuffer::SoundBuffer

(

const SoundBuffer &

Copy

)

Copy constructor.

Parameters:

Copy

: Instance to copy

Definition at line 54 of file SoundBuffer.cpp.

sf::SoundBuffer::~SoundBuffer

(

)

Destructor.

Definition at line 73 of file SoundBuffer.cpp.

---

Member Function Documentation

unsigned int sf::SoundBuffer::GetChannelsCount

(

)

const

Return the number of channels (1 = mono, 2 = stereo, .

..)

Returns:

Number of channels

..)

Definition at line 253 of file SoundBuffer.cpp.

float sf::SoundBuffer::GetDuration

(

)

const

Get the sound duration.

Returns:

Sound duration, in seconds

Definition at line 265 of file SoundBuffer.cpp.

unsigned int sf::SoundBuffer::GetSampleRate

(

)

const

Get the sample rate.

Returns:

Sound frequency (number of samples per second)

Definition at line 241 of file SoundBuffer.cpp.

const Int16 * sf::SoundBuffer::GetSamples

(

)

const

Return the sound samples.

Returns:

Pointer to the array of sound samples, in 16 bits signed integer format

Definition at line 223 of file SoundBuffer.cpp.

std::size_t sf::SoundBuffer::GetSamplesCount

(

)

const

Return the samples count.

Returns:

Number of samples

Definition at line 232 of file SoundBuffer.cpp.

bool sf::SoundBuffer::LoadFromFile

(

const std::string &

Filename

)

Load the sound buffer from a file.

Parameters:

Filename

: Path of the sound file to load

Returns:

True if loading has been successful

Definition at line 88 of file SoundBuffer.cpp.

bool sf::SoundBuffer::LoadFromMemory	(	const char *	Data,
		std::size_t	SizeInBytes
	)

Load the sound buffer from a file in memory.

Parameters:

	Data	: Pointer to the file data in memory
	SizeInBytes	: Size of the data to load, in bytes

Returns:

True if loading has been successful

Definition at line 129 of file SoundBuffer.cpp.

bool sf::SoundBuffer::LoadFromSamples	(	const Int16 *	Samples,
		std::size_t	SamplesCount,
		unsigned int	ChannelsCount,
		unsigned int	SampleRate
	)

Load the sound buffer from an array of samples - assumed format for samples is 16 bits signed integer.

Load the sound buffer from an array of samples - assumed format for samples is 16 bits signed integer.

Parameters:

	Samples	: Pointer to the samples in memory
	SamplesCount	: Number of samples pointed by Samples
	ChannelsCount	: Number of channels (1 = mono, 2 = stereo, ...)
	SampleRate	: Frequency (number of samples to play per second)

Returns:

True if loading has been successful

Definition at line 171 of file SoundBuffer.cpp.

SoundBuffer & sf::SoundBuffer::operator=

(

const SoundBuffer &

Other

)

Assignment operator.

Parameters:

Other

: Instance to assign

Returns:

Reference to the sound buffer

Definition at line 274 of file SoundBuffer.cpp.

bool sf::SoundBuffer::SaveToFile

(

const std::string &

Filename

)

const

Save the sound buffer to a file.

Parameters:

Filename

: Path of the sound file to write

Returns:

True if saving has been successful

Definition at line 199 of file SoundBuffer.cpp.

---

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

• SoundBuffer.hpp
• SoundBuffer.cpp

 ::  Copyright © 2007-2008 Laurent Gomila, all rights reserved  ::  Documentation generated by doxygen 1.5.2  :: 

previous page start next page

Menu

• Homepage

Table of contents

• Main Page
• Class List
  • sf::AudioResource
  • sf::Clock
  • sf::Color
  • sf::Context
  • sf::Drawable
  • sf::Event
  • sf::Event::Event::JoyButtonEvent
  • sf::Event::Event::JoyMoveEvent
  • sf::Event::Event::KeyEvent
  • sf::Event::Event::MouseButtonEvent
  • sf::Event::Event::MouseMoveEvent
  • sf::Event::Event::MouseWheelEvent
  • sf::Event::Event::SizeEvent
  • sf::Event::Event::TextEvent
  • sf::Font
  • sf::Ftp
  • sf::Ftp::Ftp::DirectoryResponse
  • sf::Ftp::Ftp::ListingResponse
  • sf::Ftp::Ftp::Response
  • sf::Glyph
  • sf::Http
  • sf::Http::Http::Request
  • sf::Http::Http::Response
  • sf::Image
  • sf::Input
  • sf::IPAddress
  • sf::Listener
  • sf::Lock
  • sf::Matrix3
  • sf::Music
  • sf::Mutex
  • sf::NonCopyable
  • sf::Packet
  • sf::PostFX
  • sf::Randomizer
  • sf::Rect< T >
  • sf::RenderTarget
  • sf::RenderWindow
  • sf::Resource< T >
  • sf::ResourcePtr< T >
  • sf::Selector< Type >
  • sf::SelectorBase
  • sf::Shape
  • sf::SocketHelper
  • sf::SocketTCP
  • sf::SocketUDP
  • sf::Sound
  • sf::SoundBuffer
  • sf::SoundBufferRecorder
  • sf::SoundRecorder
  • sf::SoundStream
  • sf::SoundStream::SoundStream::Chunk
  • sf::Sprite
  • sf::String
  • sf::Thread
  • sf::Unicode
  • sf::Unicode::Unicode::Text
  • sf::Vector2< T >
  • sf::Vector3< T >
  • sf::VideoMode
  • sf::View
  • sf::Window
  • sf::WindowListener
  • sf::WindowSettings
• Class Hierarchy
  • sf::AudioResource
    • sf::Sound
      • sf::SoundStream
        • sf::Music
    • sf::SoundBuffer
  • sf::Clock
  • sf::Color
  • sf::Drawable
    • sf::PostFX
    • sf::Shape
    • sf::Sprite
    • sf::String
  • sf::Event
  • sf::Event::Event::JoyButtonEvent
  • sf::Event::Event::JoyMoveEvent
  • sf::Event::Event::KeyEvent
  • sf::Event::Event::MouseButtonEvent
  • sf::Event::Event::MouseMoveEvent
  • sf::Event::Event::MouseWheelEvent
  • sf::Event::Event::SizeEvent
  • sf::Event::Event::TextEvent
  • sf::Ftp::Ftp::Response
    • sf::Ftp::Ftp::DirectoryResponse
    • sf::Ftp::Ftp::ListingResponse
  • sf::Glyph
  • sf::Http::Http::Request
  • sf::Http::Http::Response
  • sf::IPAddress
  • sf::Listener
  • sf::Matrix3
  • sf::NonCopyable
    • sf::Context
    • sf::Ftp
    • sf::Http
    • sf::Input
    • sf::Lock
    • sf::Mutex
    • sf::Thread
      • sf::SoundRecorder
        • sf::SoundBufferRecorder
      • sf::SoundStream
    • sf::Window
      • sf::RenderWindow
  • sf::Packet
  • sf::Randomizer
  • sf::Rect< T >
  • sf::RenderTarget
    • sf::RenderWindow
  • sf::Resource< T >
  • sf::Resource< Font >
    • sf::Font
  • sf::Resource< Image >
    • sf::Image
  • sf::Resource< SoundBuffer >
    • sf::SoundBuffer
  • sf::ResourcePtr< T >
  • sf::SelectorBase
    • sf::Selector< Type >
  • sf::SocketHelper
  • sf::SocketTCP
  • sf::SocketUDP
  • sf::SoundStream::SoundStream::Chunk
  • sf::Unicode
  • sf::Unicode::Unicode::Text
  • sf::Vector2< T >
  • sf::Vector3< T >
  • sf::VideoMode
  • sf::View
  • sf::WindowListener
    • sf::Input
    • sf::Window
  • sf::WindowSettings
• Class Members
• Namespace List
  • sf::Blend
  • sf::Joy
  • sf::Key
  • sf::Mouse
  • sf::Style
• Namespace Members
• File List
  • Arial.hpp
  • Audio.hpp
  • AudioDevice.cpp
  • AudioDevice.hpp
  • AudioResource.cpp
  • AudioResource.hpp
  • Clock.cpp
  • Clock.hpp
  • Color.cpp
  • Color.hpp
  • Config.hpp
  • Context.cpp
  • Context.hpp
  • Doxygen.hpp
  • Drawable.cpp
  • Drawable.hpp
  • Event.hpp
  • Font.cpp
  • Font.hpp
  • FontLoader.cpp
  • FontLoader.hpp
  • Ftp.cpp
  • Ftp.hpp
  • Glyph.hpp
  • Graphics.hpp
  • GraphicsContext.cpp
  • GraphicsContext.hpp
  • Http.cpp
  • Http.hpp
  • Image.cpp
  • Image.hpp
  • ImageLoader.cpp
  • ImageLoader.hpp
  • Input.cpp
  • Input.hpp
  • IPAddress.cpp
  • IPAddress.hpp
  • Cocoa/Joystick.cpp
  • Template for new ports/Joystick.cpp
  • Win32/Joystick.cpp
  • Cocoa/Joystick.hpp
  • Joystick.hpp
  • Template for new ports/Joystick.hpp
  • Win32/Joystick.hpp
  • Listener.cpp
  • Listener.hpp
  • Lock.cpp
  • Lock.hpp
  • Matrix3.cpp
  • Matrix3.hpp
  • Matrix3.inl
  • Music.cpp
  • Music.hpp
  • Mutex.cpp
  • Mutex.hpp
  • Win32/Mutex.hpp
  • Network.hpp
  • NonCopyable.hpp
  • OpenAL.hpp
  • OpenGL.hpp
  • Packet.cpp
  • Packet.hpp
  • Platform.cpp
  • Platform.hpp
  • Win32/Platform.hpp
  • PostFX.cpp
  • PostFX.hpp
  • Randomizer.cpp
  • Randomizer.hpp
  • Rect.hpp
  • Rect.inl
  • RenderTarget.cpp
  • RenderTarget.hpp
  • RenderWindow.cpp
  • RenderWindow.hpp
  • Resource.hpp
  • Resource.inl
  • ResourcePtr.inl
  • Selector.hpp
  • Selector.inl
  • SelectorBase.cpp
  • SelectorBase.hpp
  • SFML_Main.cpp
  • Shape.cpp
  • Shape.hpp
  • Sleep.cpp
  • Sleep.hpp
  • SocketHelper.cpp
  • SocketHelper.hpp
  • Win32/SocketHelper.hpp
  • Sockets.hpp
  • SocketTCP.cpp
  • SocketTCP.hpp
  • SocketUDP.cpp
  • SocketUDP.hpp
  • Sound.cpp
  • Sound.hpp
  • SoundBuffer.cpp
  • SoundBuffer.hpp
  • SoundBufferRecorder.cpp
  • SoundBufferRecorder.hpp
  • SoundFile.cpp
  • SoundFile.hpp
  • SoundFileDefault.cpp
  • SoundFileDefault.hpp
  • SoundFileOgg.cpp
  • SoundFileOgg.hpp
  • SoundRecorder.cpp
  • SoundRecorder.hpp
  • SoundStream.cpp
  • SoundStream.hpp
  • Sprite.cpp
  • Sprite.hpp
  • String.cpp
  • String.hpp
  • System.hpp
  • Thread.cpp
  • Thread.hpp
  • Win32/Thread.hpp
  • Unicode.cpp
  • Unicode.hpp
  • Unicode.inl
  • Vector2.hpp
  • Vector2.inl
  • Vector3.hpp
  • Vector3.inl
  • VideoMode.cpp
  • VideoMode.hpp
  • Cocoa/VideoModeSupport.cpp
  • Template for new ports/VideoModeSupport.cpp
  • Win32/VideoModeSupport.cpp
  • Cocoa/VideoModeSupport.hpp
  • Template for new ports/VideoModeSupport.hpp
  • VideoModeSupport.hpp
  • Win32/VideoModeSupport.hpp
  • View.cpp
  • View.hpp
  • Window.cpp
  • Window/Window.hpp
  • Window.hpp
  • WindowHandle.hpp
  • WindowImpl.cpp
  • WindowImpl.hpp
  • WindowImplCocoa.hpp
  • WindowImplWin32.cpp
  • WindowImplWin32.hpp
  • WindowImplXXX.cpp
  • WindowImplXXX.hpp
  • WindowListener.hpp
  • WindowSettings.hpp
  • WindowStyle.hpp

Get in touch

Submit feedback about this site to:

• [email protected]

© documentation.help. Design: rehmann.co.