EPOC   SDK Home Glossary Indexes Previous Next Up

RCall class


Contents


RCall class — Call sub-session

Section Contents


Overview

Compatibility

Applications that use this class will not work correctly on a version of EPOC earlier than ER5.

Derivation

RTelSubSessionBase

Abstract: implements a subsession

Defined in

etel.h

Link against

etel.lib

Description

The call sub-session provides access to the functionality associated with a specific call.

Writing derived classes

This class is not intended for user derivation


Construction and destruction


RCall() — Empty default constructor

RCall();

Description

The constructor is empty, and is present only to support virtual function table export: see Implications of static DLLs.


Opening/Closing a Call


OpenNewCall() — Open a new call from a server (return call name)

TInt OpenNewCall(RTelServer& aServer,const TDesC& aName,TDes& aNewName);

Description

This function opens a new call from a server session.

Arguments

RTelServer& aServer

The server opening the call.

const TDesC& aName

The name of the line from which the call is to be opened. The format of the name must be as shown below:
Phone_Name::Line_Name::

TDes& aNewName

On return, contains the name of the new call.

Return value

TInt

An error code: see System error codes.

Note:

OpenNewCall() — Open a new call from a server (without returning call name)

TInt OpenNewCall(RTelServer& aServer,const TDesC& aName);

Description

This function opens a new call from a server, but does not return the new name to the client.

Arguments

RTelServer& aServer

The server opening the call.

const TDesC& aName

The name of the line from which the call is to be opened. The format of the name must be as shown below:
Phone_Name::Line_Name::

Return value

TInt

An error code: see System error codes.

Note:

OpenNewCall() — Open a new call from a phone (returning the call name)

TInt OpenNewCall(RPhone& aPhone,const TDesC& aName,TDes& aNewName);

Description

This function opens a new call from a phone.

Arguments

RPhone& aPhone

The phone opening the call.

const TDesC& aName

The name of the line to open the call from. The format of the name must be as shown below:
Line_Name::

The name of the line can be obtained using the RPhone::GetLineInfo() function.

TDes& aNewName

On return, contains the name of the new call.

Return value

TInt

An error code: see System error codes.

Note:

OpenNewCall() — Open a new call from a phone (without returning the call name)

TInt OpenNewCall(RPhone& aPhone,const TDesC& aName);

Description

This function opens a new call from a phone, but does not return the new name to the client.

Arguments

RPhone& aPhone

The phone opening the call.

const TDesC& aName

The name of the line to open the call from. The format of the name must be as shown below:
Line_Name::

The name of the line can be obtained using the RPhone::GetLineInfo() function.

Return value

TInt

An error code: see System error codes.

Note:

OpenNewCall() — Open a new call from a line (returning the call name)

TInt OpenNewCall(RLine& aLine,TDes& aNewName);

Description

This function opens a new call from a line.

Arguments

RLine& aLine

The line opening the call.

TDes& aNewName

On return, contains the name of the new call.

Return value

TInt

An error code: see System error codes.

Note:

OpenNewCall() — Open a new call from a line (without returning the call name)

TInt OpenNewCall(RLine& aLine);

Description

This function opens a new call from a line. The name of the new call is not returned.

Arguments

RLine& aLine

The line opening the call.

Return value

TInt

An error code: see System error codes.

Note:

OpenExistingCall() — Open an existing call from a server

TInt OpenExistingCall(RTelServer& aServer,const TDesC& aName);

Description

This function opens an existing call from a server.

Arguments

RTelServer& aServer

The server opening the call.

const TDesC& aName

The name of the call to open. Must be of the form:
Phone_Name::Line_Name::Call_Name

Return value

TInt

An error code: see System error codes.

Notes:

OpenExistingCall() — Open an existing call from a phone

TInt OpenExistingCall(RPhone& aPhone,const TDesC& aName);

Description

This function opens an existing call from a phone.

Arguments

RPhone& aPhone

The phone opening the call.

const TDesC& aName

The name of the call to open. Must be of the form:
Line_Name::Call_Name

Return value

TInt

An error code: see System error codes.

Notes:

OpenExistingCall() — Open an existing call from a line

TInt OpenExistingCall(RLine& aLine,const TDesC& aName);

Description

This function opens an existing call from a line.

Arguments

RLine& aLine

The line opening the call.

const TDesC& aName

The name of the call to open.

Return value

TInt

An error code: see System error codes.

Notes:

Close() — Close the call

void Close();

Description

This function closes the RCall subsession. This function must be called for all RCall subsessions which have been opened — to prevent memory leakage.


Query functions


GetStatus() — Get call status

TInt GetStatus(TStatus& aStatus) const;

Description

This function retrieves the current call status.

Arguments

TStatus& aStatus

On return, contains the current call status

Return value

TInt

An error code: see System error codes.


GetCaps() — Get call capabilities

TInt GetCaps(TCaps& aCaps) const;

Description

This function retrieves a snapshot of the current call capabilities.

Arguments

TCaps& aCaps

On return, contains the call capabilities

Return value

TInt

An error code: see System error codes.


GetBearerServiceInfo() — Get bearer service information

TInt GetBearerServiceInfo(TBearerService& aBearerService) const;

Description

This function retrieves the bearer service information associated with the call. Bearer service information is only available if the call is currently active.

Arguments

TBearerService& aBearerService

On return, contains the bearer service information.

Return value

TInt

An error code: see System error codes.

Notes:

GetInfo() — Get call information

TInt GetInfo(TCallNotifyInfo& aCallNotifyInfo) const;

Description

This function retrieves the current call information.

Arguments

TCallNotifyInfo& aCallNotifyInfo

On return, contains the current call information

Return value

TInt

An error code: see System error codes.


GetCallDuration() — Get call duration

TInt GetCallDuration(TTimeIntervalSeconds& aTime) const;

Description

This function retrieves the call duration.

Arguments

TTimeIntervalSeconds& aTime

On return, contains the call duration (in seconds)

Return value

TInt

An error code: see Error codes.

Note:

GetCallParams() — Get call parameters

TInt GetCallParams(TDes8& aParams) const;

Description

This function retrieves the current call parameters.

Arguments

TDes8& aParams

On return, contains the call parameters. The variable must be an instance of the TCallParamPckg class.

Return value

TInt

An error code: see System error codes.


Notification functions


NotifyCapsChange() — Notification of a change in call capabilities

void NotifyCapsChange(TRequestStatus& aStatus, TCaps& aCaps);

Description

This function provides notification of a change in the call capabilities.

Arguments

TRequestStatus& aStatus

A variable that indicates the completion status of the request.

TCaps& aCaps

On request completion, contains the call’s capability information


NotifyCapsChangeCancel() — Cancel notification of a change in call capabilities

void NotifyCapsChangeCancel() const;

Description

This function cancels a "call capabilities change" notification request, placed using the NotifyCapsChange() function.


NotifyOnAnything() — Notification of any call changes

void NotifyOnAnything(TRequestStatus& aStatus,TCallNotifyInfo& aCallNotifyInfo);

Description

This function provides notification of changes in the call information.

Arguments

TRequestStatus& aStatus

A flag that indicates the completion status of the request.

TCallNotifyInfo& aCallNotifyInfo

On return, contains the new call information.


NotifyOnAnythingCancel() — Cancel notification of any call changes

void NotifyOnAnythingCancel() const;

Description

This function cancels an "Any change" notification request, placed using the NotifyOnAnything() function.


NotifyHookChange() — Notification of a change in hook status

void NotifyHookChange(TRequestStatus& aStatus,THookStatus& aHookStatus);

Description

This function provides notification of a change in the hook status.

Arguments

TRequestStatus& aStatus

A variable that indicates the completion status of the request.

THookStatus& aHookStatus

On request completion, contains the new hook status


NotifyHookChangeCancel() — Cancel notification of a change in hook status

void NotifyHookChangeCancel() const;

Description

This function cancels an outstanding “hook status change” notification request, placed with the NotifyHookChange() function.


RegisterNotifyStatusChange() — Register interest in notification of hook status change

TInt RegisterNotifyStatusChange(const TInt aBufferSize) const;

Description

This function causes the server to create a buffer, specifically for the requesting client, to store a notification that the hook status has changed. This buffer ensures that information is not lost between the client’s request for notification completing, and its next request being posted.

Arguments

const TInt aBufferSize

The number of events that the server can buffer

Return value

TInt

An error code: see System error codes.


DeregisterNotifyStatusChange() — Cancel interest in notification of hook status change

TInt DeregisterNotifyStatusChange() const;

Description

This function deletes the buffer in the server. If a client has a status change notification still outstanding, it will remain so.

Return value

TInt

An error code: see System error codes.


NotifyStatusChange() — Notification of a change in call status

void NotifyStatusChange(TRequestStatus& aStatus,TStatus& aCallStatus);

Description

This function provides notification about a change in the status of a call.

Arguments

TRequestStatus& aStatus

A variable that indicates the completion status of the request.

TStatus& aCallStatus

On request completion, contains the new call status.


NotifyStatusChangeCancel() — Cancel notification of a change in call status

void NotifyStatusChangeCancel() const;

Description

This function cancels an outstanding “call status change” notification request, placed using the NotifyStatusChange() function.


NotifyCallDurationChange() — Notification of call duration change

void NotifyCallDurationChange(TRequestStatus& aStatus,TTimeIntervalSeconds& aTime);

Description

This function provides notification of an increase in call duration (by one second).

Arguments

TRequestStatus& aStatus

A variable that indicates the completion status of the request.

TTimeIntervalSeconds& aTime

On request completion, contains the current update of the call duration.


NotifyCallDurationChangeCancel() — Cancel notification of call duration change

void NotifyCallDurationChangeCancel() const;

Description

This function cancels an outstanding “call duration change” notification request, placed using the NotifyCallDurationChange() function.


Connection and disconnection functions


Dial() — Dial request (synchronous) — default TSY call parameters

TInt Dial(const TTelNumberC& aTelNumber) const;

Description

This function attempts to establish a connection using the telephone number specified.

Arguments

const TTelNumberC& aTelNumber

A telephone number.

Return value

TInt

An error code: see Error codes.

Notes:

Dial() — Dial Request (synchronous) — explicit call parameters

TInt Dial(const TDesC8& aCallParams,const TTelNumberC& aTelNumber) const;

Description

This function attempts to establish a connection using the telephone number specified.

Arguments

const TDesC8& aCallParams

The call parameters used by the TSY (a TCallParamsPckg object).

const TTelNumberC& aTelNumber

A telephone number.

Return value

TInt

An error code: see Error codes.

Notes:

Dial() — Dial Request (asynchronous) — default TSY call parameters

void Dial(TRequestStatus& aStatus,const TTelNumberC& aTelNumber);

Description

This function attempts to establish a connection using the telephone number specified.

Arguments

TRequestStatus& aStatus

A variable that indicates the completion status of the request.

const TTelNumberC& aTelNumber

A telephone number

Notes:

Dial() — Dial Request (asynchronous) — explicit call parameters

void Dial(TRequestStatus& aStatus,const TDesC8& aCallParams,const TTelNumberC& aTelNumber);

Description

This function attempts to establish a connection using the telephone number specified.

Arguments

TRequestStatus& aStatus

A variable that indicates the completion status of the request.

const TDesC8& aCallParams

The call parameters used by the TSY (a TCallParamsPckg object).

const TTelNumberC& aTelNumber

The telephone number

Notes:

DialCancel() — Cancel dial request

void DialCancel() const;

Description

This function cancels an outstanding dial request, placed with the asynchronous version of the Dial() function.


Connect() — Connect request (synchronous) — default call parameters

TInt Connect() const;

Description

This function attempts to connect to a remote modem without dialling. It is intended for use when other equipment has been used to dial the call.

Return value

TInt

An error code: see Error codes.

Notes:

Connect() — Connect request (synchronous) — explicit call parameters

TInt Connect(const TDesC8& aCallParams) const;

Description

This function attempts to connect to a remote modem without dialling. It is intended for use when other equipment has been used to dial the call.

Arguments

const TDesC8& aCallParams

The call parameters used by the TSY (a TCallParamsPckg object).

Return value

TInt

An error code: see Error codes.

Notes:

Connect() — Connect request (asynchronous) — default call parameters

void Connect(TRequestStatus& aStatus);

Description

This function attempts to connect to a remote modem without dialling. It is intended for use when other equipment has been used to dial the call.

Arguments

TRequestStatus& aStatus

A variable that indicates the completion status of the request.

Notes:

Connect() — Connect request (asynchronous) — explicit call parameters

void Connect(TRequestStatus& aStatus,const TDesC8& aCallParams);

Description

This function attempts to connect to a remote modem without dialling. It is intended for use when other equipment has been used to dial the call.

Arguments

TRequestStatus& aStatus

A variable that indicates the completion status of the request.

const TDesC8& aCallParams

The call parameters used by the TSY (a TCallParamsPckg object).

Notes:

ConnectCancel() — Cancel connection request

void ConnectCancel() const;

Description

This function allows a client to cancel a “connection” request, placed using the asynchronous versions of the Connect() function.


AnswerIncomingCall() — Answer incoming call request (synchronous) — default call parameters

TInt AnswerIncomingCall() const;

Description

This function waits for an incoming call and answers it when it arrives.

Return value

TInt

An error code: see Error codes.

Notes:

AnswerIncomingCall() — Answer incoming call request (synchronous) — explicit call parameters

TInt AnswerIncomingCall(const TDesC8& aCallParams) const;

Description

This function waits for an incoming call and answers it when it arrives. The function also answers calls which are ringing when it is invoked.

Arguments

const TDesC8& aCallParams

The call parameters used by the TSY (a TCallParamsPckg object).

Return value

TInt

An error code: see Error codes.

Note:

AnswerIncomingCall() — Answer incoming call request (asynchronous) — default call parameters

void AnswerIncomingCall(TRequestStatus& aStatus);

Description

This function waits for an incoming call and answers it when it arrives. The function also answers calls which are ringing when it is invoked.

Arguments

TRequestStatus& aStatus

A variable that indicates the completion status of the request.

Notes:

AnswerIncomingCall() — Answer incoming call request (asynchronous) — explicit call parameters

void AnswerIncomingCall(TRequestStatus& aStatus,const TDesC8& aCallParams);

Description

This function waits for an incoming call and answers it when it arrives. The function also answers calls which are ringing when it is invoked.

Arguments

TRequestStatus& aStatus

A variable that indicates the completion status of the request.

const TDesC8& aCallParams

The call parameters used by the TSY (a TCallParamsPckg object).


AnswerIncomingCallCancel() — Cancel answer call request

void AnswerIncomingCallCancel() const;

Description

This function allows a client to cancel an outstanding call answer request, that was placed using the asynchronous versions of the AnswerIncomingCall() function. If a call has not arrived the TSY notes that it should not answer when one arrives; if the call is answering, then an attempt is made to abort.


HangUp() — Hang up an active call (synchronous)

TInt HangUp() const;

Description

This function terminates an active call established with the Dial(), Connect() or AnswerIncomingCall() functions.

Return value

TInt

An error code: see Error codes.

Note:

HangUp() — Hang up an active call (asynchronous)

void HangUp(TRequestStatus& aStatus) const;

Description

This function terminates an active call established with the Dial(), Connect() or AnswerIncomingCall() functions.

Arguments

TRequestStatus& aStatus

An error code: see Error codes.


HangUpCancel() — Cancel asynchronous HangUp request

void HangUpCancel() const;

Description

This function cancels an outstanding HangUp request, placed using the asynchronous version of the HangUp() function. It should be noted that if the call termination sequence has begun there is little hope of retaining the call even if this function is used.


Call data access functions


LoanDataPort() — Loan data port (synchronous)

TInt LoanDataPort(TCommPort& aDataPort) const;

Description

This function allows a client to gain control of the serial communications abstraction used to communicate with a modem.

Arguments

TCommPort& aDataPort

On return, contains the information required to open the communications port.

Return value

TInt

An error code: see Error codes.

Notes:

LoanDataPort() — Loan data port (asynchronous)

void LoanDataPort(TRequestStatus& aStatus,TCommPort& aDataPort);

Description

This function allows a client to gain control of the serial communications abstraction used to communicate with the modem.

Arguments

TRequestStatus& aStatus

A variable that indicates the completion status of the request.

TCommPort& aDataPort

On request completion, contains the information required to open the communications port.

Notes:

LoanDataPortCancel() — Cancel loan of data port

void LoanDataPortCancel() const;

Description

This function allows a client to cancel an outstanding loan communications port request, placed using the asynchronous version of the LoanDataPort() function.


RecoverDataPort() — Recover a loaned data port

TInt RecoverDataPort() const;

Description

This function should be used by the client to indicate that it has finished using the serial communication channel  — so the ETel server can retake control.

Return value

TInt

An error code: see Error codes.

Notes:

Call ownership manipulation functions


AcquireOwnership() — Acquire call ownership

void AcquireOwnership(TRequestStatus& aStatus) const;

Description

This function is used to gain ownership from another client. This function completes when the current call owner calls the TransferOwnership() function, or if it closes its handle without hanging up. When (and if) the request completes, call ownership has transferred to the new client.

Arguments

TRequestStatus& aStatus

A variable that indicates the completion status of the request.

Notes:

AcquireOwnershipCancel() — Cancel request to acquire call ownership

void AcquireOwnershipCancel() const;

Description

This function cancels an outstanding request to gain call ownership, placed with the AcquireOwnership() function.


TransferOwnership() — Transfer call ownership

TInt TransferOwnership() const;

Description

This function allows clients with call ownership to transfer ownership to another interested client.

Return value

TInt

An error code: see Error codes.

Notes:

GetOwnershipStatus() — Get call ownership status

TInt GetOwnershipStatus(TOwnershipStatus& aOwnershipStatus) const;

Description

This function retrieves ownership information associated with the call.

Arguments

TOwnershipStatus& aOwnershipStatus

On return, contains the call ownership status information

Return value

TInt

An error code: see System error codes.


Fax settings


GetFaxSettings() — Get fax settings

TInt GetFaxSettings(TFaxSessionSettings& aSettings) const;

Description

This function retrieves the current fax settings.

Arguments

TFaxSessionSettings& aSettings

On return, contains the fax settings

Return value

TInt

An error code: see System error codes.


SetFaxSettings() — Set fax settings

TInt SetFaxSettings(const TFaxSessionSettings& aSettings) const;

Description

This function assigns the fax settings.

Arguments

const TFaxSessionSettings& aSettings

The new fax settings

Return value

TInt

An error code: see System error codes.


Enumerations


TBearerCaps enum — Bearer capability flags

KBearerCapsCompressionV42bis

V42bis modem compression protocol.

KBearerCapsCompressionMNP5

MNP5 modem compression protocol.

KBearerCapsCompressionNone

No compression supported.

KBearerCapsProtocolLAPM

LAPM error correction protocol.

KBearerCapsProtocolALT_CELLULAR

MNP10 mode.

KBearerCapsProtocolALT

MNP error correction.

KBearerCapsProtocolNone

No protocol information provided.

KBearerCapsCompressionUnknown

Compression protocol unknown.

KBearerCapsProtocolUnknown

Unable to establish protocol.


TCallBearerSpeed enum — Bearer speed flags

EBearerData57600

Transfer rate of 57600 bps.

EBearerData33600

Transfer rate of 33600 bps.

EBearerData31200

Transfer rate of 31200 bps.

EBearerData19200

Transfer rate of 9200 bps.

EBearerData14400

Transfer rate of 4400 bps.

EBearerData12000

Transfer rate of 12000 bps.

EBearerData9600

Transfer rate of 9600 bps.

EBearerData7200

Transfer rate of 7200 bps.

EBearerData4800

Transfer rate of 4800 bps.

EBearerData2400

Transfer rate of 2400 bps.

EBearerData1200

Transfer rate of 200 bps.

EBearerData75_1200

V.23 75 bps forward, 1200 bps back

EBearerData1200_75

V.23 1200 bps forward, 75 bps back

EBearerData300

Transfer rate of 300 bps.

EBearerDataUnknown

Transfer rate is unknown.


TCapsEnum enum — Call capability flags

KCapsData

The call supports data calls.

KCapsFax

The call supports fax calls.

KCapsVoice

The call supports voice calls.

KCapsDial

The Dial request is currently a valid action.

KCapsConnect

The Connect request is currently a valid action.

KCapsHangUp

The Hang Up request is currently a valid action.

KCapsAnswer

The Answer request is currently a valid action.

KCapsLoanDataPort

The Loan Data Port request is currently a valid action.

KCapsRecoverDataPort

The Recover Data Port request is currently a valid action.


TConstants enum — Fax identifier size flags

KFaxIdUserNameMaxSize

20


TFaxMode enum — Fax mode flags

ETransmit

Fax is transmitting

EReceive

Fax is receiving.


TFaxRetrieveType enum — Fax retrieval type flags

EFaxOnDemand

Retrieving a fax opened from voice call (not currently supported by GSM networks).

EFaxPoll

Retrieve a fax opened from fax call.


THookStatus enum — Hook status flags

EHookStatusOff

The line is currently off hook.

EHookStatusOn

The line is currently on hook.

EHookStatusUnknown

The status of the line’s hook is currently unknown


TMonitorSpeakerControl enum — Monitor speaker control setting flags

EMonitorSpeakerControlAlwaysOff

Speaker control is always off

EMonitorSpeakerControlOnUntilCarrier

Speaker control is on until the carrier is detected

EMonitorSpeakerControlAlwaysOn

Speaker control is always active.

EMonitorSpeakerControlOnExceptDuringDialling

Speaker control is on, except while dialling

EMonitorSpeakerControlUnknown

Speaker control is unknown.


TMonitorSpeakerVolume enum — Monitor speaker volume control setting flags

EMonitorSpeakerVolumeOff

Speaker volume is off.

EMonitorSpeakerVolumeLow

Speaker volume is low.

EMonitorSpeakerVolumeMedium

Speaker volume is medium.

EMonitorSpeakerVolumeHigh

Speaker volume is high.

EMonitorSpeakerVolumeUnknown

Speaker volume is unknown.


TOwnershipStatus enum — Call ownership status flags

EOwnershipUnowned

The call is not owned.

EOwnershipOwnedByAnotherClient

The call is owned, but not by this RCall instance.

EOwnershipOwnedByThisClient

The call is owned by this RCall instance.

EOwnershipThisIsPriorityClient

The call is owned, but not by the priority client


TStatus enum — Call status flags

EStatusUnknown

The call status is not known.

EStatusIdle

The call is idle.

EStatusDialling

The call is dialling.

EStatusRinging

The call is ringing (an incoming, unanswered call).

EStatusAnswering

The call is being answered.

EStatusConnecting

The call is connecting (immediate call establishment, without dialling).

EStatusConnected

The call is connected and active.

EStatusHangingUp

The call is being terminated.


TWaitForDialTone enum — Wait for dial tone flags

EDialToneWait

Waiting for dial tone.

EDialToneNoWait

Not waiting for dial tone.


Struct


TBearerService struct — Call bearer information

TUint32 iBearerCaps

The bearer capabilities.

TCallBearerSpeed iBearerSpeed

The bearer’s speed.


TCaps struct — Call capability information

TUint iFlags

Call capability flag. Contains a bitmask of values defined in the TCapsEnum enumeration.


TCommPort struct — Communications port information

TFileName iCsy

The CSY module used by the C32 Communications Server to talk to the serial device.

TName iPort

The port used by the C32 Communications Server to talk to the serial device.


TFaxSessionSettings struct — Fax session settings information

TFaxMode iMode

The fax mode.

TFaxRetrieveType iFaxRetrieveType

The mode of retrieving faxes.

TFaxClass iFaxClass

The class of fax

TBuf8<KFaxIdUserNameMaxSize> iFaxId

The fax identifier string displayed at the top of the fax.

TInt iMaxSpeed

The maximum transfer speed that can be negotiated.

TInt iMinSpeed

The minimum transfer speed that should be negotiated.

TInt iPreferredECM

The preferred compression mode used for negotiation. This may take one of the following values: EModifiedHuffman, EModifiedRead, EUncompressedModifiedRead, EModifiedModifiedRead.

TInt iFaxOnDemandDelay

The delay used for Fax on Demand services. Measured in seconds.

TFaxResolution iTxResolution

The preferred transmit resolution. This may take one of the following values: EFaxNormal EFaxFine

TFaxCompression iTxCompression

Compression mode for transmitting faxes.

TInt iTxPages

The number of pages to be transmitted.

TFaxResolution iRxResolution

The preferred receive resolution. This may take one of the following values: EFaxNormal EFaxFine.

TFaxCompression iRxCompression

Compression mode for receiving faxes.


Typedef


TTelNumberC typedef — Telephone number

typedef TDesC8 TTelNumberC;

Defined in

etel.h

Description

Objects of this type are used to pass telephone numbers into Dial functions.


TCallParamsPckg typedef — Call parameters package

typedef TPckg<TCallParams> TCallParamsPckg;

Defined in

etel.h

Description

The call parameters to be associated with a call may be passed into functions using this type.


RCall::TCallNotifyInfo class — Core API call class information

Section Contents


Overview

Compatibility

Applications that use this class will not work correctly on a version of EPOC earlier than ER5.

Derivation

RCall::TCallNotifyInfo

The class defines the call information.

Defined in

etel.h

Link against

etel.lib

Description

All the information associated with an instance of the core API call class is collected together into a single, directly accessible, structure to increase the efficiency of those applications that require access to the majority of the call’s data.

Writing derived classes

This class is not intended for user derivation


Construction and destruction


TCallNotifyInfo() — Empty constructor

RCall::TCallNotifyInfo();

Description

The constructor is empty.


Data members

TName iCallName

The name of the call.

TBool iCallNameChanged

An indication that the name of the call has changed.

TName iLineName

The name of the call’s line.

TBool iLineNameChanged

An indication that the line information has changed since the last notification.

THookStatus iHookStatus

The hook status.

TBool iHookStatusChanged

An indication that the hook status information has changed since the last notification.

TStatus iStatus

The current call status.

TBool iStatusChanged

An indication that the call status has changed since the last notification.

TTimeIntervalSeconds iDuration

The current call duration.

TBool iDurationChanged

An indication that the call duration has changed since the last notification.


RCall::TCallParams class — Call parameter information

Section Contents


Overview

Compatibility

Applications that use this class will not work correctly on a version of EPOC earlier than ER5.

Derivation

RCall::TCallParams

The class defines the call parameter information.

Defined in

etel.h

Link against

etel.lib

Description

The class defines the call parameter information.

Writing derived classes

This class is not intended for user derivation


Construction and destruction


TCallParams() — Trivial default constructor

RCall::TCallParams();

Description

The default constructor creates a properly initialised TCallParams object. The member variables are initialised as shown in the following table.

iSpeakerControl

EMonitorSpeakerControlOnUntilCarrier

iSpeakerVolume

EMonitorSpeakerVolumeLow

iInterval

4

iWaitForDialTone

EDialToneWait

iIsDefault

ETrue


TCallParams() — constructor with user initialised member variables

TCallParams(TMonitorSpeakerControl aSpeakerControl, TMonitorSpeakerVolume aSpeakerVolume, TUint aInterval, TWaitForDialTone aWaitForDialTone);

Description

The C++ constructor is used to allow developers to initialise member variables when the object is constructed.

Arguments

TMonitorSpeakerControl aSpeakerControl

Specifies speaker control mode.

TMonitorSpeakerVolume aSpeakerVolume

Specifies the speaker volume setting

TUint aInterval

Specifies the pause interval used when a comma is inserted into the dial string

TWaitForDialTone aWaitForDialTone

Specifies whether the modem is asked to wait for a dial tone before issuing the dial tones or pulses.


Functions


IsDefault() — Query if default

TBool IsDefault();

Description

Determines if the object was created using the default values.

Return value

TBool

True, if the object was created using the default values.


Data members

TMonitorSpeakerControl iSpeakerControl

The monitor speaker control setting.

TMonitorSpeakerVolume iSpeakerVolume

The monitor speaker volume control setting.

TUint iInterval

The length of a pause created during dialling by the comma character (‘,’) measured in seconds

TWaitForDialTone iWaitForDialTone

Whether, when dialling a call, the modem should wait for a dial tone.

EPOC       SDK Home Glossary Indexes Previous Next Up