Symbian^3 Application Developer Library >

CSbcEncoderIntfc Class Reference

class CSbcEncoderIntfc : public CBase

Interface for configuring the SBC encoder. Used to configure the SBC encoder operating modes. This abstract class just provides the static NewL function for the creation of the proxy, and also defines the custom interface to be implemented by the proxy and the real custom interface implementation.

SbcEncoderIntfc.lib
Since
S60 3.0

Inherits from

Public Member Functions
IMPORT_C TInt ApplyConfig ()
IMPORT_C TInt GetAllocationMethod ( TSbcAllocationMethod &)
IMPORT_C TInt GetBitpoolSize ( TUint &)
IMPORT_C TInt GetChannelMode ( TSbcChannelMode &)
IMPORT_C TInt GetNumOfBlocks ( TUint &)
IMPORT_C TInt GetNumOfSubbands ( TUint &)
IMPORT_C TInt GetSamplingFrequency ( TUint &)
IMPORT_C TInt GetSupportedAllocationMethods ( RArray < TSbcAllocationMethod > &)
IMPORT_C TInt GetSupportedBitpoolRange ( TUint &, TUint &)
IMPORT_C TInt GetSupportedChannelModes ( RArray < TSbcChannelMode > &)
IMPORT_C TInt GetSupportedNumOfBlocks ( RArray < TUint > &)
IMPORT_C TInt GetSupportedNumOfSubbands ( RArray < TUint > &)
IMPORT_C TInt GetSupportedSamplingFrequencies ( RArray < TUint > &)
IMPORT_C CSbcEncoderIntfc * NewL ( CMMFDevSound &)
IMPORT_C CSbcEncoderIntfc * NewL ( CMdaAudioInputStream &)
IMPORT_C void SetAllocationMethod ( TSbcAllocationMethod )
IMPORT_C void SetBitpoolSize ( TUint )
IMPORT_C void SetChannelMode ( TSbcChannelMode )
IMPORT_C void SetNumOfBlocks ( TUint )
IMPORT_C void SetNumOfSubbands ( TUint )
IMPORT_C void SetSamplingFrequency ( TUint )
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()
Public Member Enumerations
enum TSbcAllocationMethod { ESbcAllocationSNR , ESbcAllocationLoudness }
enum TSbcChannelMode { ESbcChannelMono , ESbcChannelDual , ESbcChannelStereo , ESbcChannelJointStereo }

Member Functions Documentation

ApplyConfig()

IMPORT_C TInt ApplyConfig ( ) [pure virtual]
Applies configuration to the encoder.
Since
S60 3.0

GetAllocationMethod(TSbcAllocationMethod &)

IMPORT_C TInt GetAllocationMethod ( TSbcAllocationMethod & aAllocationMethod ) [pure virtual]
Retrieves the current encode allocation method.
Since
S60 3.0

Parameters

TSbcAllocationMethod & aAllocationMethod returns current encode allocation method.

GetBitpoolSize(TUint &)

IMPORT_C TInt GetBitpoolSize ( TUint & aBitpoolSize ) [pure virtual]
Retrieves the current encode bitpool size.
Since
S60 3.0

Parameters

TUint & aBitpoolSize returns current encode bitpool size.

GetChannelMode(TSbcChannelMode &)

IMPORT_C TInt GetChannelMode ( TSbcChannelMode & aChannelMode ) [pure virtual]
Retrieves the current encode channel mode.
Since
S60 3.0

Parameters

TSbcChannelMode & aChannelMode returns current encode channel mode.

GetNumOfBlocks(TUint &)

IMPORT_C TInt GetNumOfBlocks ( TUint & aNumOfBlocks ) [pure virtual]
Retrieves the current encode number of blocks.
Since
S60 3.0

Parameters

TUint & aNumOfBlocks returns current encode number of blocks.

GetNumOfSubbands(TUint &)

IMPORT_C TInt GetNumOfSubbands ( TUint & aNumOfSubbands ) [pure virtual]
Retrieves the current encode number of subbands.
Since
S60 3.0

Parameters

TUint & aNumOfSubbands returns current encode number of subbands.

GetSamplingFrequency(TUint &)

IMPORT_C TInt GetSamplingFrequency ( TUint & aSamplingFrequency ) [pure virtual]
Retrieves the current encode sampling frequency.
Since
S60 3.0

Parameters

TUint & aSamplingFrequency returns current encode sampling frequency.

GetSupportedAllocationMethods(RArray< TSbcAllocationMethod > &)

IMPORT_C TInt GetSupportedAllocationMethods ( RArray < TSbcAllocationMethod > & aSupportedAllocationMethods ) [pure virtual]
Retrieves the allocation methods supported by the encoder.
Since
S60 3.0

Parameters

RArray < TSbcAllocationMethod > & aSupportedAllocationMethods array returning the supported allocation methods.

GetSupportedBitpoolRange(TUint &, TUint &)

IMPORT_C TInt GetSupportedBitpoolRange ( TUint & aMinSupportedBitpoolSize,
TUint & aMaxSupportedBitpoolSize
) [pure virtual]
Retrieves the supported bitpool range by the encoder.
Since
S60 3.0

Parameters

TUint & aMinSupportedBitpoolSize returning the min bitpool size.
TUint & aMaxSupportedBitpoolSize returning the max bitpool size.

GetSupportedChannelModes(RArray< TSbcChannelMode > &)

IMPORT_C TInt GetSupportedChannelModes ( RArray < TSbcChannelMode > & aSupportedChannelModes ) [pure virtual]
Retrieves the channel configurations supported by the encoder.
Since
S60 3.0

Parameters

RArray < TSbcChannelMode > & aSupportedChannelModes array returning the supported frequencies.

GetSupportedNumOfBlocks(RArray< TUint > &)

IMPORT_C TInt GetSupportedNumOfBlocks ( RArray < TUint > & aSupportedNumOfBlocks ) [pure virtual]
Retrieves array of supported block numbers by the encoder.
Since
S60 3.0

Parameters

RArray < TUint > & aSupportedNumOfBlocks

GetSupportedNumOfSubbands(RArray< TUint > &)

IMPORT_C TInt GetSupportedNumOfSubbands ( RArray < TUint > & aSupportedNumOfSubbands ) [pure virtual]
Retrieves the number of subbands supported by the encoder.
Since
S60 3.0

Parameters

RArray < TUint > & aSupportedNumOfSubbands array returning the supported number of subbands.

GetSupportedSamplingFrequencies(RArray< TUint > &)

IMPORT_C TInt GetSupportedSamplingFrequencies ( RArray < TUint > & aSupportedSamplingFrequencies ) [pure virtual]
Retrieves the sampling frequencies supported by the encoder.
Since
S60 3.0

Parameters

RArray < TUint > & aSupportedSamplingFrequencies array returning the supported frequencies.

NewL(CMMFDevSound &)

IMPORT_C CSbcEncoderIntfc * NewL ( CMMFDevSound & aDevSound ) [static]

Creates the interface.

CSbcEncoderIntfc::NewL

Creates the custom interface. Calls the custom interface method on the devsound passed in. Devsound will return the handle to the custom interface proxy.

(other items were commented in a header).

Parameters

CMMFDevSound & aDevSound

NewL(CMdaAudioInputStream &)

IMPORT_C CSbcEncoderIntfc * NewL ( CMdaAudioInputStream & aUtility ) [static]

Creates the interface.

CSbcEncoderIntfc::NewL

Creates the custom interface. Calls the custom interface method on the CMdaAudioInputStream passed in. The CMdaAudioInputStream utility will return the handle to the custom interface proxy.

(other items were commented in a header).

Parameters

CMdaAudioInputStream & aUtility

SetAllocationMethod(TSbcAllocationMethod)

IMPORT_C void SetAllocationMethod ( TSbcAllocationMethod aAllocationMethod ) [pure virtual]
Sets the allocation method for encoding.
Since
S60 3.0

Parameters

TSbcAllocationMethod aAllocationMethod requested encoding allocation method.

SetBitpoolSize(TUint)

IMPORT_C void SetBitpoolSize ( TUint aBitpoolSize ) [pure virtual]
Sets the bitpool size for encoding.
Since
S60 3.0

Parameters

TUint aBitpoolSize requested encoding number of blocks.

SetChannelMode(TSbcChannelMode)

IMPORT_C void SetChannelMode ( TSbcChannelMode aChannelMode ) [pure virtual]
Sets the channel mode for encoding.
Since
S60 3.0

Parameters

TSbcChannelMode aChannelMode requested encoding channel mode.

SetNumOfBlocks(TUint)

IMPORT_C void SetNumOfBlocks ( TUint aNumOfBlocks ) [pure virtual]
Sets the number of blocks for encoding.
Since
S60 3.0

Parameters

TUint aNumOfBlocks requested encoding number of blocks.

SetNumOfSubbands(TUint)

IMPORT_C void SetNumOfSubbands ( TUint aNumOfSubbands ) [pure virtual]
Sets the number of subbands for encoding.
Since
S60 3.0

Parameters

TUint aNumOfSubbands

SetSamplingFrequency(TUint)

IMPORT_C void SetSamplingFrequency ( TUint aSamplingFrequency ) [pure virtual]
Sets the sampling frequency for encoding.
Since
S60 3.0

Parameters

TUint aSamplingFrequency requested encoding sampling frequency.

Member Enumerations Documentation

Enum TSbcAllocationMethod

Enumerators

ESbcAllocationSNR
ESbcAllocationLoudness

Enum TSbcChannelMode

Enumerators

ESbcChannelMono
ESbcChannelDual
ESbcChannelStereo
ESbcChannelJointStereo

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.