Class RCall

RCall

Support

Supported from 5.0

Description

Call sub-session.

Provides access to the functionality associated with a specific call.

This class is not intended for user derivation

Derivation

RCall Call sub-session RTelSubSessionBase A base class used in the derivation of RCall, RLine, and RPhone

Defined in RCall:
AcquireOwnership(), AcquireOwnershipCancel(), AnswerIncomingCall(), AnswerIncomingCall(), AnswerIncomingCall(), AnswerIncomingCall(), AnswerIncomingCallCancel(), Close(), Connect(), Connect(), Connect(), Connect(), ConnectCancel(), DeregisterNotifyStatusChange(), Dial(), Dial(), Dial(), Dial(), DialCancel(), EBearerData1200, EBearerData12000, EBearerData1200_75, EBearerData14400, EBearerData19200, EBearerData2400, EBearerData300, EBearerData31200, EBearerData33600, EBearerData4800, EBearerData57600, EBearerData7200, EBearerData75_1200, EBearerData9600, EBearerDataUnknown, EDialToneNoWait, EDialToneWait, EFaxOnDemand, EFaxPoll, EHookStatusOff, EHookStatusOn, EHookStatusUnknown, EMonitorSpeakerControlAlwaysOff, EMonitorSpeakerControlAlwaysOn, EMonitorSpeakerControlOnExceptDuringDialling, EMonitorSpeakerControlOnUntilCarrier, EMonitorSpeakerControlUnknown, EMonitorSpeakerVolumeHigh, EMonitorSpeakerVolumeLow, EMonitorSpeakerVolumeMedium, EMonitorSpeakerVolumeOff, EMonitorSpeakerVolumeUnknown, EOwnershipOwnedByAnotherClient, EOwnershipOwnedByThisClient, EOwnershipThisIsPriorityClient, EOwnershipUnowned, EReceive, EStatusAnswering, EStatusConnected, EStatusConnecting, EStatusDialling, EStatusHangingUp, EStatusIdle, EStatusRinging, EStatusUnknown, ETransmit, GetBearerServiceInfo(), GetCallDuration(), GetCallParams(), GetCaps(), GetFaxSettings(), GetInfo(), GetInfo(), GetOwnershipStatus(), GetStatus(), HangUp(), HangUp(), HangUpCancel(), KBearerCapsCompressionMNP5, KBearerCapsCompressionNone, KBearerCapsCompressionUnknown, KBearerCapsCompressionV42bis, KBearerCapsProtocolALT, KBearerCapsProtocolALT_CELLULAR, KBearerCapsProtocolLAPM, KBearerCapsProtocolNone, KBearerCapsProtocolUnknown, KCapsAnswer, KCapsConnect, KCapsData, KCapsDial, KCapsFax, KCapsHangUp, KCapsLoanDataPort, KCapsRecoverDataPort, KCapsVoice, KFaxIdUserNameMaxSize, LoanDataPort(), LoanDataPort(), LoanDataPortCancel(), NotifyCallDurationChange(), NotifyCallDurationChangeCancel(), NotifyCapsChange(), NotifyCapsChangeCancel(), NotifyHookChange(), NotifyHookChangeCancel(), NotifyOnAnything(), NotifyOnAnythingCancel(), NotifyStatusChange(), NotifyStatusChangeCancel(), OpenExistingCall(), OpenExistingCall(), OpenExistingCall(), OpenNewCall(), OpenNewCall(), OpenNewCall(), OpenNewCall(), OpenNewCall(), OpenNewCall(), RCall(), RecoverDataPort(), RegisterNotifyStatusChange(), SetFaxSettings(), TBearerCaps, TBearerService, TCallBearerSpeed, TCallInfo, TCallNotifyInfo, TCallParams, TCallParamsPckg, TCaps, TCapsEnum, TCommPort, TConstants, TFaxMode, TFaxRetrieveType, TFaxSessionSettings, THookStatus, TMonitorSpeakerControl, TMonitorSpeakerVolume, TOwnershipStatus, TStatus, TTelNumberC, TTelNumberC, TWaitForDialTone, TransferOwnership()

RCall();

Description

Creates the default empty constructor, and is present only to support virtual function table export.

Notes:

• A call is identified by TDesC Phone_Name::Line_Name::Call_Name. Whenever the string Phone_Name::Line_Name::Call_Nam appears in this document it refers to this descriptor, and not a subclass.

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

Description

Opens a new call from a server session and returns the call name.

Parameters

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 Phone_Name::Line_Name::. TDes& aNewName On return, contains the name of the new call.

Return value

TInt KErrNone if successful, otherwise another of the system-wide error codes.

Notes:

• Opened call subsessions must be explicitly closed by the client — a memory leak will result if the RCall object is destroyed before the subsession is closed.
• Getting the server to name the call is the normal use of this function, as the client shouldn't normally need to bother naming the calls itself. However it is also possible for aName to explicitly specify the call name e.g. Phone_Name::Line_Name::Call_Name. If the specified call exists, then the function acts like OpenExistingCall() and returns its handle. If the call name does not exist then the TSY creates a call with that name. In either case, the aNewName variable is empty on return.

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

Description

Opens a new call from a server, but does not return the new name to the client.

Parameters

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: Phone_Name::Line_Name::

Return value

TInt KErrNone if successful, otherwise another of the system-wide error codes.

Notes:

• Opened call subsessions must be explicitly closed by the client — a memory leak will result if the RCall object is destroyed before the subsession is closed.
• Getting the server to name the call is the normal use of this function, as the client shouldn't normally need to bother naming the calls itself. However it is also possible for aName to explicitly specify the call name e.g.: Phone_Name::Line_Name::Call_Name. If the specified call exists, then the function acts like OpenExistingCall() and returns its handle. If the call name does not exist then the TSY creates a call with that name.

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

Description

Opens a new call from a phone and returns the name top the client.

Parameters

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: 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 KErrNone if successful, otherwise another of the system-wide error codes.

Notes:

• Opened call subsessions must be explicitly closed by the client — a memory leak will result if the RCall object is destroyed before the subsession is closed.

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

Description

Opens a new call from a phone, but does not return the new name to the client.

Parameters

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: Line_Name::. The name of the line can be obtained using the RPhone::GetLineInfo() function.

Return value

TInt KErrNone if successful, otherwise another of the system-wide error codes.

Notes:

• Opened call subsessions must be explicitly closed by the client — a memory leak will result if the RCall object is destroyed before the subsession is closed.

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

Description

Opens a new call from a line and returns the name to the client.

Parameters

RLine& aLine The line opening the call. TDes& aNewName On return, contains the name of the new call.

Return value

TInt KErrNone if successful, otherwise another of the system-wide error codes.

Notes:

• Opened call subsessions must be explicitly closed by the client — a memory leak will result if the RCall object is destroyed before the subsession is closed.

TInt OpenNewCall(RLine& aLine);

Description

Opens a new call from a line. The name of the new call is not returned.

Parameters

RLine& aLine The line opening the call.

Return value

TInt KErrNone if successful, otherwise another of the system-wide error codes.

Notes:

• Opened call subsessions must be explicitly closed by the client — a memory leak will result if the RCall object is destroyed before the subsession is closed.

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

Description

Opens an existing call from a server.

Parameters

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 KErrNone if successful, KErrNotFound if the call name does not exist, otherwise another of the system-wide error codes.

Notes:

• Opened call subsessions must be explicitly closed by the client — a memory leak will result if the RCall object is destroyed before the subsession is closed.

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

Description

Opens an existing call from a phone.

Parameters

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 KErrNone if successful, KErrNotFound if the call name does not exist, otherwise another of the system-wide error codes.

Notes:

• Opened call subsessions must be explicitly closed by the client — a memory leak will result if the RCall object is destroyed before the subsession is closed.

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

Description

Opens an existing call from a line.

Parameters

RLine& aLine The line opening the call. const TDesC& aName The name of the call to open.

Return value

TInt KErrNone if successful, KErrNotFound if the call name does not exist, otherwise another of the system-wide error codes.

Notes:

• Opened call subsessions must be explicitly closed by the client — a memory leak will result if the RCall object is destroyed before the subsession is closed.

void Close();

Description

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

TInt GetStatus(TStatus& aStatus) const;

Description

Gets the current call status.

Parameters

TStatus& aStatus On return, contains the current call status

Return value

TInt KErrNone if successful, otherwise another of the system-wide error codes.

TInt GetCaps(TCaps& aCaps) const;

Description

Gets a snapshot of the current call capabilities.

Parameters

TCaps& aCaps On return, contains the call capabilities

Return value

TInt KErrNone if successful, otherwise another of the system-wide error codes.

TInt GetBearerServiceInfo(TBearerService& aBearerService) const;

Description

Gets the bearer service information associated with the call. Bearer service information is only available if the call is currently active.

Parameters

TBearerService& aBearerService On return, contains the bearer service information.

Return value

TInt KErrNone if successful, KErrNotFound if the call name does not exist, otherwise another of the system-wide error codes.

TInt GetInfo(TCallNotifyInfo& aCallNotifyInfo) const;

Support

Supported from 5.0
Withdrawn in 5.1

Description

Gets the current call information.

Parameters

TCallNotifyInfo& aCallNotifyInfo On return, contains the current call information

Return value

TInt KErrNone if successful, otherwise another of the system-wide error codes.

TInt GetInfo(TCallInfo& aCallInfo) const;

Support

Supported from 5.1

Description

Gets the current call information.

Parameters

TCallInfo& aCallInfo On return, contains the current call information

Return value

TInt KErrNone if successful, otherwise another of the system-wide error codes.

TInt GetCallDuration(TTimeIntervalSeconds& aTime) const;

Description

Gets the call duration.

Parameters

TTimeIntervalSeconds& aTime On return, contains the call duration (in seconds)

Return value

TInt KErrNone if successful, otherwise another of the system-wide error codes.KErrEtelCallNotActive is returned if there is no active call.

TInt GetCallParams(TDes8& aParams) const;

Description

Gets the current call parameters.

Parameters

TDes8& aParams On return, contains the call parameters. The variable must be an instance of the TCallParamsPckg class.

Return value

TInt KErrNone if successful, otherwise another of the system-wide error codes.

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

Description

Provides notification of a change in the call capabilities.

Parameters

TRequestStatus& aStatus A variable that indicates the completion status of the request. TCaps& aCaps On request completion, contains the call's capability information

void NotifyCapsChangeCancel() const;

Description

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

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

Support

Supported from 5.0
Withdrawn in 5.1

Description

Provides notification of changes in the call information.

Parameters

TRequestStatus& aStatus A flag that indicates the completion status of the request. TCallNotifyInfo& aCallNotifyInfo On return, contains the new call information.

void NotifyOnAnythingCancel() const;

Support

Supported from 5.0
Withdrawn in 5.1

Description

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

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

Description

Provides notification of a change in the hook status.

Parameters

TRequestStatus& aStatus A variable that indicates the completion status of the request. THookStatus& aHookStatus On request completion, contains the new hook status

void NotifyHookChangeCancel() const;

Description

Cancels an outstanding 'hook status change' notification request, placed with the NotifyHookChange() function.

TInt RegisterNotifyStatusChange(const TInt aBufferSize) const;

Support

Supported from 5.0
Withdrawn in 5.1

Description

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.

Parameters

const TInt aBufferSize The number of events that the server can buffer

Return value

TInt KErrNone if successful, otherwise another of the system-wide error codes.

TInt DeregisterNotifyStatusChange() const;

Support

Supported from 5.0
Withdrawn in 5.1

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 KErrNone if successful, otherwise another of the system-wide error codes.

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

Description

Provides notification about a change in the status of a call.

Parameters

TRequestStatus& aStatus A variable that indicates the completion status of the request. TStatus& aCallStatus On request completion, contains the new call status.

void NotifyStatusChangeCancel() const;

Description

Cancels an outstanding 'call status change' notification request, placed using the NotifyStatusChange() function.

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

Description

Provides notification of an increase in call duration (by one second).

Parameters

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.

void NotifyCallDurationChangeCancel() const;

Description

Cancels an outstanding 'call duration change' notification request, placed using the NotifyCallDurationChange() function.

TInt Dial(const TTelNumberC& aTelNumber) const;

Description

Attempts to establish a connection using the telephone number specified.

Parameters

const TTelNumberC& aTelNumber A telephone number.

Return value

TInt KErrNone if successful, otherwise another of the system-wide error codes or an ETel Core error code.

Notes:

• The mode of the connection, i.e. whether it is a data or fax connection, is determined by whether the RCall object has been opened from a data line or a fax line.
• The default call parameters are used.

See also:

• Error codes

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

Description

Attempts to establish a connection using the telephone number specified.

Parameters

const TDesC8& aCallParams The call parameters used by the TSY (a TCallParamsPckg object). const TTelNumberC& aTelNumber A telephone number.

Return value

TInt KErrNone if successful, otherwise another of the system-wide error codes or an ETel Core error code.

Notes:

• The mode of the connection, i.e. whether it is a data or fax connection, is determined by whether the RCall object has been opened from a data line or a fax line.

See also:

• Error codes

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

Description

Attempts to establish a connection using the telephone number specified.

Parameters

TRequestStatus& aStatus A variable that indicates the completion status of the request. const TTelNumberC& aTelNumber A telephone number

Notes:

• The mode of the connection, i.e. whether it is a data or fax connection, is determined by whether the RCall object has been opened from a data line or a fax line.
• The default call parameters are used.

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

Description

Attempts to establish a connection using the telephone number specified.

Parameters

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:

• The mode of the connection, i.e. whether it is a data or fax connection, is determined by whether the RCall object has been opened from a data line or a fax line.

void DialCancel() const;

Description

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

TInt Connect() const;

Description

Attempts to connect to a remote modem without dialling — synchronous. It is intended for use when other equipment has been used to dial the call.

Return value

TInt KErrNone if successful, otherwise another of the system-wide error codes or an ETel Core error code.

Notes:

• The mode of the connection, i.e. whether it is a data or fax connection, is determined by whether the RCall object has been opened from a data line or a fax line.
• The default call parameters are used.

See also:

• Error codes

TInt Connect(const TDesC8& aCallParams) const;

Description

Attempts to connect to a remote modem without dialling — synchronous. It is intended for use when other equipment has been used to dial the call.

Parameters

const TDesC8& aCallParams The call parameters used by the TSY (a TCallParamsPckg object).

Return value

TInt KErrNone if successful, otherwise another of the system-wide error codes or an ETel Core error code.

Notes:

• The mode of the connection, i.e. whether it is a data or fax connection, is determined by whether the RCall object has been opened from a data line or a fax line.

See also:

• Error codes

void Connect(TRequestStatus& aStatus);

Description

Attempts to connect to a remote modem without dialling — asynchronous. It is intended for use when other equipment has been used to dial the call.

Parameters

TRequestStatus& aStatus A variable that indicates the completion status of the request.

Notes:

• The mode of the connection, i.e. whether it is a data or fax connection, is determined by whether the RCall object has been opened from a data line or a fax line.
• The default call parameters are used.

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

Description

Attempts to connect to a remote modem without dialling — asynchronous. It is intended for use when other equipment has been used to dial the call.

Parameters

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:

• The mode of the connection, i.e. whether it is a data or fax connection, is determined by whether the RCall object has been opened from a data line or a fax line.

void ConnectCancel() const;

Description

Allows a client to cancel a 'connection' request, placed using the asynchronous versions of the Connect() function.

TInt AnswerIncomingCall() const;

Description

Waits for an incoming call and answers it when it arrives — synchronous.

Return value

TInt KErrNone if successful, otherwise another of the system-wide error codes or an ETel Core error code.

Notes:

• The default call parameters are used.
• Answering can take some time. Use of the asynchronous variant of this function is recommended.

See also:

• Error codes

TInt AnswerIncomingCall(const TDesC8& aCallParams) const;

Description

Waits for an incoming call and answers it when it arrives — synchronous. The function also answers calls which are ringing when it is invoked.

Parameters

const TDesC8& aCallParams The call parameters used by the TSY (a TCallParamsPckg object).

Return value

TInt KErrNone if successful, otherwise another of the system-wide error codes or an ETel Core error code.

Notes:

• Answering can take some time. Use of the asynchronous variant of this function is recommended.

See also:

• Error codes

void AnswerIncomingCall(TRequestStatus& aStatus);

Description

Waits for an incoming call and answers it when it arrives — asynchronous. The function also answers calls which are ringing when it is invoked.

Parameters

TRequestStatus& aStatus A variable that indicates the completion status of the request.

Notes:

• The default call parameters are used.

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

Description

Waits for an incoming call and answers it when it arrives — asynchronous. The function also answers calls which are ringing when it is invoked.

Parameters

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

void AnswerIncomingCallCancel() const;

Description

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.

TInt HangUp() const;

Description

Terminates an active call established with the Dial(), Connect() or AnswerIncomingCall() functions — synchronous.

Return value

TInt KErrNone if successful, otherwise another of the system-wide error codes or an ETel Core error code.

Notes:

• Hanging up can take some time. Use of the asynchronous variant of this function is recommended.

See also:

• Error codes

void HangUp(TRequestStatus& aStatus) const;

Description

Terminates an active call established with the Dial(), Connect() or AnswerIncomingCall() functions — asynchronous.

Parameters

TRequestStatus& aStatus KErrNone if successful, otherwise another of the system-wide error codes or an ETel Core error code.

See also:

• Error codes

void HangUpCancel() const;

Description

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.

TInt LoanDataPort(TCommPort& aDataPort) const;

Description

Allows a client to gain control of the serial communications abstraction used to communicate with a modem.

Parameters

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

Return value

TInt KErrNone if successful, otherwise another of the system-wide error codes or an ETel Core error code.KErrEtelCallNotActive is returned if the function is called before a connection has been established to a remote modem.KErrEtelNotCallOwner is returned by the server if this client does not own the active call (The default owner of a call is the client who initiated or answered the call in the first place — ownership may change however if another client requests it and the owner transfers it or closes unexpectedly).

Notes:

• Once this function has successfully completed, the ETel server queues any commands it has to the modem, leaving the channel free for client data. The server retakes control of the communications port when the RecoverDataPort() function is called. After recovery, queued commands are executed.

See also:

• Error codes

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

Description

Allows a client to gain control of the serial communications abstraction used to communicate with the modem.

Parameters

TRequestStatus& aStatus A variable that indicates the completion status of the request.KErrEtelCallNotActive is returned if the function is called before a connection has been established to a remote modem.KErrEtelNotCallOwner is returned by the server if this client does not own the active call (The default owner of a call is the client who initiated or answered the call in the first place — ownership may change however if another client requests it and the owner transfers it or closes unexpectedly). TCommPort& aDataPort On request completion, contains the information required to open the communications port.

Notes:

• Once this function has successfully completed, the ETel server queues any commands it has to the modem, leaving the channel free for client data. The server retakes control of the communications port when the RecoverDataPort() function is called.

void LoanDataPortCancel() const;

Description

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

TInt RecoverDataPort() const;

Description

Indicates that the client has finished using the serial communication channel — so the ETel server can retake control.

Return value

TInt KErrNone if successful, otherwise another of the system-wide error codes or an ETel Core error code. KErrEtelPortNotLoanedToClient is returned if the communications port is not on loan. KErrEtelNotCallOwner is returned if communications port is loaned, but not by the current call.

void AcquireOwnership(TRequestStatus& aStatus) const;

Description

Aquires 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.

Parameters

TRequestStatus& aStatus A variable that indicates the completion status of the request.

Notes:

• Only the client with ownership may terminate the call or gain control of the underlying communications channel. All other clients may just monitor the call and view its state.

void AcquireOwnershipCancel() const;

Description

Cancels an outstanding request to acquire call ownership, placed with the AcquireOwnership() function.

TInt TransferOwnership() const;

Description

Allows clients with call ownership to transfer ownership to another interested client.

Return value

TInt KErrNone if successful, otherwise another of the system-wide error codes or an ETel Core error code. KErrEtelNoClientInterestedInThisCall is returned if no clients are interested in the ownership, i.e. none have a pending AcquireOwnership() request. Ownership remains with the client. KErrEtelNotCallOwner is returned if the client does not have call ownership.

TInt GetOwnershipStatus(TOwnershipStatus& aOwnershipStatus) const;

Description

Gets ownership information associated with the call.

Parameters

TOwnershipStatus& aOwnershipStatus On return, contains the call ownership status information

Return value

TInt KErrNone if successful, otherwise another of the system-wide error codes.

TInt GetFaxSettings(TFaxSessionSettings& aSettings) const;

Description

Gets the current fax settings.

Parameters

TFaxSessionSettings& aSettings On return, contains the fax settings

Return value

TInt KErrNone if successful, otherwise another of the system-wide error codes or an ETel Core error code.

TInt SetFaxSettings(const TFaxSessionSettings& aSettings) const;

Description

Assigns the fax settings.

Parameters

const TFaxSessionSettings& aSettings The new fax settings

Return value

TInt KErrNone if successful, otherwise another of the system-wide error codes or an ETel Core error code.

TBearerCaps

Description

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

Description

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

Description

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

Description

Fax identifier size flags.

KFaxIdUserNameMaxSize 20

TFaxMode

Description

Fax mode flags.

ETransmit Fax is transmitting EReceive Fax is receiving.

TFaxRetrieveType

Description

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

Description

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

Description

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

Description

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.