oalplus::CaptureDevice Class Reference

Audio capture device. More...

#include </home/chochlik/devel/oglplus/include/oalplus/device.hpp>

Inheritance diagram for oalplus::CaptureDevice:

Collaboration diagram for oalplus::CaptureDevice:

Public Member Functions
	CaptureDevice (ALCuint frequency, DataFormat format, ALCsizei bufsize)
	Constructs an object referencing the default audio device. More...
	CaptureDevice (const ALchar *dev_spec, ALCuint frequency, DataFormat format, ALCsizei bufsize)
	Constructs an object referencing the specified audio device. More...
	~CaptureDevice (void)
	Closes this device. More...
const ALchar *	Specifier (void) const
	Returns the capture device specifier string. More...
void	Start (void)
	Starts audio capture on this device. More...
void	Stop (void)
	Stop audio capture on this device. More...
ALCsizei	Samples (void) const
	Gets the number of samples captured on this device. More...
void	Samples (ALCvoid *buffer, ALCsizei samples) const
	Gets the samples captured on this device. More...

Static Public Member Functions
static DeviceSpecRange	Specifiers (void)
	Returns a range of specifier strings for available capture devices. More...
static Range< String >	Extensions (void)
	Returns a range of ALC extension strings. More...

Detailed Description

Audio capture device.

Constructor & Destructor Documentation

oalplus::CaptureDevice::CaptureDevice	(	ALCuint	frequency,
		DataFormat	format,
		ALCsizei	bufsize
	)

Constructs an object referencing the default audio device.

Related OpenAL symbols:

alcOpenDevice

oalplus::CaptureDevice::CaptureDevice	(	const ALchar *	dev_spec,
		ALCuint	frequency,
		DataFormat	format,
		ALCsizei	bufsize
	)

Constructs an object referencing the specified audio device.

Related OpenAL symbols:

alcOpenDevice

oalplus::CaptureDevice::~CaptureDevice

(

void

)

Closes this device.

Related OpenAL symbols:

alcCloseDevice

Member Function Documentation

static Range<String> oalplus::DevCommonOps::Extensions ( void  )

staticinherited

Returns a range of ALC extension strings.

Related OpenAL symbols:

alGetString AL_EXTENSIONS

ALCsizei oalplus::DeviceOps< tag::Capture >::Samples ( void  ) const

inherited

Gets the number of samples captured on this device.

Related OpenAL symbols:

alcGetInteger ALC_CAPTURE_SAMPLES

void oalplus::DeviceOps< tag::Capture >::Samples ( ALCvoid *  buffer, ALCsizei  samples  ) const

inherited

Gets the samples captured on this device.

Related OpenAL symbols:

alcCaptureSamples

const ALchar* oalplus::DeviceOps< tag::Capture >::Specifier ( void  ) const

inherited

Returns the capture device specifier string.

Related OpenAL symbols:

alcGetString ALC_CAPTURE_DEVICE_SPECIFIER

static DeviceSpecRange oalplus::DeviceOps< tag::Capture >::Specifiers ( void  )

staticinherited

Returns a range of specifier strings for available capture devices.

Related OpenAL symbols:

alcGetString ALC_CAPTURE_DEVICE_SPECIFIER

Examples:

oalplus/001_devices.cpp.

void oalplus::DeviceOps< tag::Capture >::Start ( void  )

inherited

Starts audio capture on this device.

Related OpenAL symbols:

alcCaptureStart

void oalplus::DeviceOps< tag::Capture >::Stop ( void  )

inherited

Stop audio capture on this device.

Related OpenAL symbols:

alcCaptureStop

---

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

• /home/chochlik/devel/oglplus/include/oalplus/device.hpp