Click or drag to resize
TapiLine Class
Represents a telephony line device.
Inheritance Hierarchy
SystemObject
  Traysoft.AddTapiTapiLine

Namespace: Traysoft.AddTapi
Assembly: Traysoft.AddTapi (in Traysoft.AddTapi.dll) Version: 6.0.0.1110
Syntax
public class TapiLine

The TapiLine type exposes the following members.

Properties
  NameDescription
Public propertyAddresses
Gets a list of addresses available on the line.
Public propertyAudioInputBufferSize
Gets or sets the size of the audio input buffer, in milliseconds.
Public propertyAudioInputFormat
Gets or sets the format of audio input.
Public propertyAudioOutputBufferSize
Gets or sets the size of the audio output buffer, in milliseconds.
Public propertyAudioOutputFormat
Gets or sets the format of audio output.
Public propertyAvailableMediaModes
Indicates which media types (modes) the line device supports.
Public propertyCalls
Gets a list of calls on the line.
Public propertyDeviceSpecificExtensionID
Gets an identifier of the device specific extension supported by the line device.
Public propertyDeviceSpecificExtensionVersion
Gets negotiated version of the device specific extension in use on the line.
Public propertyDeviceSpecificInfo
Gets device specific information about the line device.
Public propertyDeviceStatus
Gets the current status of the line device.
Public propertyDisconnectOnBusy
Specifies if calls on the line should be automatically disconnected when a busy signal is detected.
Public propertyIsOpen
Indicates whether the line has been opened for incoming or outgoing calls.
Public propertyMaxNumActiveCalls
Gets the maximum number of calls that can be active on the line.
Public propertyName
Gets the name of the line.
Public propertyNoAnswerTimeout
Gets or sets the number of seconds AddTapi.NET should wait for an answer on outgoing calls.
Public propertyOpenMediaModes
Indicates for which media types (modes) the line device is currently open.
Public propertyPermanentID
Gets the permanent ID of the line.
Public propertyProviderInfo
Gets the Telephony Service Provider (TSP) information for the line.
Public propertyRingsToAnswer
Gets or sets the number of rings AddTapi.NET should wait before answering incoming calls.
Public propertySpeechRate
Gets or sets the rate of speech on the line.
Public propertyCode exampleSpeechVoice
Gets or sets text-to-speech voice to be used for text synthesis on the line.
Public propertySpeechVolume
Gets or sets the volume of speech on the line.
Public propertySupportsVoice
Indicates whether the line suppots voice functions.
Public propertySwitchInfo
Gets the switch (PBX) information for the line.
Public propertyWaitForCallerID
Indicates whether AddTapi.NET should wait for Caller ID to arrive before reporting or answering incoming calls.
Top
Methods
  NameDescription
Public methodClose
Closes the line. Closing the line stops monitoring of incoming calls on the line.
Public methodDeviceSpecific(Byte, TapiAddress, TapiCall, Int32)
Provides access to device specific functionality.
Public methodCode exampleDeviceSpecific(Object, TapiAddress, TapiCall, Type)
Provides access to device specific functionality.
Public methodDeviceSpecificFeature(Byte, UInt32, Int32)
Provides access to device specific features.
Public methodCode exampleDeviceSpecificFeature(Object, UInt32, Type)
Provides access to device specific features.
Public methodCode exampleDial(String, Boolean)
Dials an outgoing call on the line.
Public methodCode exampleDial(String, Boolean, TapiMediaMode)
Dials an outgoing call on the line using specified media mode.
Public methodCode exampleDial(String, Boolean, TapiMediaMode, String)
Dials an outgoing call on the line using specified media mode and originating address.
Public methodCode exampleDial(String, Boolean, TapiMediaMode, TapiAddress)
Dials an outgoing call on the line using specified media mode and originating TapiAddress.
Public methodCode exampleNegotiateDeviceSpecificExtensionVersion
Negotiates a version of the device specific extension to use with the line.
Public methodCode exampleOpen(Boolean, TapiCallHandler)
Opens the line. After the line is opened, it can be used to monitor incoming calls and/or to place outgoing calls.
Public methodCode exampleOpen(Boolean, TapiCallHandler, TapiMediaMode)
Opens the line for calls with selected media types (modes). After the line is opened, it can be used to monitor incoming calls and/or to place outgoing calls.
Public methodCode exampleOpen(Boolean, TapiCallHandler, TapiMediaMode, TapiCallPrivilege)
Opens the line for calls with selected media types (modes) and call privileges. After the line is opened, it can be used to monitor incoming calls and/or to place outgoing calls.
Public methodPickup(String, String)
Picks up a call ringing at the specified phone number or extension.
Public methodPickup(String, String, TapiAddress)
Picks up a call ringing at the specified phone number or extension.
Public methodCode exampleSetupConference
Sets up a conference call for the addition of the third party.
Public methodCode exampleSetupForwarding
Sets up forwarding of calls destined for the specified address on the line, according to the specified forwarding instructions.
Public methodToString
Overriden. Returns a string that contains the name of the line.
(Overrides ObjectToString.)
Public methodUnpark(String)
Retrieves the call parked at the specified phone number or extension.
Public methodUnpark(String, TapiAddress)
Retrieves the call parked at the specified phone number or extension.
Top
Remarks

Telephony system is represented as a set of TapiLine objects, each with one or more addresses. Addresses collection lists TapiAddress objects representing addresses (phone numbers or extensions) associated with the line. Most systems have one line for each phone number or extension, with one address on each line.

AddTapi.NET creates a TapiLine object for each telephony line device installed on the computer. The application can subscribe to LineAdded and LineRemoved events to receive notifications when a line device is added or removed.

See Also