VBVFrame Initial Setup Properties

BuildNumOCX

Integer

This property returns the build number of the main VBVoice OCX. This OCX contains implementation of most VBVoice controls.

BuildNumVoiceInterface

Integer

This property returns the build number of the currently loaded Voice Interface Library (VIL).

ConfigFile

(String)

This property is used to define an application-specific INI file. The property should be set to the name of the INI file, such as TaxiApp.ini. This file should be located in the same directory as vbvoice.ini . VBVoice will look for settings first in the application-specific INI file and if a setting is not found, then vbvoice.ini is read. The default value is "" empty string, which means no application-specific INI file will be used.

Application-specific INI files are typically used on machines with multiple VBVoice applications. Every application-specific INI file contains the settings particular for that application. Common settings, such as VoiceCard Type, are put only in vbvoice.ini.

DateOrder

(vbvDateOrderConstants)

DateOrder is a project-wide setting that defines the order in which the component parts of dates are vocalized. Note that the components of the date to be vocalized (day, month, year, weekday) and the format (numeric month, month name, etc.) are defined by each individual phrase.

Possible values:

Note that this setting only affects the way that the date is vocalized and does not affect the required formatting of the string when passed to a phrase that requires a date string.

LangProgID

(String)

If LanguageID is set to VBVCustomLang, then the LangProgID is set to the name of a custom language implementation. See the Language control for more details.

If there is more than one frame in the project, each frame returns the same value for these properties and setting these properties affects all frames.

LanguageID

(vbvLanguageConstants)

LanguageID is a project wide setting that specifies the concatenation rules for vocalizing numbers. VBVoice has built-in rules for several languages. Support for dynamic language setting, multiple simultaneous languages, and other languages can be added using the Language control.

See vbvLanguageConstants for all possible values.

LanguageVer

(vbvLanguageVerConstants)

This property defines whether this project uses the release 2.5 compatible voice prompts, or the release 3.0 (and up) compatible prompts, which offer a wider range of languages and better articulation of numbers.

LogDirectory

String

The log directory can be set on a per-project basis. On new projects, the default directory (as set in the VBVOICE.INI file) is used.

If there is more than one frame in the project, each frame returns the same value for this property and setting this property affects all frames. If a relative path name is used (such as the default logs), the path is added to the project directory, for example, "C:\Program Files\Pronexus\VBVoice\Logs".

NuancePackages

(String)

(Not supported by HMP)

This property allows the Nuance packages in use for a particular project to be saved with that project. More than one package can be used. The packages should have a fully qualified path and should be separated by semicolons or commas.

NOTE: In the previous versions of VBVoice, the Nuance packages were set through the VBVOICE.INI file in the Nuance section. The INI settings still work for backward compatibility but their use is not recommended. Do not use the INI settings and the Nuance Packages property at the same time.

ScriptSize

(Integer)

Used in conjunction with the language control to manage VAP files in multiple languages. It restricts the number of characters that VBVoice uses when searching for phrases in VAP files. See Language Control.

SlaveName

(String)

This property is only used by slave applications (It specifies a name for the slave application, which must be unique from all other slave applications.

SlaveType

(Integer)

This property is used to specify a master or slave application (see Modularity). A value of No means this is a master application. Yes means it is a slave application. Auto means the application reads the Vbvoice.ini file, and if the [Voicecard] setting type equals Slave then the application is a slave. Auto is useful when the application needs to be switched into a slave after it has been compiled.

TimeFormat

(vbvTimeFormatConstants)

TimeFormat is a project wide setting that specifies whether times are vocalized in 12 hour or 24 hour time (for example, eleven twenty-two PM. or twenty-three twenty-two).

Possible values:

This setting only affects the way that the date is vocalized, and it does not affect the required formatting of the string when passed to a phrase that requires a date string.

Transfer

(Object)

The transfer object provides a configurable list of string properties that can be used to pass data into VBVoice controls at runtime. For example, if the properties MyProp1 and MyProp2 are defined at design time using the Transfer property page, these properties are available in the control list window to be copied into dialog fields that accept control properties. These properties can be written to by Visual Basic code using this syntax:

VBVFrame1.Transfer.MyProp1(channel) = 12345

If a phrase is configured in a greeting such as:

SayNumber %VBVFrame1.MyProp1%

Then the system vocalizes the number 12345.

Every frame control can have a different set of properties. Controls can access frame transfer properties in any frame, not just the containing frame. The Transfer properties can be set at design time using the Transfer Properties page.

NOTE: VBVoice has a maximum of 80 transfer properties (75 in a slave application).

UsesASR

(Boolean)

(Not supported by HMP)

This property specifies whether the application uses ASR. It must be set to true if any ASR is used. If set to false, no ASR licenses are grabbed at startup, speeding up the application startup time.

UsesTTS

(Boolean)

This property specifies whether the application uses TTS. It must be set to true if any TTS is used. If set to false, no TTS licenses are grabbed at startup, speeding up the application startup time.

VoiceDirectory

(String)

This property is used to find all voice files for which a complete path is not specified. If a file is not found in the project directory, then the default VBVoice system directory is searched. The system directory is the directory specified by the Voice setting in VBVOICE.INI . This is the default location for all system voice files (e.g. vbvoice30.vap). The voice directory can be set on a per-project basis. The default setting for the voice directory is the same as the system directory.

If there is more than one frame in the project, each frame will return the same value for this property, and setting this property affects all frames. If a relative path name is used (such as examples\inventory\), the path is added to the project directory, for example c:\program files\Pronexus\VBVoice\ examples\inventory.

If a fixed directory is used (for example, c:\myapp), this path is used both in the design environment and in the .EXE. If a relative path name is used, the path name is appended to the value of Current Directory before use. This property can be set at design time using the General property page.

Read more about VBVFrame control.