(Page 3 of 3 in this chapter) Version

VCE.RECORD

Dependent Functions

vceRecord, vceRecordMessage

Field Name

Type

Default

Units

Description

AGCenable

DWORD

0

Mask

Flag to enable automatic gain control (AGC). Set to 1 to enable AGC and 0 to disable it.

beepampl

INT32

-20

dBm

The amplitude of the record beep tone. The valid range for AG boards and CG boards is -54 to 3. The valid range for QX boards is -90 to 0.

beepfreq

DWORD

1000

Hz

The frequency of the record beep tone. Use zero (0) to disable the beep. The valid range for AG boards and CG boards is 200 to 3600. The valid range for QX boards is 0 to 4000.

beeptime

DWORD

200

ms

The duration of the record beep tone. 0 disables the beep. The valid range for AG boards and CG boards is 0 to 65535. The valid range for QX boards is 0 to 8000.

DTMFabort

DWORD

0xffff

Mask

Allows you to control which DTMFs abort record. A value may be formed by ORing any of the following values:

Digit
0
1
2
3
4
5
6
7
8
9
*
#
A
B
C
D

Name
VCE_DIGIT_0
VCE_DIGIT_1
VCE_DIGIT_2
VCE_DIGIT_3
VCE_DIGIT_4
VCE_DIGIT_5
VCE_DIGIT_6
VCE_DIGIT_7
VCE_DIGIT_8
VCE_DIGIT_9
VCE_DIGIT_STAR
VCE_DIGIT_POUND
VCE_DIGIT_A
VCE_DIGIT_B
VCE_DIGIT_C
VCE_DIGIT_D

Value
0x0001
0x0002
0x0004
0x0008
0x0010
0x0020
0x0040
0x0080
0x0100
0x0200
0x0400
0x0800
0x1000
0x2000
0x4000
0x8000

gain

INT32

0

dB

The gain applied to the signal before it is encoded. The valid range for AG boards and CG boards is -54 to 24. If AGC is enabled, this is the initial gain when recording starts. The valid range for QX boards is -42 to 48.

novoicetime

DWORD

5000

ms

The maximum length of silence at the beginning of a recording before recording will be stopped with CTA_REASON_NO_VOICE. Use zero (0) to disable this timer. The valid range for AG boards, CG boards, and QX boards is 0 to 65535.

silenceampl

INT32

-45

dBm

The maximum signal level that is considered to be silence. The valid range for AG boards and CG boards is -51 to -15. The valid range for QX boards is -45 to 0.

silencetime

DWORD

3000

ms

The maximum length of silence after audio energy has been detected before record will be stopped with CTA_REASON_VOICE_END. Use zero (0) to disable this timer. The valid range for AG boards, CG boards, and QX boards is 0 to 65535.

Note: The parameters presented in this table override the corresponding fields in the ADI.RECORD category. ADI.RECORD contains additional fields you can use to control automatic gain control (AGC) characteristics.

Field Name	Type	Default	Units	Description
AGCenable	DWORD	0	Mask	Flag to enable automatic gain control (AGC). Set to 1 to enable AGC and 0 to disable it.
beepampl	INT32	-20	dBm	The amplitude of the record beep tone. The valid range for AG boards and CG boards is -54 to 3. The valid range for QX boards is -90 to 0.
beepfreq	DWORD	1000	Hz	The frequency of the record beep tone. Use zero (0) to disable the beep. The valid range for AG boards and CG boards is 200 to 3600. The valid range for QX boards is 0 to 4000.
beeptime	DWORD	200	ms	The duration of the record beep tone. 0 disables the beep. The valid range for AG boards and CG boards is 0 to 65535. The valid range for QX boards is 0 to 8000.
DTMFabort	DWORD	0xffff	Mask	Allows you to control which DTMFs abort record. A value may be formed by ORing any of the following values:
				Digit 0 1 2 3 4 5 6 7 8 9 * # A B C D	Name VCE_DIGIT_0 VCE_DIGIT_1 VCE_DIGIT_2 VCE_DIGIT_3 VCE_DIGIT_4 VCE_DIGIT_5 VCE_DIGIT_6 VCE_DIGIT_7 VCE_DIGIT_8 VCE_DIGIT_9 VCE_DIGIT_STAR VCE_DIGIT_POUND VCE_DIGIT_A VCE_DIGIT_B VCE_DIGIT_C VCE_DIGIT_D	Value 0x0001 0x0002 0x0004 0x0008 0x0010 0x0020 0x0040 0x0080 0x0100 0x0200 0x0400 0x0800 0x1000 0x2000 0x4000 0x8000
gain	INT32	0	dB	The gain applied to the signal before it is encoded. The valid range for AG boards and CG boards is -54 to 24. If AGC is enabled, this is the initial gain when recording starts. The valid range for QX boards is -42 to 48.
novoicetime	DWORD	5000	ms	The maximum length of silence at the beginning of a recording before recording will be stopped with CTA_REASON_NO_VOICE. Use zero (0) to disable this timer. The valid range for AG boards, CG boards, and QX boards is 0 to 65535.
silenceampl	INT32	-45	dBm	The maximum signal level that is considered to be silence. The valid range for AG boards and CG boards is -51 to -15. The valid range for QX boards is -45 to 0.
silencetime	DWORD	3000	ms	The maximum length of silence after audio energy has been detected before record will be stopped with CTA_REASON_VOICE_END. Use zero (0) to disable this timer. The valid range for AG boards, CG boards, and QX boards is 0 to 65535.

(Page 3 of 3 in this chapter) Version

Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com