![[Index]](../../../stock/btn_index.gif){kind=small}
![[Glossary]](../../../stock/btn_glossary.gif){kind=small}
![[Previous]](../../../stock/btn_prev.gif){kind=small}
![[Next]](../../../stock/btn_next.gif){kind=small}
| |
|
| |
Location:
etel.h
Link against: etel.lib
RCall
Supported from 5.0
Call sub-session.
Provides access to the functionality associated with a specific call.
This class is not intended for user derivation
|
Defined in RCall:
AcquireOwnership(), AcquireOwnershipCancel(), AnswerIncomingCall(), AnswerIncomingCallCancel(), Close(), Connect(), ConnectCancel(), DeregisterNotifyStatusChange(), 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(), GetOwnershipStatus(), GetStatus(), HangUp(), HangUpCancel(), KBearerCapsCompressionMNP5, KBearerCapsCompressionNone, KBearerCapsCompressionUnknown, KBearerCapsCompressionV42bis, KBearerCapsProtocolALT, KBearerCapsProtocolALT_CELLULAR, KBearerCapsProtocolLAPM, KBearerCapsProtocolNone, KBearerCapsProtocolUnknown, KCapsAnswer, KCapsConnect, KCapsData, KCapsDial, KCapsFax, KCapsHangUp, KCapsLoanDataPort, KCapsRecoverDataPort, KCapsVoice, KFaxIdUserNameMaxSize, LoanDataPort(), LoanDataPortCancel(), NotifyCallDurationChange(), NotifyCallDurationChangeCancel(), NotifyCapsChange(), NotifyCapsChangeCancel(), NotifyHookChange(), NotifyHookChangeCancel(), NotifyOnAnything(), NotifyOnAnythingCancel(), NotifyStatusChange(), NotifyStatusChangeCancel(), OpenExistingCall(), 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, TWaitForDialTone, TransferOwnership()
RCall();
Creates the default empty constructor, and is present only to support virtual function table export.
|
TInt OpenNewCall(RTelServer& aServer,const TDesC& aName,TDes& aNewName);
Opens a new call from a server session and returns the call name.
|
|
![[Top]](../../../stock/arrow_up_2.gif){kind=icon}
RCall object is destroyed before the subsession is closed.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);
Opens a new call from a server, but does not return the new name to the client.
|
|
RCall object is destroyed before the subsession is closed.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);
Opens a new call from a phone and returns the name top the client.
|
|
RCall object is destroyed before the subsession is closed.TInt OpenNewCall(RPhone& aPhone,const TDesC& aName);
Opens a new call from a phone, but does not return the new name to the client.
Note:
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);
Opens a new call from a line and returns the name to the client.
|
|
RCall object is destroyed before the subsession is closed.TInt OpenNewCall(RLine& aLine);
Opens a new call from a line. The name of the new call is not returned.
|
|
RCall object is destroyed before the subsession is closed.TInt OpenExistingCall(RTelServer& aServer,const TDesC& aName);
Opens an existing call from a server.
|
|
RCall object is destroyed before the subsession is closed.TInt OpenExistingCall(RPhone& aPhone,const TDesC& aName);
Opens an existing call from a phone.
|
|
RCall object is destroyed before the subsession is closed.TInt OpenExistingCall(RLine& aLine,const TDesC& aName);
Opens an existing call from a line.
|
|
RCall object is destroyed before the subsession is closed.void Close();
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;
Gets the current call status.
|
|
TInt GetCaps(TCaps& aCaps) const;
Gets a snapshot of the current call capabilities.
|
|
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.
|
|
TInt GetInfo(TCallNotifyInfo& aCallNotifyInfo) const;
Supported from 5.0
Withdrawn in 5.1
Gets the current call information.
|
|
TInt GetInfo(TCallInfo& aCallInfo) const;
Supported from 5.1
Gets the current call information.
|
|
TInt GetCallDuration(TTimeIntervalSeconds& aTime) const;
Gets the call duration.
|
|
TInt GetCallParams(TDes8& aParams) const;
Gets the current call parameters.
|
|
|
void NotifyCapsChange(TRequestStatus& aStatus, TCaps& aCaps);
Provides notification of a change in the call capabilities.
|
void NotifyCapsChangeCancel() const;
Cancels a "call capabilities change" notification request,
placed using the NotifyCapsChange() function.
void NotifyOnAnything(TRequestStatus& aStatus,TCallNotifyInfo& aCallNotifyInfo);
Supported from 5.0
Withdrawn in 5.1
Provides notification of changes in the call information.
|
void NotifyOnAnythingCancel() const;
Supported from 5.0
Withdrawn in 5.1
Cancels an "Any change" notification request, placed using the
NotifyOnAnything() function.
void NotifyHookChange(TRequestStatus& aStatus,THookStatus& aHookStatus);
Provides notification of a change in the hook status.
|
void NotifyHookChangeCancel() const;
Cancels an outstanding “hook status change”
notification request, placed with the NotifyHookChange()
function.
TInt RegisterNotifyStatusChange(const TInt aBufferSize) const;
Supported from 5.0
Withdrawn in 5.1
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.
|
|
TInt DeregisterNotifyStatusChange() const;
Supported from 5.0
Withdrawn in 5.1
This function deletes the buffer in the server. If a client has a status change notification still outstanding, it will remain so.
|
void NotifyStatusChange(TRequestStatus& aStatus,TStatus& aCallStatus);
Provides notification about a change in the status of a call.
|
void NotifyStatusChangeCancel() const;
Cancels an outstanding “call status change”
notification request, placed using the NotifyStatusChange()
function.
void NotifyCallDurationChange(TRequestStatus& aStatus,TTimeIntervalSeconds& aTime);
Provides notification of an increase in call duration (by one second).
|
void NotifyCallDurationChangeCancel() const;
Cancels an outstanding “call duration change”
notification request, placed using the NotifyCallDurationChange()
function.
|
TInt Dial(const TTelNumberC& aTelNumber) const;
Attempts to establish a connection using the telephone number specified.
|
|
RCall object has been
opened from a data line or a fax line.TInt Dial(const TDesC8& aCallParams,const TTelNumberC& aTelNumber) const;
Attempts to establish a connection using the telephone number specified.
|
|
RCall object has been
opened from a data line or a fax line.void Dial(TRequestStatus& aStatus,const TTelNumberC& aTelNumber);
Attempts to establish a connection using the telephone number specified.
|
RCall object has been
opened from a data line or a fax line.void Dial(TRequestStatus& aStatus,const TDesC8& aCallParams,const TTelNumberC& aTelNumber);
Attempts to establish a connection using the telephone number specified.
|
RCall object has been
opened from a data line or a fax line.void DialCancel() const;
Cancels an outstanding dial request, placed with the
asynchronous version of the Dial() function.
TInt Connect() const;
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.
|
RCall object has been
opened from a data line or a fax line.TInt Connect(const TDesC8& aCallParams) const;
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.
|
|
RCall object has been
opened from a data line or a fax line.void Connect(TRequestStatus& aStatus);
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.
|
RCall object has been
opened from a data line or a fax line.void Connect(TRequestStatus& aStatus,const TDesC8& aCallParams);
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.
|
RCall object has been
opened from a data line or a fax line.void ConnectCancel() const;
Allows a client to cancel a “connection”
request, placed using the asynchronous versions of the Connect()
function.
TInt AnswerIncomingCall() const;
Waits for an incoming call and answers it when it arrives — synchronous.
|
TInt AnswerIncomingCall(const TDesC8& aCallParams) const;
Waits for an incoming call and answers it when it arrives — synchronous. The function also answers calls which are ringing when it is invoked.
|
|
void AnswerIncomingCall(TRequestStatus& aStatus);
Waits for an incoming call and answers it when it arrives — asynchronous. The function also answers calls which are ringing when it is invoked.
|
void AnswerIncomingCall(TRequestStatus& aStatus,const TDesC8& aCallParams);
Waits for an incoming call and answers it when it arrives — asynchronous. The function also answers calls which are ringing when it is invoked.
|
void AnswerIncomingCallCancel() const;
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;
Terminates an active call established with the
Dial(), Connect() or
AnswerIncomingCall() functions — synchronous.
|
void HangUp(TRequestStatus& aStatus) const;
Terminates an active call established with the
Dial(), Connect() or
AnswerIncomingCall() functions — asynchronous.
|
void HangUpCancel() const;
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;
Allows a client to gain control of the serial communications abstraction used to communicate with a modem.
|
|
RecoverDataPort() function is called. After recovery, queued
commands are executed.void LoanDataPort(TRequestStatus& aStatus,TCommPort& aDataPort);
Allows a client to gain control of the serial communications abstraction used to communicate with the modem.
|
RecoverDataPort() function is called. void LoanDataPortCancel() const;
Allows a client to cancel an outstanding loan communications
port request, placed using the asynchronous version of the
LoanDataPort() function.
TInt RecoverDataPort() const;
Indicates that the client has finished using the serial communication channel — so the ETel server can retake control.
|
|
void AcquireOwnership(TRequestStatus& aStatus) const;
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.
|
void AcquireOwnershipCancel() const;
Cancels an outstanding request to acquire call ownership,
placed with the AcquireOwnership() function.
TInt TransferOwnership() const;
Allows clients with call ownership to transfer ownership to another interested client.
|
TInt GetOwnershipStatus(TOwnershipStatus& aOwnershipStatus) const;
Gets ownership information associated with the call.
|
|
|
TInt GetFaxSettings(TFaxSessionSettings& aSettings) const;
Gets the current fax settings.
|
|
TInt SetFaxSettings(const TFaxSessionSettings& aSettings) const;
Assigns the fax settings.
|
|
|
TBearerCaps
Bearer capability flags.
|
TCallBearerSpeed
Bearer speed flags.
|
TCapsEnum
Call capability flags.
|
TFaxRetrieveType
Fax retrieval type flags.
|
THookStatus
Hook status flags.
|
TMonitorSpeakerControl
Monitor speaker control setting flags.
|
TMonitorSpeakerVolume
Monitor speaker volume control setting flags.
|
TOwnershipStatus
Call ownership status flags.
|
TStatus
Call status flags.
|
TWaitForDialTone
Wait for dial tone flags.
|
|
TBearerService
Call bearer information.
Defined in RCall::TBearerService:
iBearerCaps, iBearerSpeed
iBearerCapsTUint32 iBearerCaps
The bearer capabilities.
iBearerSpeedTCallBearerSpeed iBearerSpeed
The bearer's speed.
TCaps
Call capability information.
Defined in RCall::TCaps:
iFlags
iFlagsTUint iFlags
Call capability flag. Contains a bitmask of values defined in
the TCapsEnum enumeration.
TCommPort
Communications port information.
Defined in RCall::TCommPort:
iCsy, iPort
iCsyTFileName iCsy
The CSY module used by the C32 Communications Server to talk to the serial device.
iPortTName iPort
The port used by the C32 Communications Server to talk to the serial device.
TFaxSessionSettings
Fax session settings information.
Defined in RCall::TFaxSessionSettings:
iFaxClass, iFaxId, iFaxOnDemandDelay, iFaxRetrieveType, iMaxSpeed, iMinSpeed, iMode, iPreferredECM, iRxCompression, iRxResolution, iTxCompression, iTxPages, iTxResolution
iModeTFaxMode iMode
The fax mode.
iFaxRetrieveTypeTFaxRetrieveType iFaxRetrieveType
The mode of retrieving faxes.
iFaxClassTFaxClass iFaxClass
The class of fax
TFaxClassiFaxIdTBuf8<KFaxIdUserNameMaxSize> iFaxId
Supported from 5.0
Withdrawn in 5.1
The fax identifier string displayed at the top of the fax.
iFaxIdTBuf<KFaxIdUserNameMaxSize> iFaxId
Supported from 5.1
The fax identifier string displayed at the top of the fax.
iMaxSpeedTInt iMaxSpeed
The maximum transfer speed that can be negotiated.
iMinSpeedTInt iMinSpeed
The minimum transfer speed that should be negotiated.
iPreferredECMTInt iPreferredECM
The preferred compression mode used for negotiation. This may
take one of the following values: EModifiedHuffman,
EModifiedRead, EUncompressedModifiedRead,
EModifiedModifiedRead.
iFaxOnDemandDelayTInt iFaxOnDemandDelay
The delay used for Fax on Demand services. Measured in seconds.
iTxResolutionTFaxResolution iTxResolution
The preferred transmit resolution. This may take one of the
following values: EFaxNormal
EFaxFine
TFaxResolutioniTxCompressionTFaxCompression iTxCompression
Compression mode for transmitting faxes.
TFaxCompressioniTxPagesTInt iTxPages
The number of pages to be transmitted.
iRxResolutionTFaxResolution iRxResolution
The preferred receive resolution. This may take one of the
following values: EFaxNormal
EFaxFine.
TFaxResolutioniRxCompressionTFaxCompression iRxCompression
Compression mode for receiving faxes.
TFaxCompression
|
typedef TDesC8 TTelNumberC;
Supported from 5.0
Withdrawn in 5.1
Passes telephone numbers into Dial functions.
typedef TDesC TTelNumberC;
Supported from 5.1
Passes telephone numbers into Dial functions.
typedef TPckg<TCallParams> TCallParamsPckg;
Call parameters package
The call parameters to be associated with a call may be passed into functions using this type.
RCall::TCallNotifyInfo
Supported from 5.0
Withdrawn in 5.1
Core API call class information.
Collects all the information associated with an instance of the core API call class 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.
This class is not intended for user derivation
Defined in RCall::TCallNotifyInfo:
TCallNotifyInfo(), iCallName, iCallNameChanged, iDuration, iDurationChanged, iHookStatus, iHookStatusChanged, iLineName, iLineNameChanged, iStatus, iStatusChanged
|
|
TBool iLineNameChanged;
An indication that the line information has changed since the last notification.
TBool iHookStatusChanged;
An indication that the hook status information has changed since the last notification.
TBool iStatusChanged;
An indication that the call status has changed since the last notification.
TBool iDurationChanged;
An indication that the call duration has changed since the last notification.
RCall::TCallInfo
Supported from 5.1
Core API call class information
Collects all the information associated with an instance of the core API call class 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.
This class is not intended for user derivation
Defined in RCall::TCallInfo:
TCallInfo(), iCallName, iDuration, iHookStatus, iLineName, iStatus
|
|
RCall::TCallParams
Call parameter information.
Defines the call parameter information.
This class is not intended for user derivation.
Defined in RCall::TCallParams:
IsDefault(), TCallParams(), iInterval, iSpeakerControl, iSpeakerVolume, iWaitForDialTone
|
RCall::TCallParams();
Trivial 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(TMonitorSpeakerControl aSpeakerControl, TMonitorSpeakerVolume aSpeakerVolume, TUint aInterval, TWaitForDialTone aWaitForDialTone);
Allows developers to initialise member variables when the object is constructed.
|
|
TBool IsDefault();
Tests if the object was created using the default values.
|
|
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.
Copyright ©2002 Symbian Ltd. 6.1-00174 |
|
![[Top]](../../../stock/arrow_up.gif){kind=icon}