TapiCall Class

Declaration Syntax

C#

Visual Basic

Visual C++

public class TapiCall

Public Class TapiCall

public ref class TapiCall

Members

Icon	Member	Description
	Accept()()()	Accepts offered call.
	Address	Gets a TapiAddress that received the call.
	Answer()()()	Answers incoming call.
	CalledID	Gets the called party's ID (phone number), if available.
	CalledIDName	Gets the called party's name, if available.
	CallerID	Gets the caller's ID (phone number), if available.
	CallerIDName	Gets the caller's name, if available.
	CallID	Gets a numeric identifier (sequence number) of the call.
	ConnectedID	Gets the connected party's ID (phone number), if available.
	ConnectedIDName	Gets the connected party's name, if available.
	Direction	Gets a direction of the call (incoming or outgoing).
	Disconnect()()()	Disconnects the call.
	DisconnectMode	Gets the disconnect mode (reason) for the disconnected call.
	Display	Gets the telephony system-specific call display information, if available.
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize()()()	Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	GatherDigits(Int32, String, Int32, Int32)	Gathers one or more DTMF digits on the call.
	GenerateDigits(String)	Initiates the generation of the specified digits on the call.
	GetCommHandle()()()	Obtains a handle of the open communication port associated with the call.
	GetHashCode()()()	Serves as a hash function for a particular type. GetHashCode()()() is suitable for use in hashing algorithms and data structures like a hash table. (Inherited from Object.)
	GetType()()()	Gets the Type of the current instance. (Inherited from Object.)
	Guid	Gets the globally unique identifier (GUID) of the call.
	Hold()()()	Places the call on hold.
	Line	Gets a TapiLine that the call is associated with.
	MemberwiseClone()()()	Creates a shallow copy of the current Object. (Inherited from Object.)
	Origin	Gets the origin of the call.
	Play(String, Boolean)	Plays a wave file.
	Play(String)	Plays a wave file. Pending speak and play requests are not purged.
	Reason	Gets the reason for the call.
	Redirect(String)	Redirects the call to the specified destination number.
	RedirectingID	Gets the redirecting party's ID (phone number), if available.
	RedirectingIDName	Gets the redirecting party's name, if available.
	RedirectionID	Gets the redirection party's ID (phone number), if available.
	RedirectionIDName	Gets the redirection party's name, if available.
	RelatedCallID	Gets a numeric identifier (sequence number) of the related call.
	Speak(String, Boolean)	Speaks the contents of a text string using text synthesis.
	Speak(String)	Speaks the contents of a text string using text synthesis. Pending speak and play requests are not purged.
	StartRecording(String)	Starts recording of call audio.
	State	Gets the state of the call.
	StopPlayback()()()	Stops currently playing wave file or text-to-speech.
	StopRecording()()()	Stops recording of call audio.
	Tag	Gets or sets the object that contains supplemental data about the call.
	ToString()()()	Returns a String that represents the current Object. (Inherited from Object.)
	Transfer(String)	Performs a blind or single-step transfer of the call.
	Unhold()()()	Retrieves the held call.
	WaitForDigit(Int32)	Waits until either a DTMF digit has been detected or the specified time interval has elapsed.
	WaitForSilence(Int32, Int32)	Waits until either a period of silence has been detected or the specified time interval has elapsed.
	WaitUntilDone(Int32)	Waits until either all pending speak and play requests have completed or the specified time interval has elapsed.

Remarks

AddTapi.NET creates a TapiCall object for each incoming or outgoing call. TapiCall object contains information about a call such as the caller's number, and provides methods to play wave files, speak text and obtain digits pressed by a remote party.

TapiCall objects are provided to the application in TapiCallHandler callback, and in IncomingCall, CallConnected and CallDisconnected events. In addition, Dial(String, Boolean) method returns TapiCall object created for the outgoing call.

Examples

The following code shows how to obtain TapiCall object in the IncomingCall event handler.

C#

            TapiApp.Initialize("MyApp");
            TapiApp.IncomingCall += OnIncomingCall;
            ...
            
            void OnIncomingCall(object sender, TapiEventArgs args)
            {
                TapiCall call = args.Call;
                // Display caller's number to the user
                Console.WriteLine("Incoming call from {0}", call.CallerID);
            }

VB.NET

            TapiApp.Initialize("MyApp")
            AddHandler TapiApp.IncomingCall, AddressOf OnIncomingCall
            ...
            
            Private Sub OnIncomingCall(ByVal sender As Object, ByVal args As TapiEventArgs)
                Dim objCall As TapiCall
                objCall = args.Call
                ' Display caller's number to the user
                Console.WriteLine("Incoming call from {0}", objCall.CallerID)
            End Sub

Inheritance Hierarchy

Object
	TapiCall

All Members	Methods	Properties
Public Protected		Instance Static		Declared Inherited