Symbian^3 Application Developer Library >

CMMFMdaAudioInputStream Class Reference

class CMMFMdaAudioInputStream : public CBase

Inherits from

Nested Classes and Structures

Public Member Functions
~CMMFMdaAudioInputStream ()
TInt BitRateL ()
void BufferToBeEmptied ( CMMFBuffer *)
void BufferToBeFilled ( CMMFBuffer *)
void ConvertError ( TInt )
TAny * CustomInterface ( TUid )
TFourCC DataType ()
void DeviceMessage ( TUid , const TDesC8 &)
TInt Gain ()
TInt GetBalanceL ()
TInt GetBytes ()
void GetSupportedBitRatesL ( RArray < TInt > &)
void InitializeComplete ( TInt )
TInt MaxGain ()
CMMFMdaAudioInputStream * NewL ( MMdaAudioInputStreamCallback &)
CMMFMdaAudioInputStream * NewL ( MMdaAudioInputStreamCallback &, TInt , TInt )
void Open ( TMdaPackage *)
void PlayError ( TInt )
const TTimeIntervalMicroSeconds & Position ()
void ReadL ( TDes8 &)
void RecordError ( TInt )
void RequestStop ()
void SetAudioPropertiesL ( TInt , TInt )
void SetBalanceL ( TInt )
void SetBitRateL ( TInt )
void SetDataTypeL ( TFourCC )
void SetGain ( TInt )
void SetPriority ( TInt , TInt )
void SetSingleBufferMode ( TBool )
void ShutDown ()
void Stop ()
void ToneFinished ( TInt )
Private Member Functions
CMMFMdaAudioInputStream ( MMdaAudioInputStreamCallback &)
void ConstructL ( TInt , TInt )
TInt Read ( TDes8 &)
void RealSetAudioPropertiesL ( TInt , TInt )
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Private Member Enumerations
enum TIsOpenState { EIsNotOpen , EIsOpening , EIsOpen }
enum TState { EStopped , ERecording , EStopping }
Private Attributes
CActiveCallback * iActiveCallback
CActiveSchedulerWait * iActiveSchedulerWait
TBool iAudioDataStored
TPtr8 iBufferPtr
TInt iBytesRecorded
MMdaAudioInputStreamCallback & iCallback
TFourCC iDataTypeCode
CMMFDevSound * iDevSound
CMMFFifo < TDes8 > * iFifo
TBool iInitCallFrmSetDataType
TInt iInitializeState
TIsOpenState iIsOpenState
TTimeIntervalMicroSeconds iPosition
TMdaAudioDataSettings iSettings
TBool iSingleBuffer
TInt iState
TPtr8 iStorageItem

Constructor & Destructor Documentation

CMMFMdaAudioInputStream(MMdaAudioInputStreamCallback &)

CMMFMdaAudioInputStream ( MMdaAudioInputStreamCallback & aCallback ) [private]

Construct

Parameters

MMdaAudioInputStreamCallback & aCallback

~CMMFMdaAudioInputStream()

~CMMFMdaAudioInputStream ( )

Destructor

Member Functions Documentation

BitRateL()

TInt BitRateL ( ) const

BufferToBeEmptied(CMMFBuffer *)

void BufferToBeEmptied ( CMMFBuffer * aBuffer )

Called when sound device has filled data buffer

Parameters

CMMFBuffer * aBuffer

BufferToBeFilled(CMMFBuffer *)

void BufferToBeFilled ( CMMFBuffer * aBuffer )

Do not support

Parameters

CMMFBuffer * aBuffer

ConstructL(TInt, TInt)

void ConstructL ( TInt aPriority,
TInt aPref
) [private]

Second phase constructor

Parameters

TInt aPriority
TInt aPref

ConvertError(TInt)

void ConvertError ( TInt aError )

Do not support

Parameters

TInt aError

CustomInterface(TUid)

TAny * CustomInterface ( TUid aInterfaceId )

Parameters

TUid aInterfaceId

DataType()

TFourCC DataType ( ) const

DeviceMessage(TUid, const TDesC8 &)

void DeviceMessage ( TUid aMessageType,
const TDesC8 & aMsg
)

Do not support

Parameters

TUid aMessageType
const TDesC8 & aMsg

Gain()

TInt Gain ( ) const

To get the current gain level

GetBalanceL()

TInt GetBalanceL ( ) const

To get the current balance value.This function may not return the same value as passed to SetBalanceL depending on the internal implementation in the underlying components.

GetBytes()

TInt GetBytes ( )

To return the current number of bytes recorded by audio hardware

GetSupportedBitRatesL(RArray< TInt > &)

void GetSupportedBitRatesL ( RArray < TInt > & aSupportedBitRates )

Parameters

RArray < TInt > & aSupportedBitRates

InitializeComplete(TInt)

void InitializeComplete ( TInt aError )

To be called when intialize stream complete

Parameters

TInt aError

MaxGain()

TInt MaxGain ( ) const

To get the maximum gain level

NewL(MMdaAudioInputStreamCallback &)

CMMFMdaAudioInputStream * NewL ( MMdaAudioInputStreamCallback & aCallback ) [static]

Parameters

MMdaAudioInputStreamCallback & aCallback

NewL(MMdaAudioInputStreamCallback &, TInt, TInt)

CMMFMdaAudioInputStream * NewL ( MMdaAudioInputStreamCallback & aCallback,
TInt aPriority,
TInt aPref
) [static]

Parameters

MMdaAudioInputStreamCallback & aCallback
TInt aPriority
TInt aPref

Open(TMdaPackage *)

void Open ( TMdaPackage * aSettings )

Open a audio ouptut stream

Parameters

TMdaPackage * aSettings

PlayError(TInt)

void PlayError ( TInt aError )

Called when record operation complete, successfully or otherwise

Parameters

TInt aError

Position()

const TTimeIntervalMicroSeconds & Position ( )

To get the current position in the data stream

Read(TDes8 &)

TInt Read ( TDes8 & aData ) [private]

To read data from input stream

capability
UserEnvironment For recording - the requesting client process must have the UserEnvironment capability.

Parameters

TDes8 & aData

ReadL(TDes8 &)

void ReadL ( TDes8 & aData )

To read data from input stream

capability
UserEnvironment For recording - the requesting client process must have the UserEnvironment capability.

Parameters

TDes8 & aData

RealSetAudioPropertiesL(TInt, TInt)

void RealSetAudioPropertiesL ( TInt aSampleRate,
TInt aChannels
) [private]

Parameters

TInt aSampleRate
TInt aChannels

RecordError(TInt)

void RecordError ( TInt aError )

Do not support

Parameters

TInt aError

RequestStop()

void RequestStop ( )

To pause write data to stream Allow yet unprocessed buffers to be processed and passed back via BufferToBeEmptied. When the last (empty) buffer arrives, Stop is called.

SetAudioPropertiesL(TInt, TInt)

void SetAudioPropertiesL ( TInt aSampleRate,
TInt aChannels
)

Set audio input stream properties

Parameters

TInt aSampleRate
TInt aChannels

SetBalanceL(TInt)

void SetBalanceL ( TInt aBalance =  KMMFBalanceCenter )

Set audio input stream balance

Parameters

TInt aBalance =  KMMFBalanceCenter

SetBitRateL(TInt)

void SetBitRateL ( TInt aBitRate )

Parameters

TInt aBitRate

SetDataTypeL(TFourCC)

void SetDataTypeL ( TFourCC aAudioType )

Parameters

TFourCC aAudioType

SetGain(TInt)

void SetGain ( TInt aGain )

Set audio input stream gain to the specified value

Parameters

TInt aGain

SetPriority(TInt, TInt)

void SetPriority ( TInt aPriority,
TInt aPref
)

Set audio input stream priority

Parameters

TInt aPriority
TInt aPref

SetSingleBufferMode(TBool)

void SetSingleBufferMode ( TBool aSingleMode )

Parameters

TBool aSingleMode

ShutDown()

void ShutDown ( )

Stop()

void Stop ( )

To stop write data to stream

ToneFinished(TInt)

void ToneFinished ( TInt aError )

Do not support

Parameters

TInt aError

Member Enumerations Documentation

Enum TIsOpenState

Enumerators

EIsNotOpen
EIsOpening
EIsOpen

Enum TState

Enumerators

EStopped
ERecording
EStopping

Member Data Documentation

CActiveCallback * iActiveCallback

CActiveCallback * iActiveCallback [private]

CActiveSchedulerWait * iActiveSchedulerWait

CActiveSchedulerWait * iActiveSchedulerWait [private]

TBool iAudioDataStored

TBool iAudioDataStored [private]

TPtr8 iBufferPtr

TPtr8 iBufferPtr [private]

TInt iBytesRecorded

TInt iBytesRecorded [private]

MMdaAudioInputStreamCallback & iCallback

MMdaAudioInputStreamCallback & iCallback [private]

TFourCC iDataTypeCode

TFourCC iDataTypeCode [private]

CMMFDevSound * iDevSound

CMMFDevSound * iDevSound [private]

CMMFFifo< TDes8 > * iFifo

CMMFFifo < TDes8 > * iFifo [private]

TBool iInitCallFrmSetDataType

TBool iInitCallFrmSetDataType [private]

TInt iInitializeState

TInt iInitializeState [private]

TIsOpenState iIsOpenState

TIsOpenState iIsOpenState [private]

TTimeIntervalMicroSeconds iPosition

TTimeIntervalMicroSeconds iPosition [private]

TMdaAudioDataSettings iSettings

TMdaAudioDataSettings iSettings [private]

TBool iSingleBuffer

TBool iSingleBuffer [private]

TInt iState

TInt iState [private]

TPtr8 iStorageItem

TPtr8 iStorageItem [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.