Skype4COM: ICall Interface Reference

Skype4COM

ICall Interface Reference

Call class default interface. More...

import "Skype4COM.idl";

List of all members.

Public Member Functions

HRESULT Hold ()
 This command places a call on hold.
HRESULT Resume ()
 This command resumes a call that was on hold.
HRESULT Finish ()
 This command ends a call.
HRESULT Answer ()
 This command answers a call.
HRESULT Join ([in] LONG Id)
 This command joins a call with another call to form a call conference.
HRESULT StartVideoSend ()
 This command starts video send.
HRESULT StopVideoSend ()
 This command stops video send.
HRESULT StartVideoReceive ()
 This command starts video receive.
HRESULT StopVideoReceive ()
 This command stops video receive.
HRESULT RedirectToVoicemail ()
 This command redirects an incoming call to voicemail.
HRESULT Forward ()
 This command forwards an incoming call.
HRESULT Transfer ([in] BSTR Target)
 Transfers call to contact or phone number.

Properties

LONG Id [get]
 This command queries the call ID.
DATE Timestamp [get]
 This command queries the call timestamp.
BSTR PartnerHandle [get]
 This command queries the Skypename of a remote caller.
BSTR PartnerDisplayName [get]
 This command queries the name of the remote caller.
LONG ConferenceId [get]
 This command queries a call conference ID.
TCallType Type [get]
 This command queries a call type.
TCallStatus Status [get, set]
 This command queries/sets a call status.
TCallFailureReason FailureReason [get]
 This command queries a call failure reason.
BSTR Subject [get]
 This command queries the subject of a call.
BSTR PstnNumber [get]
 This command queries the PSTN number of a call.
LONG Duration [get]
 This command queries the duration of a call.
BSTR PstnStatus [get]
 This command queries the call PSTN status.
VARIANT_BOOL Seen [get, set]
 This command queries or sets the call to a status of seen.
BSTR DTMF [set]
 This command sends a DTMF tone.
IParticipantCollection Participants [get]
 This command queries the number of participants in a conference call not hosted by the user.
LONG VmDuration [get]
 This command returns the duration of a voicemail.
LONG VmAllowedDuration [get]
 This command returns the permitted duration of a voicemail.
TCallVideoStatus VideoStatus [get]
 This command queries call video status.
TCallVideoSendStatus VideoSendStatus [get]
 This command queries call video send status.
TCallVideoSendStatus VideoReceiveStatus [get]
 This command queries call video receive status.
LONG Rate [get]
 This command queries the call rate, expressed in cents.
BSTR RateCurrency [get]
 This command queries currency code for the call rate.
LONG RatePrecision [get]
 This command queries the call rate precision.
BSTR InputDevice ([in] TCallIoDeviceType DeviceType) [get, set]
 This command queries or sets the input sound device.
BSTR OutputDevice ([in] TCallIoDeviceType DeviceType) [get, set]
 This command queries or sets the output sound device.
BSTR CaptureMicDevice ([in] TCallIoDeviceType DeviceType) [get, set]
 This command queries or sets the mic capture device.
VARIANT_BOOL InputStatus [get]
 This command queries the call voice input status.
BSTR ForwardedBy [get]
 This command queries the the identity of a user who forwards a call.
VARIANT_BOOL CanTransfer ([in] BSTR Target) [get]
 This command queries if a call can be transferred to contact or number.
TCallStatus TransferStatus [get]
 Returns call transferring status.
VARIANT_BOOL TransferActive [get]
 Returns true if the call has been transferred.
BSTR TransferredBy [get]
 Returns the Skypename of the user who transferred the call.
BSTR TransferredTo [get]
 Returns the Skypename of the user or phone number the call has been transferred to.
BSTR TargetIdentity [get]
 Returns the target number for incoming SkypeIN calls.

Detailed Description

Call class default interface.


Member Function Documentation

HRESULT Join ( [in] LONG  Id)

This command joins a call with another call to form a call conference.

Parameters:
[in]Idcontains the ID of the other call to join to the conference.
HRESULT Transfer ( [in] BSTR  Target)

Transfers call to contact or phone number.

Parameters:
[in]Targetphone number(s) or Skypename(s) the call is beeing transferred to.
Note:
You can transfer an incoming call to a group by specifying a comma separated list of targets, first one of the group to answer will get the call.
See also:
ICall::CanTransfer

Property Documentation

HRESULT CanTransfer [get]

This command queries if a call can be transferred to contact or number.

Parameters:
[in]TargetSkypename or phone number the call to be transferre to.
See also:
ICall::Transfer
HRESULT CaptureMicDevice [get, set]

This command queries or sets the mic capture device.

Parameters:
[in]DeviceTypecontains the device type, TCallIoDeviceType::callIoDeviceTypeSoundcard cannot be used with this property.
Note:
This command functions for active calls only.
HRESULT DTMF [set]

This command sends a DTMF tone.

Parameters:
[in]newValcontains the DTMF value to send. Permitted symbols are: {0..9,#,*}.
Note:
This command functions for active calls only.
HRESULT InputDevice [get, set]

This command queries or sets the input sound device.

Parameters:
[in]DeviceTypecontains the device type.
Note:
This command functions for active calls only.
HRESULT OutputDevice [get, set]

This command queries or sets the output sound device.

Parameters:
[in]DeviceTypecontains the device type.
Note:
This command functions for active calls only.
HRESULT Seen [get, set]

This command queries or sets the call to a status of seen.

Parameters:
[in]newValcontains a Boolean value to indicate if a call is seen or not.
Note:
You cannot alter the call seen status from seen to unseen.
HRESULT Status [get, set]

This command queries/sets a call status.

Deprecated:
Set ICall::Status is deprecated, use the ICall::Hold, ICall::Resume, ICall::Finish or ICall::Answer instead.

The documentation for this interface was generated from the following file:

Copyright � 2006 Skype Limited. All rights reserved.