Click here to Skip to main content
15,867,568 members
Articles / Programming Languages / Visual Basic
Article

Working with TAPI 3.x from .NET

Rate me:
Please Sign up or sign in to vote.
3.08/5 (47 votes)
6 Aug 2005CPOL 428.4K   11.7K   79   120
It's about time to Use Advanced Telephony features in your code? Right!

Introduction

Here I will post a class containing the event handling part in TAPI 3.0 and VB.NET.
I will also include the full project as a download.

The code is self explaining and well commented and if you need any further information, please drop me a PM.

All comments are welcome and please vote for the article.

Here is the full commented source code in VB.NET and I will be posting more in-depth tutorials about TAPI.

VB.NET
Imports TAPI3Lib 

Namespace VBCity.TAPI 

    Public Class VBTAPI 

        Private Const MediaAudio As Integer = 8 
        Private Const MediaModem As Integer = 16 
        Private Const MediaFax As Integer = 32 
        Private Const MediaVideo As Integer = 32768 

        Private WithEvents oTAPI As TAPI3Lib.TAPI ' will hold our TAPI object 
        ' will hold our selected address (you can hold many addresses in an array)
        Private oAddress As ITAddress 
        Private RegCookie As Integer 

        Sub New() 
            Try 
                ' creating a new instance to first initialize TAPI 
                ' before attaching the events 
                Dim m_TAPI As New TAPIClass 
                ' a variable to hold supported media types for the address 
                Dim MediaTypes As Integer 
                ' initializing TAPI 
                m_TAPI.Initialize() 
                ' attaching event sink 
                oTAPI = m_TAPI 
                ' getting rid of the private instance as we have another 
                ' global instance (oTAPI) 
                m_TAPI = Nothing 
                Dim AddressCollection As ITCollection = oTAPI.Addresses() 
                ' looping through address collection
                For Each Address As ITAddress In AddressCollection  
                    ' checking if address is working
                    If Address.State = ADDRESS_STATE.AS_INSERVICE Then  
                        ' extracting media support interface from the address 
                        Dim MediaSupport As ITMediaSupport = Address 
                        ' extracting media types supporting 
                        MediaTypes = MediaSupport.MediaTypes 
                        MediaSupport = Nothing ' dispose of the object 
                        If (MediaTypes And MediaModem) = MediaModem Then 
                            ' the address is a data Modem 
                            If (MediaTypes And MediaAudio) = MediaAudio Then 
                                ' Select the address since it supports Audio 
                                ' and is a FAX/Modem 
                                oAddress = Address ' select this address 
                                ' show the selected address name
                                MsgBox("we have selected this address: " + _
                                       oAddress.AddressName)  
                                Exit For 
                            End If 
                        End If 
                    End If 
                Next Address 
                If Not (oAddress Is Nothing) Then 
                    ' registering notifications for the selected address 
                    RegCookie = oTAPI.RegisterCallNotifications_
                                (oAddress, True, False, MediaTypes, 1) 
                    ' Note: this registration can be done on 
                    ' as many addresses as you want 
                    ' we will not receive notifications unless we specify 
                    ' which type of events we are interested in 
                    oTAPI.EventFilter = (TAPI_EVENT.TE_CALLNOTIFICATION Or _
                            TAPI_EVENT.TE_CALLSTATE Or TAPI_EVENT.TE_CALLINFOCHANGE) 
                Else 
                    MsgBox("no address selected") 
                End If 
            Catch ex As Exception 
                MsgBox("Error occurred:" & vbCrLf & ex.Message, _
                        MsgBoxStyle.Critical, "VBCITY.VBTAPI") 
            End Try 
            ' by now we are done for the initialization and registration 
            ' and the events should fire 
            ' Note: you must dispose of TAPI before you destroy the class 
            ' and I will leave this for now 
        End Sub 
        
        Private Sub oTAPI_Event(ByVal TapiEvent As TAPI3Lib.TAPI_EVENT, _
                        ByVal pEvent As Object) Handles oTAPI.Event 
            ' making a thread asynchronously process the event 
            Dim thAsyncCall As System.Threading.Thread 
            Select Case TapiEvent 
            
                Case TAPI_EVENT.TE_CALLNOTIFICATION 'Call Notification Arrived 
                    ' assigning our sub's delegate to the thread 
                    thAsyncCall = New Threading.Thread(AddressOf CallNotificationEvent) 
                    ' passing the variable for the thread 
                    CallNotificationObject = CType(pEvent, ITCallNotificationEvent) 
                    ' starting the thread 
                    thAsyncCall.Start() 
                    
                Case TAPI_EVENT.TE_CALLSTATE 'Call State Changes 
                    ' assigning our sub's delegate to the thread 
                    thAsyncCall = New Threading.Thread(AddressOf CallStateEvent) 
                    ' passing the variable for the thread 
                    CallStateObject = CType(pEvent, ITCallStateEvent) 
                    ' starting the thread 
                    thAsyncCall.Start() 
                    
                Case TAPI_EVENT.TE_CALLINFOCHANGE 'Call Info Changes 
                    ' assigning our sub's delegate to the thread 
                    thAsyncCall = New Threading.Thread(AddressOf CallInfoEvent) 
                    ' passing the variable for the thread 
                    CallInfoObject = CType(pEvent, ITCallInfoChangeEvent) 
                    ' starting the thread 
                    thAsyncCall.Start() 
                    
            End Select 
        End Sub 
        
        Private CallNotificationObject As ITCallNotificationEvent 
        Private Sub CallNotificationEvent() 
            ' here we should check to see various notifications of new and ended calls 
            Select Case CallNotificationObject.Event 
            
                Case CALL_NOTIFICATION_EVENT.CNE_MONITOR 
                    ' the notification is for a monitored call 
                Case CALL_NOTIFICATION_EVENT.CNE_OWNER 
                    ' the notification is for an owned call 
            
            End Select 
        End Sub 

        Private CallStateObject As ITCallStateEvent 
        Private Sub CallStateEvent() 
            ' here we should check to see call state and handle connects and disconnects 
            Select Case CallStateObject.State 
            
                Case CALL_STATE.CS_IDLE 
                Case CALL_STATE.CS_INPROGRESS 
                Case CALL_STATE.CS_OFFERING 
                    ' a call is offering so if you don't want it then pass it 
                    ' The code to pass the call is the following 
                    ' Dim CallControl As ITBasicCallControl = CallStateObject.Call 
                    ' CallControl.HandoffIndirect (CallStateObject.Call.CallInfoLong_
                                            (CALLINFO_LONG.CIL_MEDIATYPESAVAILABLE) 
                Case CALL_STATE.CS_CONNECTED 
                    ' call is connected 
                Case CALL_STATE.CS_QUEUED 
                    ' call is being queued 
                Case CALL_STATE.CS_HOLD 
                    ' call is on hold 
                Case CALL_STATE.CS_DISCONNECTED 
                    ' call is disconnected 
            
            End Select 
        End Sub 

        Private CallInfoObject As ITCallInfoChangeEvent 
        Private Sub CallInfoEvent() 
            ' here you can extract information from the call 
            ' the code to extract the caller ID 
            ' >>> put the following code in a try block and 
            ' swallow the exception if it gives errors 
            Dim CallerID As String 
            CallerID = CallInfoObject.Call.CallInfoString_
                    (CALLINFO_STRING.CIS_CALLERIDNAME) 
        End Sub 

    End Class 
End Namespace

History

  • 7th August, 2005: Initial post

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


Written By
Architect Dot Labs Pty Ltd
Australia Australia
A trusted technology adviser and a seasoned consultant with 15 years of experience in IT industry focused on helping organisations build modern IT solutions that drive innovation and increase efficiency and end-user value.

With a strong business acumen, an entrepreneur character, and vast experience in software engineering, I started my own consulting business (Dot Labs Pty Ltd) with a mission to drive adoption of modern solution architecture, public cloud infrastructure, and industry best practices.

During my career, I gained an extensive hands-on experience of software engineering through architecture standards, patterns, and best practice through my work with various enterprise organisations and startups, while keeping track of emerging technology and industry trends.

Comments and Discussions

 
GeneralRe: Visual Basic 2008 - frustration Pin
Bishoy Demian18-Mar-10 6:09
Bishoy Demian18-Mar-10 6:09 
GeneralRe: Visual Basic 2008 - frustration Pin
TomGermany201029-Mar-10 23:31
TomGermany201029-Mar-10 23:31 
GeneralVB .NET Pin
OppVen3-Jun-11 4:30
OppVen3-Jun-11 4:30 
GeneralQuestion using windows XP built in dialer.exe to initiate calls Pin
Megrim0326-Nov-09 5:33
Megrim0326-Nov-09 5:33 
GeneralMy vote of 1 Pin
albert_cook11-Aug-09 21:54
albert_cook11-Aug-09 21:54 
GeneralNeed help Pin
kshirsagar15-Jun-09 19:27
kshirsagar15-Jun-09 19:27 
Generalplease explain this code, surely it is an error Pin
edt12311-May-09 9:35
edt12311-May-09 9:35 
AnswerRe: please explain this code, surely it is an error Pin
Bishoy Demian15-May-09 5:53
Bishoy Demian15-May-09 5:53 
Hi Ed,
propably you've used something like this before its called Bitwise And operation and this statement is two parts to understand here
first "(MediaTypes And MediaModem)" and this will result 0 if MediTypes does not contain the value of MediaModem, otherwise it will return the value of MediaModem

and the second part is "If (MediaTypes And MediaModem) = MediaModem Then"
which will use the outcome of the first bitwise operation and compare it to the value of MediaModem and in this case it will succeed only if the result of the bitwise And operation yielded the Value of MediaModem.


and this is because MediaTypes variable contains multiple values combined together with Bitwise Oring, we must use Anding to check if one if the values exist or not.

"Imagination is more important than knowledge.."
{Albert Einstein}

General[Message Deleted] Pin
it.ragester28-Mar-09 5:37
it.ragester28-Mar-09 5:37 
Questionhow do i use this Pin
theboytony20-Feb-09 8:50
theboytony20-Feb-09 8:50 
GeneralNeed a Code to Receive Calls Using External Fax Model Pin
shirin.105-Dec-08 1:43
shirin.105-Dec-08 1:43 
Generaltapi events stop reciving events... Pin
altarribage29-Oct-08 6:23
altarribage29-Oct-08 6:23 
GeneralRe: tapi events stop reciving events... Pin
Bishoy Demian1-Nov-08 19:58
Bishoy Demian1-Nov-08 19:58 
GeneralTTERMINAL namespace Pin
joshi aniruddha25-Sep-08 19:08
joshi aniruddha25-Sep-08 19:08 
GeneralNo incoming calls are notifed Pin
Yasser Daheek22-Sep-08 9:20
Yasser Daheek22-Sep-08 9:20 
QuestionTAPI and fax Pin
stefkhel7-Sep-08 5:36
stefkhel7-Sep-08 5:36 
QuestionHow get sound on call pc to phone using h.323 Pin
Md5723519-Aug-08 6:17
Md5723519-Aug-08 6:17 
GeneralTelephony Application Programming Interface (TAPI) functionality is not supported from managed code Pin
beat.kiener9-Jul-08 22:06
beat.kiener9-Jul-08 22:06 
GeneralVirtual Caller ID Pin
ismailwissam25-Jun-08 3:27
ismailwissam25-Jun-08 3:27 
Newssupport for the article Pin
Bishoy Demian14-Jun-08 12:01
Bishoy Demian14-Jun-08 12:01 
QuestionIs there a identifer for each call in TAPI? Pin
Carsten Giesen8-Jun-08 21:16
Carsten Giesen8-Jun-08 21:16 
GeneralStart project in VB.Net 2005 [modified] Pin
Carsten Giesen5-Jun-08 6:05
Carsten Giesen5-Jun-08 6:05 
GeneralEvent and Disconnection Problem Pin
RoSchVB.NET1-Apr-08 6:18
RoSchVB.NET1-Apr-08 6:18 
GeneralError Pin
Loops697228-Mar-08 5:22
Loops697228-Mar-08 5:22 
Questionvs 2005 Pin
ameen55521-Mar-08 0:37
ameen55521-Mar-08 0:37 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.