documentation.HELP! SFML v1.6 Documentation

SFML - Simple and Fast Multimedia Library

SFML v1.6

previous page next page

sf::SoundBufferRecorder Class Reference

Specialized SoundRecorder which saves the captured audio data into a sound buffer. More...

#include <SoundBufferRecorder.hpp>

Inheritance diagram for sf::SoundBufferRecorder:

List of all members.

Public Member Functions
const SoundBuffer &	GetBuffer () const
	Get the sound buffer containing the captured audio data.
void	Start (unsigned int SampleRate=44100)
	Start the capture.
void	Stop ()
	Stop the capture.
unsigned int	GetSampleRate () const
	Get the sample rate.
Static Public Member Functions
static bool	CanCapture ()
	Tell if the system supports sound capture.

---

Detailed Description

Specialized SoundRecorder which saves the captured audio data into a sound buffer.

Definition at line 42 of file SoundBufferRecorder.hpp.

---

Member Function Documentation

bool sf::SoundRecorder::CanCapture

(

)

[static, inherited]

Tell if the system supports sound capture.

If not, this class won't be usable

Returns:

True if audio capture is supported

If not, this class won't be usable

Definition at line 136 of file SoundRecorder.cpp.

const SoundBuffer & sf::SoundBufferRecorder::GetBuffer

(

)

const

Get the sound buffer containing the captured audio data.

Returns:

Constant reference to the sound buffer

Definition at line 70 of file SoundBufferRecorder.cpp.

unsigned int sf::SoundRecorder::GetSampleRate

(

)

const [inherited]

Get the sample rate.

Returns:

Frequency, in samples per second

Definition at line 126 of file SoundRecorder.cpp.

void sf::SoundRecorder::Start

(

unsigned int

SampleRate = 44100

)

[inherited]

Start the capture.

Warning : only one capture can happen at the same time

Parameters:

SampleRate

: Sound frequency (the more samples, the higher the quality) (44100 by default = CD quality)

Warning : only one capture can happen at the same time

Definition at line 69 of file SoundRecorder.cpp.

void sf::SoundRecorder::Stop

(

)

[inherited]

Stop the capture.

Definition at line 115 of file SoundRecorder.cpp.

---

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

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