Parameters for opening a sound channel. More...

#include <sound.h>

Collaboration diagram for PSoundChannel::Params:

Public Member Functions
	Params (Directions dir=Player, const PString &device=PString::Empty(), const PString &driver=PString::Empty(), unsigned channels=1, unsigned sampleRate=8000, unsigned bitsPerSample=16, unsigned bufferSize=DefaultBufferSize, unsigned bufferCount=DefaultBufferCount, PPluginManager *pluginMgr=NULL)

void	SetBufferCountFromMS (unsigned milliseconds)

Public Attributes
Directions	m_direction
	Sound I/O direction. More...

PString	m_device
	Name of sound device. More...

PString	m_driver
	Name of sound driver. More...

unsigned	m_channels
	Number of channels eg mono/stereo. More...

unsigned	m_sampleRate
	Samples per second. More...

unsigned	m_bitsPerSample
	Number of bits per sample. More...

unsigned	m_bufferSize
	Size of the internal buffer in bytes, typically the smallest amount of data channel can read or written in one go. More...

unsigned	m_bufferCount
	Number of buffers to queue. More...

PPluginManager *	m_pluginMgr

Friends
ostream &	operator<< (ostream &, const Params &params)

Detailed Description

Parameters for opening a sound channel.

Constructor & Destructor Documentation

PSoundChannel::Params::Params	(	Directions	dir = `Player`,
		const PString &	device = `PString::Empty()`,
		const PString &	driver = `PString::Empty()`,
		unsigned	channels = `1`,
		unsigned	sampleRate = `8000`,
		unsigned	bitsPerSample = `16`,
		unsigned	bufferSize = `DefaultBufferSize`,
		unsigned	bufferCount = `DefaultBufferCount`,
		PPluginManager *	pluginMgr = `NULL`
	)

void PSoundChannel::Params::SetBufferCountFromMS ( unsigned milliseconds )

friend

unsigned PSoundChannel::Params::m_bitsPerSample

Number of bits per sample.

unsigned PSoundChannel::Params::m_bufferCount

Number of buffers to queue.

unsigned PSoundChannel::Params::m_bufferSize

    Size of the internal buffer in bytes, typically

the smallest amount of data channel can read or written in one go.

unsigned PSoundChannel::Params::m_channels

Number of channels eg mono/stereo.

PString PSoundChannel::Params::m_device

Name of sound device.

Directions PSoundChannel::Params::m_direction

Sound I/O direction.

PString PSoundChannel::Params::m_driver

Name of sound driver.

PPluginManager* PSoundChannel::Params::m_pluginMgr

unsigned PSoundChannel::Params::m_sampleRate

Samples per second.

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