PlayerCc::AudioProxy Class Reference

The AudioProxy class controls an audio device. More...

#include <playerc++.h>

Inheritance diagram for PlayerCc::AudioProxy:
Inheritance graph
Collaboration diagram for PlayerCc::AudioProxy:
Collaboration graph

Detailed Description

The AudioProxy class controls an audio device.

Public Member Functions

 AudioProxy (PlayerClient *aPc, uint32_t aIndex=0)
 Constructor.
 
 ~AudioProxy ()
 Destructor.
 
uint32_t GetMixerDetailsCount () const
 Get Mixer Details Count.
 
player_audio_mixer_channel_detail_t GetMixerDetails (int aIndex) const
 Get Mixer Detail.
 
uint32_t GetDefaultOutputChannel () const
 Get Default output Channel.
 
uint32_t GetDefaultInputChannel () const
 Get Default input Channel.
 
uint32_t GetWavDataLength () const
 Get Wav data length.
 
void GetWavData (uint8_t *aData) const
 Get Wav data This function copies the wav data into the buffer aImage. More...
 
uint32_t GetSeqCount () const
 Get Seq data count.
 
player_audio_seq_item_t GetSeqItem (int aIndex) const
 Get Sequence item.
 
uint32_t GetChannelCount () const
 Get Channel data count.
 
player_audio_mixer_channel_t GetChannel (int aIndex) const
 Get Sequence item.
 
uint32_t GetState (void) const
 Get driver state.
 
void PlayWav (uint32_t aDataCount, uint8_t *aData, uint32_t aFormat)
 Command to play an audio block.
 
void SetWavStremRec (bool aState)
 Command to set recording state.
 
void PlaySample (int aIndex)
 Command to play prestored sample.
 
void PlaySeq (player_audio_seq_t *aTones)
 Command to play sequence of tones.
 
void SetMultMixerLevels (player_audio_mixer_channel_list_t *aLevels)
 Command to set multiple mixer levels.
 
void SetMixerLevel (uint32_t index, float amplitude, uint8_t active)
 Command to set a single mixer level.
 
void RecordWav ()
 Request to record a single audio block result is stored in wav_data.
 
void LoadSample (int aIndex, uint32_t aDataCount, uint8_t *aData, uint32_t aFormat)
 Request to load an audio sample.
 
void GetSample (int aIndex)
 Request to retrieve an audio sample Data is stored in wav_data.
 
void RecordSample (int aIndex, uint32_t aLength)
 Request to record new sample.
 
void GetMixerLevels ()
 Request mixer channel data result is stored in mixer_data.
 
void GetMixerDetails ()
 Request mixer channel details list result is stored in channel_details_list.
 
- Public Member Functions inherited from PlayerCc::ClientProxy
bool IsValid () const
 Proxy has any information. More...
 
bool IsFresh () const
 Check for fresh data. More...
 
void NotFresh ()
 Reset Fresh flag. More...
 
std::string GetDriverName () const
 Get the underlying driver's name. More...
 
double GetDataTime () const
 Returns the received timestamp of the last data sample [s].
 
double GetElapsedTime () const
 Returns the time between the current data time and the time of the last data sample [s].
 
PlayerClientGetPlayerClient () const
 Get a pointer to the Player Client. More...
 
uint32_t GetIndex () const
 Get device index. More...
 
uint32_t GetInterface () const
 Get Interface Code. More...
 
std::string GetInterfaceStr () const
 Get Interface Name. More...
 
void SetReplaceRule (bool aReplace, int aType=-1, int aSubtype=-1)
 Set a replace rule for this proxy on the server. More...
 
int HasCapability (uint32_t aType, uint32_t aSubtype)
 Request capabilities of device. More...
 
int GetBoolProp (char *aProperty, bool *aValue)
 Request a boolean property. More...
 
int SetBoolProp (char *aProperty, bool aValue)
 Set a boolean property. More...
 
int GetIntProp (char *aProperty, int32_t *aValue)
 Request an integer property. More...
 
int SetIntProp (char *aProperty, int32_t aValue)
 Set an integer property. More...
 
int GetDblProp (char *aProperty, double *aValue)
 Request a double property. More...
 
int SetDblProp (char *aProperty, double aValue)
 Set a double property. More...
 
int GetStrProp (char *aProperty, char **aValue)
 Request a string property. More...
 
int SetStrProp (char *aProperty, char *aValue)
 Set a string property. More...
 
template<typename T >
connection_t ConnectReadSignal (T aSubscriber)
 Connect a read signal to this proxy. More...
 
void DisconnectReadSignal (connection_t aSubscriber)
 Disconnect a signal from this proxy. More...
 

Private Member Functions

void Subscribe (uint32_t aIndex)
 
void Unsubscribe ()
 

Private Attributes

playerc_audio_tmDevice
 

Additional Inherited Members

- Public Types inherited from PlayerCc::ClientProxy
typedef int connection_t
 
typedef boost::mutex::scoped_lock scoped_lock_t
 
typedef int read_signal_t
 
- Protected Member Functions inherited from PlayerCc::ClientProxy
 ClientProxy (PlayerClient *aPc, uint32_t aIndex)
 
template<typename T >
GetVar (const T &aV) const
 
template<typename T >
void GetVarByRef (const T aBegin, const T aEnd, T aDest) const
 
- Protected Attributes inherited from PlayerCc::ClientProxy
PlayerClientmPc
 
playerc_client_tmClient
 
playerc_device_tmInfo
 
bool mFresh
 

Member Function Documentation

◆ GetWavData()

void PlayerCc::AudioProxy::GetWavData ( uint8_t *  aData) const
inline

Get Wav data This function copies the wav data into the buffer aImage.

The buffer should be allocated according to the length of the wav data The size can be found by calling GetWavDataLength().

References player_audio_wav::data, and playerc_audio_t::wav_data.


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