LineGroup Runtime Properties

AppHandle

(Channel as Integer) Long

(TAPI only)

The TAPI handle for the application. Use this handle to make direct TAPI API calls from Visual Basic.

CalledId

(Channel as Integer)String

The Called ID (or DNIS) as supplied by the driver for the call on this channel.

CallerId

(Channel as Integer) String

Provides the calling number (ANI) received by the CallerId hardware.

Analog lines

When using CallerID service, ensure that RingsToAnswer is set to 2 or more to ensure that the CallerID information is received.

Digital lines

On T1 and other digital lines, the complete digit string received from the telco is loaded into this property, which may include DNIS and ANI digits. The number and type of digits provided on a T1 line is usually specified when ordering the service from the telephone company.

EXAMPLE

To access the caller id:

Dim CallerID As String

CallerID = LineGroup1.CallerID(e.channel)

CalledName

(Channel as Integer) String

(TAPI only)

The name of the called party.

CallerName

(Channel as Integer) String

Provides the calling name as received.

CallHandle

(Channel as Integer) Long

(TAPI only)

The TAPI handle for the call on this channel. Use this handle to make direct TAPI API calls from Visual Basic.

CallOrigin

(Channel as Integer) vbvCallOriginConstants

(TAPI or Dialogic ISDN (DPNSS and QSIG) only)

The origin of the call.See vbvCallOriginConstants.

CallReason

(Channel as Integer) vbvCallReason

(TAPI or Dialogic ISDN (DPNSS, QSIG, Euro) only)

The reason for the call. See vbvCallReasonConstants.

Channels

Integer

Unlike most runtime properties, Channels is not an array variable, but is useful only at runtime. It returns the total number of channels available in the system. It is valid after the drivers are loaded, which is after StartSystem has been called.

ChannelService

(channel As Integer) As vbvChannelServiceStatus

Set the state of the VBVoice channels.

The possible channels states are:

vbvChannelServiceUnknown

State not initialized

vbvChannelInService

Informs the driver that host is ready to receive and send a messages

vbvChannelOutOfService

Informs the driver that host is not ready to receive or send messages

vbvChannelMaintenance

Informs the host that normal outbound traffic is not allowed and that only inbound test calls can be made

When VBVoice is started, all channels are set to the InService state.

NOTE: The ChannelService functionality is not available on some cards and protocols. To find out if ChannelService is available on your cards, check the Dialogic documentation for the respective card, un the section on gc_SetChanState( ).

ConnectedID

(Channel as Integer) String

(TAPI only)

The ConnectedId as supplied by TAPI.

ConnectedName

(Channel as Integer)String

(TAPI only)

The ConnectedName as supplied by TAPI.

CurrentControl

(Channel as Integer) Control

Specifies the control that is currently processing the call on the channel. This property is read-only. Use this property to access proper�ties within the control- for instance CurrentControl(channel).Digits(channel) if the control is a GetDigits control. Visual Basic generates a trappable error if the control does not support the requested property.

EXAMPLE

Dim controlname as string

controlname = LineGroup1.CurrentControl(channel).Name

Duration

(Channel as Integer)    Date

Returns the duration of the call as a Date/Time, timed from the StartTime property. Note the duration is timed from the beginning of the last call in this channel, even if that call has terminated.

DurationSecs

(Channel as Integer)    Long

Returns the duration of the call in seconds, timed from the StartTime property. Note the duration is timed from the beginning of the last call in this channel, even if that call has terminated

GlobalTone

(Channel as Integer)    Long

This property is used to read the ID of the Global Tone detected by the Dialogic card. The global tones IDs are integer numbers, starting with 1.

For more information, please refer to Global Tones Handling.

GotoNode

(Integer)

This property will transfer a call to another control. See GotoNode.

LineHandle

(Channel as Integer)   Long

(TAPI only)

The TAPI handle for this channel. Use this handle to make direct TAPI API calls from Visual Basic.

LineNames

(Channels as Integer)    String

Returns the name of each line. For TAPI this is the line name, otherwise it is a descriptive name, such as Dialogic Analog B1C1.

LineStatus

(Channel as Integer)    vbvLineStatusConstants

Returns the status of the channel. Possible values are:

idle

0

in conference

19

playing greeting

1

getting conference digit

20

waiting for digits

2

stopped - max errors

21

recording

3

stopped - no connection

22

playing delay recording

4

paused - waiting for digit

23

dialling

5

pots - wait for digit

24

unexpected event

6

pots - wait for call

25

delay

7

talker in conference

26

stopped - error

8

listener in conference

27

caller hung up

10

starting call

29

stopped - caller hung up

11

wait for VB in break mode

30

stopped - call complete

12

initializing

31

pre-call delay

13

sending fax

32

waiting for ring

14

receiving fax

33

inter-call delay

15

getting data

34

waiting for shutdown

16

updating data

35

waiting for dialtone

17

talking

36

waiting for channel stop

18

unknown

37

MaxCallTime

(Channel as Integer)   Integer

This property can be used to set a maximum time for a specific channel. The new time affects only the current call until it leaves this control. If a call is not in progress at the time this property is set, it has no effect. See IMaxCallTime. If the time is set to 0, the call timer is disabled.

Mode

Mode can be set at runtime in addition to setting the initial state of a line. See Mode.

OutDialParam

This property is used by slave applications that do outdial or bridging. When the slave calls GrabChannel it can pass a user-defined string. Later when the grabbed channel exits the LineGroup control, the value of OutDialParam for that channel is the string that was passed to GrabChannel. OutDialParam is used to pass information to outdial channels.

PlaySpeed

(Channel as Integer)    Integer

The PlaySpeed property allows control over the speed at which the prompts are played by the voice card. The property accepts values from -10 to +10. The default setting is 0. This new speed will apply only to the calls on this channel.

EXAMPLE

LineGroup1.PlaySpeed(Channel) = -5

PlayVolume

(Channel as Integer)    Integer

The PlayVolume property sets the volume level on the voice card for the specified channel. The property accepts values from -10 to +10. The default setting is 0. This volume will apply to all calls on this channel. The volume can also be set in both the PlayMsgs Control and PlayGreeting Control from digit input, but the volume when set by these controls is restored on exit from the control.

EXAMPLE

LineGroup1.PlayVolume(Channel) = -5

PreviousControl

(Channel as Integer)    Control

Specifies the control that was processing the call on the channel, prior to the current control. This information is useful when the call is stopped by a MaxCallTime timeout and the status prior to the timeout is required. This property is read-only. Use this property to access proper�ties in the same way as the CurrentControl property.

RawCallInfo

(Channel As Integer) String

(Dialogic ISDN only)

Used in the Ring event to provide the call setup information as raw hex bytes, allowing the programmer access to specific call data.

This property is applicable to ISDN only. The data is the result of calling gc_GetCallInfo( ) function, which retrieves information associated with the call. It contains unformatted user-to-user Information Elements (IEs) retrieved in CCITT format. The IEs are returned as raw data and must be parsed and interpreted by the application. Refer to the Dialogic documentation for more information.

RedirectionID

(Channel as Integer) String

(TAPI or Dialogic ISDN (DPNSS, QSIG, Euro) only)

The RedirectionID as supplied by TAPI.

RedirectionName

(Channel as Integer) String

(TAPI or Dialogic ISDN (DPNSS, QSIG) only)

The RedirectionName as supplied by TAPI.

RedirectingID

(Channel as Integer) String

(TAPI or Dialogic ISDN (DPNSS, QSIG) only)

The RedirectingID as supplied by TAPI.

RedirectingName

(Channel as Integer)String

(TAPI or Dialogic ISDN (DPNSS, QSIG) only)

The RedirectingName as supplied by TAPI.

StartTime

(Channel as Integer) Date

Returns the time of the call start, which is when the line goes offhook for an incoming call, or when the call exits the Start node for an outgoing call.

UseSpeakerVerification

(Channel as Integer) Boolean

(Nuance only.)

This property allows the VB program to set the UseSpeakerVerification flag on a per-call basis. The NewValue may be True or False.

The UseSpeakerVerification flag indicates if the call uses speaker verification functionality, which requires Nuance to be running in a different mode: recognition-and-verification (as opposed to recognition-only). This allows the application designer to make a more efficient use of Nuance verification and recognition licensees.

At the beginning of each call, the UseSpeakerVerification flag is set to the current value of the IUseSpeakerVerification property. VBVoice checks the flag when allocating a Nuance engine for the call, which is done in the first speech recognition control (VerifySpeaker , VoiceRec, VoiceCommands, or DynGrammar). Once allocated, the engine mode cannot be changed for the duration of the call.

For more information, please see the description for the VerifySpeaker control.

Read more about LineGroup control.