Home
FAQ
Player
Stage
Gazebo
Contrib
Documentation
Publications
Contributors
Users

Project
Download
Bugs/Feedback
Mailing lists

Radish

Old news
Old stuff

SoundProxy Class Reference
[Proxies]

#include <playerclient.h>

Inherits ClientProxy.

List of all members.


Detailed Description

The SoundProxy class is used to control a sound device, which allows you to play pre-recorded sound files on a robot.


Public Member Functions

 SoundProxy (PlayerClient *pc, unsigned short index, unsigned char access='c')
int Play (int index)
void FillData (player_msghdr_t hdr, const char *buffer)
void Print ()
 Does nothing.


Constructor & Destructor Documentation

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

The client calls this method to make a new proxy. Leave access empty to start unconnected.


Member Function Documentation

int SoundProxy::Play int  index  ) 
 

Play the sound indicated by the index. Returns 0 on success, -1 on error.

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

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

Reimplemented from ClientProxy.

void SoundProxy::Print  )  [inline, virtual]
 

Does nothing.

Reimplemented from ClientProxy.


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