Symbian^3 Application Developer Library >

MPEEngineInfo Class Reference

class MPEEngineInfo

Offers engine info interface to phone application

phoneengine.lib
Since
Series 60 4.0
Public Member Functions
const CCCECallParameters::TCCELineType & ALSLine ()
const TBool & ALSLineSupport ()
const TPEActiveForwardInfo & ActiveForwardingInfo ()
const TArray < TContactItemId > AlertForGroup ()
const TBool & AudioMute ()
const TPEAudioOutput & AudioOutput ()
TBool AudioOutputAvailable (const TPEAudioOutput )
const TInt & AudioVolume ()
const TPEBarringInfo & BarringInfo ()
CCCECallParameters::TCCELineType CallALSLine (const TInt )
const TDesC & CallBackAddress ()
const MPEClientInformation & CallClientInformation (const TInt )
TInt CallConference (const TInt )
TPECallControlCaps CallControlCaps (const TInt )
RMobileCall::TMobileCallDirection CallDirection (const TInt )
const TInt & CallDuration ()
TTimeIntervalSeconds CallDuration (const TInt )
TBool CallForwarded (const TInt )
const TInt & CallId ()
TPECallOrigin CallOrigin (const TInt )
RMobilePhone::TMobileService CallService (const TInt )
const TTime & CallStartTime (const TInt )
TPEState CallState (const TInt )
TPECallType CallType (const TInt )
const TPECallType & CallTypeCommand ()
const TPtrC CallerImage (const TInt )
const TPtrC CallerText (const TInt )
CFbsBitmap * CallerThumbnail (const TInt )
TBool CheckIfCallStateExists (const TPEState &)
TUint32 ConferenceCallCaps (const TInt )
TPEState ConferenceCallState ()
const TName & ConferenceMemberName (const TInt )
const TArray < TContactItemId > ContactGroups (const TInt )
const TDesC8 & ContactLink (const TInt )
const TName & DataPortName ()
const TPEDtmfString & DtmfString ()
const TPEPhoneNumber & EmergencyNumber ()
const TPEErrorInfo & ErrorInfo ()
const CDesC8Array * ForwardAddressChoices ( TInt )
TInt ForwardAddressIndex ()
TBool HasCallerThumbnail (const TInt )
TInt IsConferenceMemberId (const TInt )
TBool IsSecureCall (const TInt )
TBool IsSwitchToOperationOngoing ()
TBool IsTransferDial ()
const TChar & KeyCode ()
const TInt & KeypadVolume ()
const TPELifeTimeData & LifeTimerData ()
TBool LoggingIndicator (const TInt )
TBool MissedCall (const TInt )
const TNWNetworkRegistrationStatus & NetworkRegistrationStatus ()
TInt NumberOfConferenceMembers (const TInt )
const TPEContactFileName & PersonalRingingTone (const TInt )
const TBool & PersonalToneStatus ()
const TPEPhoneIdentityParameters & PhoneIdentityParameters ()
const TPEPhoneNumber & PhoneNumber ()
const TBool & PhoneNumberIsServiceCode ()
const TInt & ProfileId ()
const TPEProfileName & ProfileName ()
const TPEPhoneNumber & RemoteColpNumber (const TInt )
const TPEContactCompany & RemoteCompanyName (const TInt )
RMobileCall::TMobileCallRemoteIdentityStatus RemoteIdentity (const TInt )
const TPEContactName & RemoteName (const TInt )
const TPEContactName & RemotePartyName (const TInt )
const TPEPhoneNumber & RemotePhoneNumber (const TInt )
const TPEPhoneNumberIdType & RemotePhoneNumberType (const TInt )
const CDesCArray & RemotePredefinedDtmfStrings (const TInt )
const TPtrC RemoteTextToSpeechText (const TInt )
const TPEContactFileName & RingingTone (const TInt &)
const TProfileRingingType & RingingType ()
const TInt & RingingVolume ()
const TPEPhoneAudioRouteParameters & RouteParameters ()
const TPESSCommandInfo & SSCommandInfo ()
TBool SecureSpecified ()
TUint32 ServiceId (const TInt )
TUint32 ServiceIdCommand ()
void SetAudioMuteCommand (const TInt &)
void SetAudioOutputCommand (const TPEAudioOutput &, const TBool )
void SetAudioVolumeCommand (const TInt &)
void SetCallBackAddress (const TDesC &)
void SetCallId (const TInt &)
void SetCallTypeCommand (const TPECallType &)
void SetDtmfStringCommand (const TPEDtmfString &)
void SetEmergencyNumber (const TPEPhoneNumber &)
void SetForwardAddressChoices (const CDesC8Array *, TInt )
void SetForwardAddressIndex ( TInt )
void SetIsTransferDial ( TBool )
void SetKeyCode (const TChar &)
void SetPhoneNumber (const TPEPhoneNumber &)
void SetServiceIdCommand ( TUint32 )
void SetTransferTargetCommand (const TPEPhoneNumber &)
void SetUnattendedTransferTarget (const TPEPhoneNumber &, TInt )
const TPESimState & SimState ()
const TBool & TextToSpeech ()
const TPEPhoneNumber & TransferTargetCommand ()
const TBool & TwoDigitSupportStatus ()
const TPEPhoneNumber & UnattendedTransferTarget ( TInt )
const TPEPhoneNumber & VoiceMailBoxNumberLine1 ()
const TPEPhoneNumber & VoiceMailBoxNumberLine2 ()

Member Functions Documentation

ALSLine()

const CCCECallParameters::TCCELineType & ALSLine ( ) const [pure virtual]

Gets active als line of the phone from TPEBasicInfo-structure

ALSLineSupport()

const TBool & ALSLineSupport ( ) const [pure virtual]

Gets ALS support of the phone from TPEBasicInfo-structure

ActiveForwardingInfo()

const TPEActiveForwardInfo & ActiveForwardingInfo ( ) const [pure virtual]

Gets active forwarding information from TPEBasicInfo-structure

AlertForGroup()

const TArray < TContactItemId > AlertForGroup ( ) const [pure virtual]

Gets group ids which are active to play ring tone

AudioMute()

const TBool & AudioMute ( ) const [pure virtual]

Gets audio mute value

AudioOutput()

const TPEAudioOutput & AudioOutput ( ) const [pure virtual]

Gets current audio output path

AudioOutputAvailable(const TPEAudioOutput)

TBool AudioOutputAvailable ( const TPEAudioOutput aOutput ) const [pure virtual]

Gets audio output path availability

Parameters

const TPEAudioOutput aOutput

AudioVolume()

const TInt & AudioVolume ( ) const [pure virtual]

Gets audio volume value

BarringInfo()

const TPEBarringInfo & BarringInfo ( ) const [pure virtual]

Gets barring information from TPEBasicInfo-structure

CallALSLine(const TInt)

CCCECallParameters::TCCELineType CallALSLine ( const TInt aCallId ) const [pure virtual]

Gets line information for the specified call

Parameters

const TInt aCallId is the call identification number

CallBackAddress()

const TDesC & CallBackAddress ( ) const [pure virtual]

Returns unattended transfer call back address

CallClientInformation(const TInt)

const MPEClientInformation & CallClientInformation ( const TInt aCallId ) const [pure virtual]

Gets phone client information of the specified call

Parameters

const TInt aCallId is the call identification number

CallConference(const TInt)

TInt CallConference ( const TInt aCallId ) const [pure virtual]

Gets conference value from TPECallInfo-structure

Parameters

const TInt aCallId is the call identification number

CallControlCaps(const TInt)

TPECallControlCaps CallControlCaps ( const TInt aCallId ) const [pure virtual]

Gets call control caps from the TPECallInfo-structure

Parameters

const TInt aCallId is the call identification number

CallDirection(const TInt)

RMobileCall::TMobileCallDirection CallDirection ( const TInt aCallId ) const [pure virtual]

Gets call direction of the specified call

Parameters

const TInt aCallId is the call identification number

CallDuration()

const TInt & CallDuration ( ) const [pure virtual]

Gets duration of the last call to go idle

CallDuration(const TInt)

TTimeIntervalSeconds CallDuration ( const TInt aCallId ) const [pure virtual]

Gets call duration of the ongoing or last active call with specified id

Parameters

const TInt aCallId is the call identification number

CallForwarded(const TInt)

TBool CallForwarded ( const TInt aCallId ) const [pure virtual]

Gets forwarded value from TPECallInfo-structure

Parameters

const TInt aCallId is the call identification number

CallId()

const TInt & CallId ( ) const [pure virtual]

Gets identification number of a call

This value is used for determining the target for a command message that requires such information

CallOrigin(const TInt)

TPECallOrigin CallOrigin ( const TInt aCallId ) const [pure virtual]

Returns call origin for the call

Parameters

const TInt aCallId

CallService(const TInt)

RMobilePhone::TMobileService CallService ( const TInt aCallId ) const [pure virtual]

Gets Service information from TPECallInfo-structure

Parameters

const TInt aCallId is the call identification number.

CallStartTime(const TInt)

const TTime & CallStartTime ( const TInt aCallId ) const [pure virtual]

Gets start time of the call

Parameters

const TInt aCallId is the call identification number

CallState(const TInt)

TPEState CallState ( const TInt aCallId ) const [pure virtual]

Gets call state of a specified call

Parameters

const TInt aCallId is the call identification number

CallType(const TInt)

TPECallType CallType ( const TInt aCallId ) const [pure virtual]

Gets type of the specified call

Parameters

const TInt aCallId is the call identification number.

CallTypeCommand()

const TPECallType & CallTypeCommand ( ) const [pure virtual]

Gets last set call type information

CallerImage(const TInt)

const TPtrC CallerImage ( const TInt aCallId ) const [pure virtual]

Get caller image

Parameters

const TInt aCallId is the call identification number.

CallerText(const TInt)

const TPtrC CallerText ( const TInt aCallId ) const [pure virtual]

Get caller text

Parameters

const TInt aCallId is the call identification number.

CallerThumbnail(const TInt)

CFbsBitmap * CallerThumbnail ( const TInt aCallId ) const [pure virtual]

Get caller thumbnail

Parameters

const TInt aCallId is the call identification number.

CheckIfCallStateExists(const TPEState &)

TBool CheckIfCallStateExists ( const TPEState & aCallState ) [pure virtual]

Checks if given state can be found.

Parameters

const TPEState & aCallState state to be checked.

ConferenceCallCaps(const TInt)

TUint32 ConferenceCallCaps ( const TInt aCallId ) const [pure virtual]

Gets Conference call capabilities

Parameters

const TInt aCallId is the call identification number

ConferenceCallState()

TPEState ConferenceCallState ( ) const [pure virtual]

Gets call state of a conference call

ConferenceMemberName(const TInt)

const TName & ConferenceMemberName ( const TInt aCallId ) const [pure virtual]

Gets Conference call capabilities

Parameters

const TInt aCallId is the call identification number

ContactGroups(const TInt)

const TArray < TContactItemId > ContactGroups ( const TInt aCallId ) const [pure virtual]

Get user group ids this contact is assigned to

Parameters

const TInt aCallId is the call identification number.

ContactLink(const TInt)

const TDesC8 & ContactLink ( const TInt aCallId ) const [pure virtual]

Get remote contact link packet. See virtual phonebook API.

Parameters

const TInt aCallId is the call identification number.

DataPortName()

const TName & DataPortName ( ) const [pure virtual]

Gets the name of data port currently on-loan. Data port loaning is handled by CSPlugin and happens when a data call goes into connected state. The dataport is released when VT components indicate it can be released, i.e. video call hangup.

DtmfString()

const TPEDtmfString & DtmfString ( ) const [pure virtual]

Gets dtmf string

EmergencyNumber()

const TPEPhoneNumber & EmergencyNumber ( ) const [pure virtual]

Gets emergency number to be checked for validity

ErrorInfo()

const TPEErrorInfo & ErrorInfo ( ) const [pure virtual]

Gets error code and cause values for the latest error

ForwardAddressChoices(TInt)

const CDesC8Array * ForwardAddressChoices ( TInt aCallId ) const [pure virtual]

Returns address choices from received call forward request or NULL if addresses are not available.

Parameters

TInt aCallId Call identification number.

ForwardAddressIndex()

TInt ForwardAddressIndex ( ) [pure virtual]

Returns array index for user selected address. Address is used for call forwarding.

HasCallerThumbnail(const TInt)

TBool HasCallerThumbnail ( const TInt aCallId ) const [pure virtual]

Get caller thumbnail status

Parameters

const TInt aCallId

IsConferenceMemberId(const TInt)

TInt IsConferenceMemberId ( const TInt aCallId ) const [pure virtual]

Gets Conference call capabilities

Parameters

const TInt aCallId is the call identification number

IsSecureCall(const TInt)

TBool IsSecureCall ( const TInt aCallId ) const [pure virtual]

Gets secure status from call info

Parameters

const TInt aCallId

IsSwitchToOperationOngoing()

TBool IsSwitchToOperationOngoing ( ) const [pure virtual]

Returns switch to operation status.

IsTransferDial()

TBool IsTransferDial ( ) const [pure virtual]

Returns flag indicating unattended transfer dial

KeyCode()

const TChar & KeyCode ( ) const [pure virtual]

Gets key code of the last key press

KeypadVolume()

const TInt & KeypadVolume ( ) const [pure virtual]

Gets keypad volume value

LifeTimerData()

const TPELifeTimeData & LifeTimerData ( ) const [pure virtual]

Gets lifetimer data

LoggingIndicator(const TInt)

TBool LoggingIndicator ( const TInt aCallId ) const [pure virtual]

Gets a logging indicator

Parameters

const TInt aCallId

MissedCall(const TInt)

TBool MissedCall ( const TInt aCallId ) const [pure virtual]

Get missed call indicator

Parameters

const TInt aCallId

NetworkRegistrationStatus()

const TNWNetworkRegistrationStatus & NetworkRegistrationStatus ( ) const [pure virtual]

Gets network registration status

NumberOfConferenceMembers(const TInt)

TInt NumberOfConferenceMembers ( const TInt aCallId ) const [pure virtual]

Gets number of the conference members

Parameters

const TInt aCallId is the call identification number

PersonalRingingTone(const TInt)

const TPEContactFileName & PersonalRingingTone ( const TInt aCallId ) const [pure virtual]

Get ringing tone Returns a ringing tone defined for one of the user groups if personal tone is not found

Parameters

const TInt aCallId

PersonalToneStatus()

const TBool & PersonalToneStatus ( ) const [pure virtual]

Gets personal tone status

PhoneIdentityParameters()

const TPEPhoneIdentityParameters & PhoneIdentityParameters ( ) const [pure virtual]

Gets phone identity parameters

PhoneNumber()

const TPEPhoneNumber & PhoneNumber ( ) const [pure virtual]

Gets phone number

PhoneNumberIsServiceCode()

const TBool & PhoneNumberIsServiceCode ( ) const [pure virtual]

Gets phone number parsing result

ProfileId()

const TInt & ProfileId ( ) const [pure virtual]

Gets profile id

ProfileName()

const TPEProfileName & ProfileName ( ) const [pure virtual]

Gets profile name

RemoteColpNumber(const TInt)

const TPEPhoneNumber & RemoteColpNumber ( const TInt aCallId ) const [pure virtual]

Get remote end connected phone number

Parameters

const TInt aCallId

RemoteCompanyName(const TInt)

const TPEContactCompany & RemoteCompanyName ( const TInt aCallId ) const [pure virtual]

Gets contact company name

Parameters

const TInt aCallId

RemoteIdentity(const TInt)

RMobileCall::TMobileCallRemoteIdentityStatus RemoteIdentity ( const TInt aCallId ) const [pure virtual]

Gets remote party identity

Parameters

const TInt aCallId is the Call identification number

RemoteName(const TInt)

const TPEContactName & RemoteName ( const TInt aCallId ) const [pure virtual]

Gets contact name Depending on user selected language may be in order: first + last name OR last + first name

Parameters

const TInt aCallId

RemotePartyName(const TInt)

const TPEContactName & RemotePartyName ( const TInt aCallId ) const [pure virtual]

Gets remote party name. Contains possible recieved CNAP name or received skype identification

Parameters

const TInt aCallId

RemotePhoneNumber(const TInt)

const TPEPhoneNumber & RemotePhoneNumber ( const TInt aCallId ) const [pure virtual]

Gets remote end phone number

Parameters

const TInt aCallId

RemotePhoneNumberType(const TInt)

const TPEPhoneNumberIdType & RemotePhoneNumberType ( const TInt aCallId ) const [pure virtual]

Gets remote end phone number type

Parameters

const TInt aCallId

RemotePredefinedDtmfStrings(const TInt)

const CDesCArray & RemotePredefinedDtmfStrings ( const TInt aCallId ) const [pure virtual]

Gets remote predefined dtmf strings

Parameters

const TInt aCallId

RemoteTextToSpeechText(const TInt)

const TPtrC RemoteTextToSpeechText ( const TInt aCallId ) const [pure virtual]

Gets text to speech text for this contact. Used in text to speech ringing tone.

Parameters

const TInt aCallId

RingingTone(const TInt &)

const TPEContactFileName & RingingTone ( const TInt & aCallId ) const [pure virtual]

Gets ringing tone name

Parameters

const TInt & aCallId

RingingType()

const TProfileRingingType & RingingType ( ) const [pure virtual]

Gets ringing type

RingingVolume()

const TInt & RingingVolume ( ) const [pure virtual]

Gets current ringing volume

RouteParameters()

const TPEPhoneAudioRouteParameters & RouteParameters ( ) const [pure virtual]

Gets phone audio route parameters

SSCommandInfo()

const TPESSCommandInfo & SSCommandInfo ( ) const [pure virtual]

Gets the last suplementary services string command information

SecureSpecified()

TBool SecureSpecified ( ) const [pure virtual]

Gets secure specified status

ServiceId(const TInt)

TUint32 ServiceId ( const TInt aCallId ) const [pure virtual]

Gets ServiceId

Parameters

const TInt aCallId

ServiceIdCommand()

TUint32 ServiceIdCommand ( ) const [pure virtual]

Returns the service-id used for the command.

SetAudioMuteCommand(const TInt &)

void SetAudioMuteCommand ( const TInt & aAudioMute ) [pure virtual]

Sets audio mute command to TPEBasicInfo-structure

Parameters

const TInt & aAudioMute is audio mute

SetAudioOutputCommand(const TPEAudioOutput &, const TBool)

void SetAudioOutputCommand ( const TPEAudioOutput & aOutput,
const TBool aShowNote
) [pure virtual]

Sets audio output command to TPEBasicInfo-structure

Parameters

const TPEAudioOutput & aOutput is audio output path
const TBool aShowNote is audio note value

SetAudioVolumeCommand(const TInt &)

void SetAudioVolumeCommand ( const TInt & aAudioVolume ) [pure virtual]

Sets audio volume command to TPEBasicInfo-structure

Parameters

const TInt & aAudioVolume is audio volume

SetCallBackAddress(const TDesC &)

void SetCallBackAddress ( const TDesC & aAddress ) [pure virtual]

Sets unattended transfer call back address

Parameters

const TDesC & aAddress Unattended transfer call back address

SetCallId(const TInt &)

void SetCallId ( const TInt & aCallId ) [pure virtual]

Sets CallId value to TPECallCommandInfo-structure

Parameters

const TInt & aCallId is the call id number.

SetCallTypeCommand(const TPECallType &)

void SetCallTypeCommand ( const TPECallType & aCallType ) [pure virtual]

Sets call type information for following command message Used for specifying the call type of the next attempted call

Parameters

const TPECallType & aCallType is the call type of the next attempted call

SetDtmfStringCommand(const TPEDtmfString &)

void SetDtmfStringCommand ( const TPEDtmfString & aDtmfString ) [pure virtual]

Sets dtmf string value to TPEBasicInfo-structure

Parameters

const TPEDtmfString & aDtmfString is the dtmf string to be sent.

SetEmergencyNumber(const TPEPhoneNumber &)

void SetEmergencyNumber ( const TPEPhoneNumber & aEmergencyNumbers ) [pure virtual]

Sets emergency numbers of the phone to TPEBasicInfo-structure

Parameters

const TPEPhoneNumber & aEmergencyNumbers

SetForwardAddressChoices(const CDesC8Array *, TInt)

void SetForwardAddressChoices ( const CDesC8Array * aArray,
TInt aCallId
) [pure virtual]

Sets address choices from received call forward request.

Parameters

const CDesC8Array * aArray Address array.
TInt aCallId Call identification number.

SetForwardAddressIndex(TInt)

void SetForwardAddressIndex ( TInt aIndex ) [pure virtual]

Sets array index for user selected address.

Parameters

TInt aIndex Array index for selected address.

SetIsTransferDial(TBool)

void SetIsTransferDial ( TBool aTransferDial ) [pure virtual]

Sets flag indicating unattended transfer dial

Parameters

TBool aTransferDial ETrue if voip unattended transfer dial was initiated

SetKeyCode(const TChar &)

void SetKeyCode ( const TChar & aKeyCode ) [pure virtual]

Sets key code value to TPEBasicInfo-structure

Parameters

const TChar & aKeyCode is the key code value.

SetPhoneNumber(const TPEPhoneNumber &)

void SetPhoneNumber ( const TPEPhoneNumber & aPhoneNumber ) [pure virtual]

Sets phone number to TPECallCommandInfo-structure

Parameters

const TPEPhoneNumber & aPhoneNumber is the phone number

SetServiceIdCommand(TUint32)

void SetServiceIdCommand ( TUint32 aServiceId ) [pure virtual]

SetServiceIdCommand

Parameters

TUint32 aServiceId

SetTransferTargetCommand(const TPEPhoneNumber &)

void SetTransferTargetCommand ( const TPEPhoneNumber & aTransferTarget ) [pure virtual]

Sets transfer target address for unattended transfer

Parameters

const TPEPhoneNumber & aTransferTarget Target address for unattended transfer

SetUnattendedTransferTarget(const TPEPhoneNumber &, TInt)

void SetUnattendedTransferTarget ( const TPEPhoneNumber & aTarget,
TInt aCallId
) [pure virtual]

Sets transfer target from the last received unattended transfer request.

Parameters

const TPEPhoneNumber & aTarget Transfer target to set.
TInt aCallId Call identification number.

SimState()

const TPESimState & SimState ( ) const [pure virtual]

Gets Sim state

TextToSpeech()

const TBool & TextToSpeech ( ) const [pure virtual]

Gets text-to-speech preference setting value

TransferTargetCommand()

const TPEPhoneNumber & TransferTargetCommand ( ) const [pure virtual]

Returns transfer target address

TwoDigitSupportStatus()

const TBool & TwoDigitSupportStatus ( ) const [pure virtual]

Gets two digit support status value

UnattendedTransferTarget(TInt)

const TPEPhoneNumber & UnattendedTransferTarget ( TInt aCallId ) const [pure virtual]

Returns transfer target from the last received unattended transfer request or KNullDesC if transfer target is not available.

Parameters

TInt aCallId

VoiceMailBoxNumberLine1()

const TPEPhoneNumber & VoiceMailBoxNumberLine1 ( ) const [pure virtual]

Gets VoiceMailBoxNumber for Line 1 information from TPEBasicInfo-structure

VoiceMailBoxNumberLine2()

const TPEPhoneNumber & VoiceMailBoxNumberLine2 ( ) const [pure virtual]

Gets VoiceMailBoxNumber for Line 2 information from TPEBasicInfo-structure

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.