CMediaClientEngine Class Reference

List of all members.

Public Types

enum  TExVolume { ELoud = 1, EMedium, EQuiet }
enum  TExRecordGain { EGainMax, EGainMedium, EGainLow }
enum  TState {
  EIdle, ETonePrepare, ETonePlaying, EPlayFilePrepare,
  EPlayFilePlaying, ERecordPrepare, ERecording, EGetMetaData1,
  EGetMetaData2, EConvert, EConvertComplete, EStreamPrepare,
  EStreamStarted, ENextStreamBuf, EStreamError, EStreamStopping
}

Public Member Functions

 CMediaClientEngine (RFs &aFs)
 ~CMediaClientEngine ()
void SetObserver (MExEngineObserver &aObserver)
void PlayL (const TDesC &aFile)
void PlayL (TInt aFrequency, const TTimeIntervalMicroSeconds &aDuration)
void PlayL ()
void WriteToStreamL (const TDesC8 &aData)
CMdaAudioRecorderUtility * NewRecorderL (const TDesC &aTargetType)
void RecordTypesL (CDesCArray &aTypeArray)
void RecordL (const TDesC &aFile, const TRecordFormatOptions &aRecordOptions)
void Stop ()
void GetMetaDataL (const TFileName &aFile, RMetaDataArray &aMetaData)
CMdaAudioConvertUtility * NewConverterL (const TFileName &aFile, const TDesC &aTargetType, TFileName &aTargetFile)
void ConvertL (const TFileName &aFile, const TDesC &aTargetType, const TFormatOptions &aOptions)
TExVolume Volume () const
void SetVolume (TExVolume aVolume)
TState Status () const

Static Public Member Functions

static void DestinationTypesL (const TFileName &aFile, CDesCArray &aExt)


Detailed Description

Application engine to play tones, files, & streams, and record to file. It inherits: MMdaAudioPlayerCallback to handles call backs from audio player; MMdaAudioToneObserver to handles call backs from tone player; MMdaObjectStateChangeObserver to handles call backs from recorder; MMdaAudioOutputStreamCallback to handles call backs from stream player.

Definition at line 82 of file CMediaClientEngine.h.


Member Enumeration Documentation

enum CMediaClientEngine::TExVolume

Volume levels

Enumerator:
ELoud  Loud volume
EMedium  Medium volume
EQuiet  Low volume

Definition at line 90 of file CMediaClientEngine.h.

enum CMediaClientEngine::TExRecordGain

Gain levels

Enumerator:
EGainMax  High gain
EGainMedium  Medium gain
EGainLow  Low gain

Definition at line 101 of file CMediaClientEngine.h.

enum CMediaClientEngine::TState

Engine status

Enumerator:
EIdle  No operation
ETonePrepare  Preparing to play a tone
ETonePlaying  Playing a tone
EPlayFilePrepare  Preparing to play a file
EPlayFilePlaying  Playing a file
ERecordPrepare  Preparing to record
ERecording  Recording
EGetMetaData1  Getting meta data
EGetMetaData2  Retrieved meta data
EConvert  Converting file
EConvertComplete  Completed conversion
EStreamPrepare  Preparing to play a stream
EStreamStarted  Stream initiated
ENextStreamBuf  Requires new stream data
EStreamError  Error in playing stream
EStreamStopping  Stream closing down

Definition at line 112 of file CMediaClientEngine.h.


Constructor & Destructor Documentation

CMediaClientEngine::CMediaClientEngine ( RFs &  aFs  ) 

Constructor.

Parameters:
File server session

Definition at line 25 of file CMediaClientEngine.cpp.

CMediaClientEngine::~CMediaClientEngine (  ) 

Destructor.

Definition at line 32 of file CMediaClientEngine.cpp.


Member Function Documentation

void CMediaClientEngine::SetObserver ( MExEngineObserver aObserver  ) 

Set the engine observer.

Parameters:
aObserver The engine observer

Definition at line 42 of file CMediaClientEngine.cpp.

void CMediaClientEngine::PlayL ( const TDesC &  aFile  ) 

Plays a sound file.

Parameters:
aFile File to play MEDIA_AUDIO_EX 0 Engine is already playing a sound

Definition at line 187 of file CMediaClientEngine.cpp.

void CMediaClientEngine::PlayL ( TInt  aFrequency,
const TTimeIntervalMicroSeconds &  aDuration 
)

Plays a sound tone.

Parameters:
aFrequency Frequency in Hz
aDuration Duration in ms MEDIA_AUDIO_EX 0 Engine is already playing a sound

Definition at line 130 of file CMediaClientEngine.cpp.

void CMediaClientEngine::PlayL (  ) 

Plays a stream. MEDIA_AUDIO_EX 0 Engine is already playing a sound

Definition at line 534 of file CMediaClientEngine.cpp.

void CMediaClientEngine::WriteToStreamL ( const TDesC8 &  aData  ) 

Writes data to the stream.

Parameters:
aData Data to write

Definition at line 582 of file CMediaClientEngine.cpp.

CMdaAudioRecorderUtility * CMediaClientEngine::NewRecorderL ( const TDesC &  aTargetType  ) 

Gets a recorder for specified target type

Definition at line 352 of file CMediaClientEngine.cpp.

void CMediaClientEngine::RecordTypesL ( CDesCArray &  aTypeArray  ) 

Get possible record types

Definition at line 267 of file CMediaClientEngine.cpp.

void CMediaClientEngine::RecordL ( const TDesC &  aFile,
const TRecordFormatOptions aRecordOptions 
)

Records sound to a file.

Parameters:
aFile File to record to

Definition at line 307 of file CMediaClientEngine.cpp.

void CMediaClientEngine::Stop (  ) 

Terminates any current operation.

Definition at line 49 of file CMediaClientEngine.cpp.

void CMediaClientEngine::GetMetaDataL ( const TFileName &  aFile,
RMetaDataArray &  aMetaData 
)

Gets meta data for a file

Definition at line 604 of file CMediaClientEngine.cpp.

void CMediaClientEngine::DestinationTypesL ( const TFileName &  aFile,
CDesCArray &  aExt 
) [static]

Gets an array of possible conversion types for specified file

Definition at line 458 of file CMediaClientEngine.cpp.

CMdaAudioConvertUtility * CMediaClientEngine::NewConverterL ( const TFileName &  aFile,
const TDesC &  aTargetType,
TFileName &  aTargetFile 
)

Gets a converter for specified file and target

Definition at line 621 of file CMediaClientEngine.cpp.

void CMediaClientEngine::ConvertL ( const TFileName &  aFile,
const TDesC &  aTargetType,
const TFormatOptions aOptions 
)

Does conversion for specified file and target

Definition at line 496 of file CMediaClientEngine.cpp.

CMediaClientEngine::TExVolume CMediaClientEngine::Volume (  )  const

Gets the volume.

Definition at line 96 of file CMediaClientEngine.cpp.

void CMediaClientEngine::SetVolume ( CMediaClientEngine::TExVolume  aVolume  ) 

Sets the volume.

Parameters:
aVolume The new volume

Definition at line 102 of file CMediaClientEngine.cpp.

CMediaClientEngine::TState CMediaClientEngine::Status (  )  const

Gets the engine state

Returns:
The engine state

Definition at line 112 of file CMediaClientEngine.cpp.


Generated on Thu Jan 21 10:33:06 2010 for TB10.1 Example Applications by  doxygen 1.5.3