Symbian^3 Product Developer Library >

CMPSettingsModel Class Reference

class CMPSettingsModel : public CBase

CMPSettingsModel Common API for MMF specific settings models.

MPSettEngine.dll
Since
2.0

Inherits from

Public Member Functions
~CMPSettingsModel()
TInt AutoDisconTimeL()
TInt GetBandwidthControlMode(TInt &)
TInt GetConnectionTimeout(TInt &)
TInt GetControllerAdditionalInfo(TDes &)
TInt GetControllerBuildDate(TDes &)
TInt GetControllerVersionInfo(TDes &)
TInt GetDefaultAp(TUint32 &)
TInt GetDemandBwFactor(TInt &)
TInt GetMaxBandwidth(TInt &, TDataBearer)
TInt GetMaxBwPresetsL(RArray< TInt > &, TDataBearer)
TInt GetMaxUDPPort(TInt &)
TInt GetMinUDPPort(TInt &)
TInt GetProxyHostName(TDes &)
TInt GetProxyMode(TInt &)
TInt GetProxyPort(TInt &)
TInt GetServerTimeout(TInt &)
TInt GetSustainBandwidth(TInt &, TDataBearer)
TInt GetSustainBwPresetsL(RArray< TInt > &, TDataBearer)
TInt GetVideoContrast(TInt &)
TBool IsDefaultViewOnL()
TBool IsRockerKeysSupportedL()
TBool IsVideoRepeatOnL()
IMPORT_C voidListImplementationsL(RImplInfoPtrArray &)
voidLoadSettingsL(TInt)
IMPORT_C CMPSettingsModel *NewL(TUid)
voidSetAutoDisconTimeL(const TInt)
TInt SetBandwidthControlMode(TInt)
TInt SetConnectionTimeout(TInt)
TInt SetDefaultAp(TUint32)
voidSetDefaultViewL(const TBool)
TInt SetDemandBwFactor(TInt)
TInt SetMaxBandwidth(TInt, TDataBearer)
TInt SetMaxUDPPort(TInt)
TInt SetMinUDPPort(TInt)
TInt SetProxyHostNameL(const TDesC &)
TInt SetProxyMode(TInt)
TInt SetProxyPort(TInt)
voidSetRockerKeysL(const TBool)
TInt SetServerTimeout(TInt)
TInt SetSustainBandwidth(TInt, TDataBearer)
TInt SetVideoContrast(TInt)
voidSetVideoRepeatL(const TBool)
TBool ShowRockerKeysL()
voidStoreSettingsL()
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()
Protected Attributes
TUid iDtor_ID_Key

Constructor & Destructor Documentation

~CMPSettingsModel()

IMPORT_C~CMPSettingsModel()[virtual]

Destructor.

Member Functions Documentation

AutoDisconTimeL()

TInt AutoDisconTimeL()[pure virtual]
Returns Media Player auto disconnection time.
Since
2.0

GetBandwidthControlMode(TInt &)

TInt GetBandwidthControlMode(TInt &aMode)[pure virtual]
Returns bandwidth control mode.
Since
2.0

Parameters

TInt & aModebandwidth control mode: 0: Use dynamic bw control if possible 1: Use static bw control

GetConnectionTimeout(TInt &)

TInt GetConnectionTimeout(TInt &aTimeout)[pure virtual]
Returns connection timeout.
Since
2.0

Parameters

TInt & aTimeoutTimeout in minutes.

GetControllerAdditionalInfo(TDes &)

TInt GetControllerAdditionalInfo(TDes &aAdditionalInfo)[pure virtual]
Provides additional information about MMF controller.
Since
2.0

Parameters

TDes & aAdditionalInfoAdditional controller information.

GetControllerBuildDate(TDes &)

TInt GetControllerBuildDate(TDes &aBldDate)[pure virtual]
Provides MMF controller's build date.
Since
2.0

Parameters

TDes & aBldDateController build date.

GetControllerVersionInfo(TDes &)

TInt GetControllerVersionInfo(TDes &aVersion)[pure virtual]
Provides MMF controller version information.
Since
2.0

Parameters

TDes & aVersionController version number.

GetDefaultAp(TUint32 &)

TInt GetDefaultAp(TUint32 &aApId)[pure virtual]
Returns default access point ID.
Since
2.0

Parameters

TUint32 & aApIdAccess point ID.

GetDemandBwFactor(TInt &)

TInt GetDemandBwFactor(TInt &aFactor)[pure virtual]
Returns demand factor bandwidth.
Since
2.1

Parameters

TInt & aFactorDemand bandwidth factor.

GetMaxBandwidth(TInt &, TDataBearer)

TInt GetMaxBandwidth(TInt &aMaxBw,
TDataBeareraBearer
)[pure virtual]
Returns maximum bandwidth.
Since
2.1

Parameters

TInt & aMaxBwMaximum bandwidth.
TDataBearer aBearerBearer, which max bw is enquired.

GetMaxBwPresetsL(RArray< TInt > &, TDataBearer)

TInt GetMaxBwPresetsL(RArray< TInt > &aBwArray,
TDataBeareraBearer
)[pure virtual]
Returns an array of the fixed max bandwidth values.
Since
2.1

Parameters

RArray< TInt > & aBwArrayFixed max bandwidth values are copied to this array.
TDataBearer aBearerBearer, which fixed max bw values is enquired.

GetMaxUDPPort(TInt &)

TInt GetMaxUDPPort(TInt &aPort)[pure virtual]
Returns maximum UDP port number.
Since
2.0

Parameters

TInt & aPortmaximum UDP port number in minutes.

GetMinUDPPort(TInt &)

TInt GetMinUDPPort(TInt &aPort)[pure virtual]
Returns minimum UDP port number.
Since
2.0

Parameters

TInt & aPortminimum UDP port number in minutes.

GetProxyHostName(TDes &)

TInt GetProxyHostName(TDes &aHostName)[pure virtual]
Returns proxy host name.
Since
2.0

Parameters

TDes & aHostNameProxy host name.

GetProxyMode(TInt &)

TInt GetProxyMode(TInt &aMode)[pure virtual]
Returns proxy mode.
Since
2.0

Parameters

TInt & aModeProxy mode: 0: Disabled 1: Enabled

GetProxyPort(TInt &)

TInt GetProxyPort(TInt &aPort)[pure virtual]
Returns proxy port number..
Since
2.0

Parameters

TInt & aPort

GetServerTimeout(TInt &)

TInt GetServerTimeout(TInt &aTimeout)[pure virtual]
Returns server timeout.
Since
2.0

Parameters

TInt & aTimeoutTimeout in minutes.

GetSustainBandwidth(TInt &, TDataBearer)

TInt GetSustainBandwidth(TInt &aSustainBw,
TDataBeareraBearer
)[pure virtual]
Returns sustainable bandwidth.
Since
2.1

Parameters

TInt & aSustainBwSustainable bandwidth.
TDataBearer aBearerBearer, which sustain bw is enquired.

GetSustainBwPresetsL(RArray< TInt > &, TDataBearer)

TInt GetSustainBwPresetsL(RArray< TInt > &aBwArray,
TDataBeareraBearer
)[pure virtual]
Returns an array of the fixed sustainable bandwidth values.
Since
2.1

Parameters

RArray< TInt > & aBwArrayFixed sustain bandwidth values are copied to this array.
TDataBearer aBearerBearer, which fixed sustain bw values is enquired.

GetVideoContrast(TInt &)

TInt GetVideoContrast(TInt &aContrast)[pure virtual]
Returns video contrast level.
Since
2.0

Parameters

TInt & aContrastContrast level: 0: Minimum contrast 20: 20% of maximum 40: 40% of maximum 60: 60% of maximum 80: 80% of maximum 100: Maximum contrast

IsDefaultViewOnL()

TBool IsDefaultViewOnL()[pure virtual]
Returns video view mode.
Since
3.2

IsRockerKeysSupportedL()

TBool IsRockerKeysSupportedL()[pure virtual]
Returns if Rocker Keys Feature is supported
Since
3.2

IsVideoRepeatOnL()

TBool IsVideoRepeatOnL()[pure virtual]
Returns video repeat mode.
Since
2.0

ListImplementationsL(RImplInfoPtrArray &)

IMPORT_C voidListImplementationsL(RImplInfoPtrArray &aImplInfoArray)[static]
Provides an implementation information array.
Since
2.1

Parameters

RImplInfoPtrArray & aImplInfoArrayAn array which is populated with the implementation information of the available implementations.

LoadSettingsL(TInt)

voidLoadSettingsL(TIntaConfigVersion)[pure virtual]
Reads settings from MMF controller.
Since
2.0

Parameters

TInt aConfigVersion

NewL(TUid)

IMPORT_C CMPSettingsModel *NewL(TUidaUid)[static]

Constructor. Uses ECom to construct an instance of this class.

Parameters

TUid aUidImplementation uid of the object that is to be constructed.

SetAutoDisconTimeL(const TInt)

voidSetAutoDisconTimeL(const TIntaTime)[pure virtual]
Sets Media Player auto disconnection time.
Since
2.0

Parameters

const TInt aTimeAuto disconnection time.

SetBandwidthControlMode(TInt)

TInt SetBandwidthControlMode(TIntaMode)[pure virtual]
Sets bandwidth control mode.
Since
2.0

Parameters

TInt aModebandwidth control mode.

SetConnectionTimeout(TInt)

TInt SetConnectionTimeout(TIntaTimeout)[pure virtual]
Sets connection timeout.
Since
2.0

Parameters

TInt aTimeoutTimeout in minutes.

SetDefaultAp(TUint32)

TInt SetDefaultAp(TUint32aApId)[pure virtual]
Sets default access point.
Since
2.0

Parameters

TUint32 aApIdAccess point ID.

SetDefaultViewL(const TBool)

voidSetDefaultViewL(const TBoolaView)[pure virtual]
Sets video view mode.
Since
3.2

Parameters

const TBool aViewView mode.

SetDemandBwFactor(TInt)

TInt SetDemandBwFactor(TIntaFactor)[pure virtual]
Sets demand bandwidth factor.
Since
2.1

Parameters

TInt aFactorDemand bandwidth factor.

SetMaxBandwidth(TInt, TDataBearer)

TInt SetMaxBandwidth(TIntaMaxBw,
TDataBeareraBearer
)[pure virtual]
Sets maximum bandwidth.
Since
2.1

Parameters

TInt aMaxBwMaximum bandwidth.
TDataBearer aBearerBearer, which max bw is set.

SetMaxUDPPort(TInt)

TInt SetMaxUDPPort(TIntaPort)[pure virtual]
Sets maximum UDP port number.
Since
2.0

Parameters

TInt aPortmaximum port number.

SetMinUDPPort(TInt)

TInt SetMinUDPPort(TIntaPort)[pure virtual]
Sets minimum UDP port number.
Since
2.0

Parameters

TInt aPortminimum port number.

SetProxyHostNameL(const TDesC &)

TInt SetProxyHostNameL(const TDesC &aHostName)[pure virtual]
Sets Proxy host name.
Since
2.0

Parameters

const TDesC & aHostNameProxy host name.

SetProxyMode(TInt)

TInt SetProxyMode(TIntaMode)[pure virtual]
Sets proxy mode..
Since
2.0

Parameters

TInt aModeProxy mode.

SetProxyPort(TInt)

TInt SetProxyPort(TIntaPort)[pure virtual]
Sets proxy port number.
Since
2.0

Parameters

TInt aPortProxy port number.

SetRockerKeysL(const TBool)

voidSetRockerKeysL(const TBoolaRockerKeys)[pure virtual]
Sets rocker keys mode.
Since
3.2

Parameters

const TBool aRockerKeysrocker keys mode.

SetServerTimeout(TInt)

TInt SetServerTimeout(TIntaTimeout)[pure virtual]
Sets server timout.
Since
2.0

Parameters

TInt aTimeoutTimeout in minutes.

SetSustainBandwidth(TInt, TDataBearer)

TInt SetSustainBandwidth(TIntaSustainBw,
TDataBeareraBearer
)[pure virtual]
Sets sustainable bandwidth.
Since
2.1

Parameters

TInt aSustainBwSustainable bandwidth.
TDataBearer aBearerBearer, which sustain bw is set.

SetVideoContrast(TInt)

TInt SetVideoContrast(TIntaContrast)[pure virtual]
Sets video contrast
Since
2.0

Parameters

TInt aContrastContrast level

SetVideoRepeatL(const TBool)

voidSetVideoRepeatL(const TBoolaRepeat)[pure virtual]
Sets video repeat mode.
Since
2.0

Parameters

const TBool aRepeatRepeat mode.

ShowRockerKeysL()

TBool ShowRockerKeysL()[pure virtual]
Returns Rocker Keys mode
Since
3.2

StoreSettingsL()

voidStoreSettingsL()[pure virtual]
Writes settings to MMF controller.
Since
2.0

Member Data Documentation

TUid iDtor_ID_Key

TUid iDtor_ID_Key[protected]

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.