documentation.HELP! SFML v1.6 Documentation

SFML - Simple and Fast Multimedia Library

SFML v1.6

previous page next page

sf::Music Class Reference

Music defines a big sound played using streaming, so usually what we call a music :). More...

#include <Music.hpp>

Inheritance diagram for sf::Music:

List of all members.

Public Types
enum	Status
	Enumeration of the sound states. More...
Public Member Functions
	Music (std::size_t BufferSize=44100)
	Construct the music with a buffer size.
	~Music ()
	Destructor.
bool	OpenFromFile (const std::string &Filename)
	Open a music file (doesn't play it -- call Play() for that).
bool	OpenFromMemory (const char *Data, std::size_t SizeInBytes)
	Open a music file from memory (doesn't play it -- call Play() for that).
float	GetDuration () const
	Get the music duration.
void	Play ()
	Start playing the audio stream.
void	Stop ()
	Stop playing the audio stream.
unsigned int	GetChannelsCount () const
	Return the number of channels (1 = mono, 2 = stereo).
unsigned int	GetSampleRate () const
	Get the stream sample rate.
Status	GetStatus () const
	Get the status of the stream (stopped, paused, playing).
float	GetPlayingOffset () const
	Get the current playing position of the stream.
void	SetLoop (bool Loop)
	Set the stream loop state.
bool	GetLoop () const
	Tell whether or not the stream is looping.
Protected Member Functions
void	Initialize (unsigned int ChannelsCount, unsigned int SampleRate)
	Set the audio stream parameters, you must call it before Play().

---

Detailed Description

Music defines a big sound played using streaming, so usually what we call a music :).

Definition at line 47 of file Music.hpp.

---

Member Enumeration Documentation

enum sf::Sound::Status [inherited]

Enumeration of the sound states.

Definition at line 52 of file Sound.hpp.

---

Constructor & Destructor Documentation

sf::Music::Music

(

std::size_t

BufferSize = 44100

)

[explicit]

Construct the music with a buffer size.

Parameters:

BufferSize

: Size of the internal buffer, expressed in number of samples (ie. size taken by the music in memory) (44100 by default)

Definition at line 40 of file Music.cpp.

sf::Music::~Music

(

)

Destructor.

Definition at line 52 of file Music.cpp.

---

Member Function Documentation

unsigned int sf::SoundStream::GetChannelsCount

(

)

const [inherited]

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

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

Returns:

Number of channels

..)

Definition at line 126 of file SoundStream.cpp.

float sf::Music::GetDuration

(

)

const

Get the music duration.

Get the sound duration.

Returns:

Music duration, in seconds

Definition at line 148 of file Music.cpp.

bool sf::SoundStream::GetLoop

(

)

const [inherited]

Tell whether or not the stream is looping.

Tell whether or not the music is looping.

Returns:

True if the music is looping, false otherwise

Reimplemented from sf::Sound.

Definition at line 180 of file SoundStream.cpp.

float sf::SoundStream::GetPlayingOffset

(

)

const [inherited]

Get the current playing position of the stream.

Returns:

Current playing position, expressed in seconds

Current playing position, expressed in seconds

Reimplemented from sf::Sound.

Definition at line 162 of file SoundStream.cpp.

unsigned int sf::SoundStream::GetSampleRate

(

)

const [inherited]

Get the stream sample rate.

Get the sound frequency (sample rate).

Returns:

Stream frequency (number of samples per second)

Definition at line 135 of file SoundStream.cpp.

Sound::Status sf::SoundStream::GetStatus

(

)

const [inherited]

Get the status of the stream (stopped, paused, playing).

Get the status of the sound (stopped, paused, playing).

Returns:

Current status of the sound

Reimplemented from sf::Sound.

Definition at line 144 of file SoundStream.cpp.

void sf::SoundStream::Initialize	(	unsigned int	ChannelsCount,
		unsigned int	SampleRate
	)			[protected, inherited]

Set the audio stream parameters, you must call it before Play().

Parameters:

	ChannelsCount	: Number of channels
	SampleRate	: Sample rate

Definition at line 64 of file SoundStream.cpp.

bool sf::Music::OpenFromFile

(

const std::string &

Filename

)

Open a music file (doesn't play it -- call Play() for that).

Parameters:

Filename

: Path of the music file to open

Returns:

True if loading has been successful

Definition at line 64 of file Music.cpp.

bool sf::Music::OpenFromMemory	(	const char *	Data,
		std::size_t	SizeInBytes
	)

Open a music file from memory (doesn't play it -- call Play() for that).

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 91 of file Music.cpp.

void sf::SoundStream::Play

(

)

[inherited]

Start playing the audio stream.

Reimplemented from sf::Sound.

Definition at line 85 of file SoundStream.cpp.

void sf::SoundStream::SetLoop

(

bool

Loop

)

[inherited]

Set the stream loop state.

Set the music loop state.

This parameter is disabled by default

Parameters:

Loop

: True to play in loop, false to play once

Reimplemented from sf::Sound.

Definition at line 171 of file SoundStream.cpp.

void sf::SoundStream::Stop

(

)

[inherited]

Stop playing the audio stream.

Reimplemented from sf::Sound.

Definition at line 115 of file SoundStream.cpp.

---

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

• Music.hpp
• Music.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.