Home
FAQ
Player
Stage
Gazebo
Contrib
Documentation
Publications
Contributors
Users

Project
Download
Bugs/Feedback
Mailing lists

Radish

Old news
Old stuff

AudioDSPProxy Class Reference
[Proxies]

#include <playerclient.h>

Inherits ClientProxy.

List of all members.


Detailed Description

The AudioDSPProxy class controls an audiodsp device.


Public Member Functions

 AudioDSPProxy (PlayerClient *pc, unsigned short index, unsigned char access='c')
int Configure (uint8_t channels, uint16_t sampleRate, int16_t sampleFormat=0xFFFFFFFF)
int GetConfigure ()
void FillData (player_msghdr_t hdr, const char *buffer)
int PlayTone (unsigned short freq, unsigned short amp, unsigned int dur)
 Play a fixed-frequency tone.

int PlayChirp (unsigned short freq, unsigned short amp, unsigned int dur, const unsigned char bitString[], unsigned short bitStringLen)
int Replay ()
void Print ()
 Print the current data.


Public Attributes

int16_t sampleFormat
uint16_t sampleRate
uint8_t channels
uint16_t freq [5]
uint16_t amp [5]


Constructor & Destructor Documentation

AudioDSPProxy::AudioDSPProxy PlayerClient pc,
unsigned short  index,
unsigned char  access = 'c'
[inline]
 

Constructor. Leave the access field empty to start unconnected.


Member Function Documentation

int AudioDSPProxy::Configure uint8_t  channels,
uint16_t  sampleRate,
int16_t  sampleFormat = 0xFFFFFFFF
 

int AudioDSPProxy::GetConfigure  ) 
 

void AudioDSPProxy::FillData player_msghdr_t  hdr,
const char *  buffer
[virtual]
 

All proxies must provide this method. It is used internally to parse new data when it is received.

Reimplemented from ClientProxy.

int AudioDSPProxy::PlayTone unsigned short  freq,
unsigned short  amp,
unsigned int  dur
 

Play a fixed-frequency tone.

int AudioDSPProxy::PlayChirp unsigned short  freq,
unsigned short  amp,
unsigned int  dur,
const unsigned char  bitString[],
unsigned short  bitStringLen
 

int AudioDSPProxy::Replay  ) 
 

void AudioDSPProxy::Print  )  [virtual]
 

Print the current data.

Reimplemented from ClientProxy.


Member Data Documentation

int16_t AudioDSPProxy::sampleFormat
 

Format code of each sample

uint16_t AudioDSPProxy::sampleRate
 

Rate at which to sample (Hz)

uint8_t AudioDSPProxy::channels
 

Number of channels

uint16_t AudioDSPProxy::freq[5]
 

uint16_t AudioDSPProxy::amp[5]
 


The documentation for this class was generated from the following file:
Generated on Tue May 3 14:15:47 2005 for Player by doxygen 1.3.6