Collapse all Symbian^3 Product Developer Library

CBTAudioStreamInputBase Class Reference

class CBTAudioStreamInputBase : public CBase

This class specifies the interface for receiving audio data from audio subsystem.

This class contains the interface definition. It can't be instantiated directly, but instead the implementation is done in the class inherited from this class.

Also, the factory method for the base class must be implemented by the implementator of this interface.

btaudioadaptation.lib

Since: S60 v3.1

Inherits from

CBTAudioStreamInputBase
- CBase

Public Member Functions
void	BufferEmptied(const TDesC8 &)
TInt	Connect()
void	Disconnect()
TAny *	EncoderInterface(TUid)
IMPORT_C CBTAudioStreamInputBase *	NewL(MBTAudioStreamObserver &, MBTAudioErrorObserver &)
TInt	SetFormat(TFourCC)
TInt	Start()
void	Stop()

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()

Member Functions Documentation

BufferEmptied(const TDesC8 &)

void

BufferEmptied

(

const TDesC8 &

aBuffer

)

[pure virtual]

This method is called when the client has processed the buffer it got from the Receive method.

See BT Audio Adaptation API and BT Audio Adaptation Design specifications for detailed explanation.

Since: S60 v3.1

Parameters

const TDesC8 & aBuffer

refers to the buffer that was received earlier in the Receive method.

Connect()

TInt

Connect

(

)

[pure virtual]

This method is for connecting to the audio subsystem.

See BT Audio Adaptation API and BT Audio Adaptation Design specifications for detailed explanation.

Since: S60 v3.1

Disconnect()

void

Disconnect

(

)

[pure virtual]

This method is for disconnecting from the audio subsystem.

See BT Audio Adaptation API and BT Audio Adaptation Design specifications for detailed explanation.

Since: S60 v3.1

EncoderInterface(TUid)

TAny *

EncoderInterface

(

TUid

aInterfaceId

)

[pure virtual]

This method is for passing the custom interfaces that are needed sometimes for configuring the hardware encoder.

See BT Audio Adaptation API and BT Audio Adaptation Design specifications for detailed explanation.

Since: S60 v3.1

Parameters

TUid aInterfaceId

specifies the id of custom interface that the client wants to get.

NewL(MBTAudioStreamObserver &, MBTAudioErrorObserver &)

IMPORT_C CBTAudioStreamInputBase *	NewL	(	MBTAudioStreamObserver &	aStreamObserver,
			MBTAudioErrorObserver &	aErrorObserver
		)	[static]

Parameters

MBTAudioStreamObserver & aStreamObserver
MBTAudioErrorObserver & aErrorObserver

SetFormat(TFourCC)

TInt

SetFormat

(

TFourCC

aDesiredFourCC

)

[pure virtual]

This method is for choosing the encoder for the audio data.

See BT Audio Adaptation API and BT Audio Adaptation Design specifications for detailed explanation.

Since: S60 v3.1

Parameters

TFourCC aDesiredFourCC

specifies the encoder that the client wants to use.

Start()

TInt

Start

(

)

[pure virtual]

This method is for starting the recording from the audio subsystem.

See BT Audio Adaptation API and BT Audio Adaptation Design specifications for detailed explanation.

Since: S60 v3.1

Stop()

void

Stop

(

)

[pure virtual]

This method is for stopping the recording from the audio subsystem.

See BT Audio Adaptation API and BT Audio Adaptation Design specifications for detailed explanation.

Since: S60 v3.1