class RCall : public RTelSubSessionBase |
Call sub-session.
Provides access to the functionality associated with a specific call.
This class is not intended for user derivation.
Protected Member Functions | |
---|---|
IMPORT_C void | ConstructL () |
IMPORT_C void | Destruct () |
Inherited Enumerations | |
---|---|
RTelSubSessionBase:TReqPriorityType |
Public Member Type Definitions | |
---|---|
typedef | TPckg < TCallParams > TCallParamsPckg |
typedef | TDesC TTelNumberC |
Inherited Attributes | |
---|---|
RTelSubSessionBase::iPtrHolder |
IMPORT_C | RCall | ( | ) |
The default empty constructor, present only to support virtual function table export.
A call is identified by TDesC Phone_Name::Line_Name::Call_Name. Whenever the string Phone_Name::Line_Name::Call_Name appears in this document it refers to this descriptor, and not a subclass.
IMPORT_C void | AcquireOwnershipCancel | ( | ) | const |
IMPORT_C TInt | AdoptFaxSharedHeaderFile | ( | const RFile & | aSharedFile | ) | const |
const RFile & aSharedFile |
IMPORT_C TInt | AnswerIncomingCall | ( | const TDesC8 & | aCallParams | ) | const |
const TDesC8 & aCallParams |
IMPORT_C void | AnswerIncomingCall | ( | TRequestStatus & | aStatus | ) |
TRequestStatus & aStatus |
IMPORT_C void | AnswerIncomingCallCancel | ( | ) | const |
IMPORT_C TInt | Connect | ( | const TDesC8 & | aCallParams | ) | const |
const TDesC8 & aCallParams |
IMPORT_C void | Connect | ( | TRequestStatus & | aStatus | ) |
TRequestStatus & aStatus |
IMPORT_C void | ConnectCancel | ( | ) | const |
IMPORT_C TInt | Dial | ( | const TTelNumberC & | aTelNumber | ) | const |
const TTelNumberC & aTelNumber |
IMPORT_C TInt | Dial | ( | const TDesC8 & | aCallParams, |
const TTelNumberC & | aTelNumber | |||
) | const |
const TDesC8 & aCallParams | |
const TTelNumberC & aTelNumber |
IMPORT_C void | Dial | ( | TRequestStatus & | aStatus, |
const TTelNumberC & | aTelNumber | |||
) |
TRequestStatus & aStatus | |
const TTelNumberC & aTelNumber |
IMPORT_C void | DialCancel | ( | ) | const |
IMPORT_C TInt | GetBearerServiceInfo | ( | TBearerService & | aBearerService | ) | const |
Gets the bearer service information associated with the call. Bearer service information is only available if the call is currently active.
TBearerService & aBearerService | On return, contains the bearer service information. |
IMPORT_C TInt | GetCallDuration | ( | TTimeIntervalSeconds & | aTime | ) | const |
Gets the call duration.
TTimeIntervalSeconds & aTime | On return, contains the call duration (in seconds) |
IMPORT_C TInt | GetCallParams | ( | TDes8 & | aParams | ) | const |
Gets the current call parameters.
TDes8 & aParams | On return, contains the call parameters. The variable must be an instance of the TCallParamsPckg class. |
IMPORT_C TInt | GetCaps | ( | TCaps & | aCaps | ) | const |
Gets a snapshot of the current call capabilities.
TCaps & aCaps | On return, contains the call capabilities |
IMPORT_C TInt | GetFaxSettings | ( | TFaxSessionSettings & | aSettings | ) | const |
Gets the current fax settings.
TFaxSessionSettings & aSettings | On return, contains the fax settings |
IMPORT_C TInt | GetInfo | ( | TCallInfo & | aCallInfo | ) | const |
Gets the current call information.
TCallInfo & aCallInfo | On return, contains the current call information |
IMPORT_C TInt | GetOwnershipStatus | ( | TOwnershipStatus & | aOwnershipStatus | ) | const |
Gets ownership information associated with the call.
TOwnershipStatus & aOwnershipStatus | On return, contains the call ownership status information |
IMPORT_C TInt | GetStatus | ( | TStatus & | aStatus | ) | const |
Gets the current call status.
TStatus & aStatus | On return, contains the current call status |
IMPORT_C TInt | HangUp | ( | ) | const |
Terminates a call established with the Dial() , Connect() or AnswerIncomingCall() functions - synchronous.
When using an AT-command based TSY, HangUp() can only be used once the call is in a connected state. However, in a one-box solution, where the TSY interfaces more directly to the phone, HangUp() can also be used in a call ringing state.
Hanging up can take some time. Use of the asynchronous variant of this function is recommended.
IMPORT_C void | HangUpCancel | ( | ) | const |
IMPORT_C TInt | LoanDataPort | ( | TCommPort & | aDataPort | ) | const |
Allows a client to gain control of the serial communications abstraction used to communicate with a modem.
This is the synchronous version of this method.
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.
TCommPort & aDataPort | On return, contains the information required to open the communications port. |
IMPORT_C void | LoanDataPortCancel | ( | ) | const |
Allows a client to cancel an outstanding loan communications port request, placed using the asynchronous version of the LoanDataPort() function.
IMPORT_C void | NotifyCallDurationChangeCancel | ( | ) | const |
IMPORT_C void | NotifyCapsChange | ( | TRequestStatus & | aStatus, |
TCaps & | aCaps | |||
) |
Provides notification of a change in the call capabilities.
TRequestStatus & aStatus | A variable that indicates the completion status of the request. |
TCaps & aCaps | On request completion, contains the call's capability information |
IMPORT_C void | NotifyCapsChangeCancel | ( | ) | const |
IMPORT_C void | NotifyHookChange | ( | TRequestStatus & | aStatus, |
THookStatus & | aHookStatus | |||
) |
Provides notification of a change in the hook status.
TRequestStatus & aStatus | A variable that indicates the completion status of the request. |
THookStatus & aHookStatus | On request completion, contains the new hook status |
IMPORT_C void | NotifyHookChangeCancel | ( | ) | const |
IMPORT_C void | NotifyStatusChange | ( | TRequestStatus & | aStatus, |
TStatus & | aCallStatus | |||
) |
Provides notification about a change in the status of a call.
TRequestStatus & aStatus | A variable that indicates the completion status of the request. |
TStatus & aCallStatus | On request completion, contains the new call status. |
IMPORT_C void | NotifyStatusChangeCancel | ( | ) | const |
IMPORT_C TInt | OpenExistingCall | ( | RTelServer & | aServer, |
const TDesC & | aName | |||
) |
RTelServer & aServer | |
const TDesC & aName |
IMPORT_C TInt | OpenExistingCall | ( | RPhone & | aPhone, |
const TDesC & | aName | |||
) |
IMPORT_C TInt | OpenExistingCall | ( | RLine & | aLine, |
const TDesC & | aName | |||
) |
IMPORT_C TInt | OpenNewCall | ( | RTelServer & | aServer, |
const TDesC & | aName, | |||
TDes & | aNewName | |||
) |
RTelServer & aServer | |
const TDesC & aName | |
TDes & aNewName |
IMPORT_C TInt | OpenNewCall | ( | RTelServer & | aServer, |
const TDesC & | aName | |||
) |
RTelServer & aServer | |
const TDesC & aName |
IMPORT_C TInt | OpenNewCall | ( | RPhone & | aPhone, |
const TDesC & | aName, | |||
TDes & | aNewName | |||
) |
IMPORT_C TInt | OpenNewCall | ( | RPhone & | aPhone, |
const TDesC & | aName | |||
) |
IMPORT_C TInt | RecoverDataPort | ( | ) | const |
so the ETel server can retake control.
IMPORT_C TInt | SetFaxSettings | ( | const TFaxSessionSettings & | aSettings | ) | const |
Assigns the fax settings.
const TFaxSessionSettings & aSettings | The new fax settings |
IMPORT_C TInt | TransferOwnership | ( | ) | const |
Allows clients with call ownership to transfer ownership to another interested client.
Bearer capability flags.
KBearerCapsCompressionV42bis = 0x00000001 |
V42bis modem compression protocol. |
KBearerCapsCompressionMNP5 = 0x00000002 |
MNP5 modem compression protocol. |
KBearerCapsCompressionNone = 0x00000004 |
No compression supported. |
KBearerCapsProtocolLAPM = 0x00000008 |
LAPM error correction protocol. |
KBearerCapsProtocolALT_CELLULAR = 0x00000010 |
MNP10 mode. |
KBearerCapsProtocolALT = 0x00000020 |
MNP error correction. |
KBearerCapsProtocolNone = 0x00000040 |
No protocol information provided. |
KBearerCapsCompressionUnknown = 0x00000080 |
Compression protocol unknown. |
KBearerCapsProtocolUnknown = 0x00000100 |
Unable to establish protocol. |
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. |
Call capability flags.
KCapsData = 0x00000001 |
The call supports data calls. |
KCapsFax = 0x00000002 |
The call supports fax calls. |
KCapsVoice = 0x00000004 |
The call supports voice calls. |
KCapsDial = 0x00000008 |
The Dial request is currently a valid action. |
KCapsConnect = 0x00000010 |
The Connect request is currently a valid action. |
KCapsHangUp = 0x00000020 |
The Hang Up request is currently a valid action. |
KCapsAnswer = 0x00000040 |
The Answer request is currently a valid action. |
KCapsLoanDataPort = 0x00000080 |
The Loan Data Port request is currently a valid action. |
KCapsRecoverDataPort = 0x00000100 |
The Recover Data Port request is currently a valid action. |
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. |
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 |
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. |
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. |
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. |
Wait for dial tone flags.
EDialToneWait |
Waiting for dial tone. |
EDialToneNoWait |
Not waiting for dial tone. |
typedef TPckg < TCallParams > | TCallParamsPckg |
Call parameters package
The call parameters to be associated with a call may be passed into functions using this type.
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.