3.1 Obtaining a Voice Handle and Closing a Voice File

3.2 Playing

3.3 Recording

3.4 Stopping

3.5 Querying

3.6 Defining Current Message and Current Position

3.7 Editing Voice Messages

3.8 Converting Text Strings to Message Lists

3.9 Creating and Editing Message Text

3.10 Performing Other Voice Functions

3.1 Obtaining a Voice Handle and Closing a Voice File

Function	S/A1	Description
vceOpenFile	S	Opens a voice file and returns a voice handle. The file can be opened for play only or both play and record.
vceCreateFile	S	Creates a new file of a specified type.
vceOpenMemory	S	Assigns a voice handle to a range of memory.
vceAssignHandle	S	Associates a voice handle with a file (or device) that is already opened.
vceClose	S	Closes a voice file or other voice object.

1 Synchronous or Asynchronous

3.2 Playing

Function	S/A1	Description
vcePlay	A	Starts playing from the current position in the current message. This function can be used to resume playing after stopping a message in the middle.
vcePlayList	A	Starts playing from the beginning of the first message in a list of messages. It allows a message to be built from a library of words or phrases contained in a voice file. This function allows you to play a sequence of messages with no delay between messages.
vcePlayMessage	A	Plays one message from a specified voice object.
vceSetPlayGain	S	Changes the volume (loudness) of message playback by adjusting the amplification, or gain, applied to the message being played.
vceSetPlaySpeed	S	Changes the current play speed to a specified rate.

1 Synchronous or Asynchronous

The vceplay demonstration program demonstrates playing voice files. Refer to Section 5.4, Voice File Play: vceplay for more information.

3.3 Recording

Function	S/A1	Description
vceRecord	A	Starts recording at the current position in the current message.
vceRecordMessage	A	Records a message in an open voice object.

1 Synchronous or Asynchronous

The vcerec demonstration program demonstrates recording voice files. Refer to Section 5.5, Voice File Record: vcerec for more information.

3.4 Stopping

vceStop stops the currently active play or record. This function is asynchronous.

3.5 Querying

Function	S/A1	Description
vceGetCurrentList	S	Retrieves the list of messages comprising the current message.
vceGetCurrentSize	S	Retrieves the size, in milliseconds, of the current message.
vceGetEncodingInfo	S	Gets information about a voice encoding.
vceGetHighMessageNumber	S	Returns the highest message number in use in the voice object.
vceGetMessageSize	S	Returns the size in milliseconds of the specified message.
vceGetOpenInfo	S	Gets information about an open voice object.
vceGetContextInfo	S	Gets the current Voice Message service status of the specified context.
vceGetUniqueMessageNumber	S	Gets the lowest available (empty) message in the file.
vceGetWaveInfo	S	Gets wave header information for a given encoding value.

1 Synchronous or Asynchronous

The vceinfo demonstration program demonstrates displaying information about a voice file. Refer to Section 5.3, Voice File Information: vceinfo for details.

3.6 Defining Current Message and Current Position

Function	S/A1	Description
vceSetCurrentList	S	Defines the current message to be a list of messages.
vceSetCurrentMessage	S	Defines the current message.
vceSetPosition	S	Sets the current position in the current message.

1 Synchronous or Asynchronous

3.7 Editing Voice Messages

Function	S/A1	Description
vceConvertMessage	S	Copies a message from one voice object to another. The encoding and/or amplitude of the message is translated.
vceCopyMessage	S	Creates or replaces a message in a destination object with a copy of a message in a source object. The source and destination objects must have the same encoding.
vceErase	S	Removes a specified number of milliseconds of data at the current position in the current message.
vceEraseMessage	S	Removes an entire message from a specified voice object.
vceRead	S	Reads data at the current position in the current message.
vceWrite	S	Writes data at the current position in the current message.

1 Synchronous or Asynchronous The vcecopy demonstration program demonstrates copying voice messages from one file to another. Refer to Section 5.2, Voice File Copy/Convert Program: vcecopy for details.

3.8 Converting Text Strings to Message Lists

Function	S/A1	Description
vceBuildPromptList	S	Builds a list of message numbers based on the specified prompt rule table entry point and variable text.
vceLoadPromptRules	S	Reads the specified prompt rules table into memory.
vceUnloadPromptRules	S	Releases resources associated with the specified prompt rules.

1 Synchronous or Asynchronous

3.9 Creating and Editing Message Text

Message text is a descriptive string or other data that can be attached to a message in a NMS VOX file. Use the following functions to write and copy message text:

Function	S/A1	Description
vceCopyMessageText	S	Copies message text from one voice message to another voice message.
vceReadMessageText	S	Reads the message text for a specified voice message in a VOX file.
vceWriteMessageText	S	Writes message text for a specified voice message in a NMS VOX file.

1 Synchronous or Asynchronous

3.10 Performing Other Voice Functions

Function	S/A1	Description
vceDefineMessages	S	Defines message boundaries in a flat (unformatted) file or memory block.
vceSetWaveInfo	S	Loads a new entry in the WAVE encoding table.

1 Synchronous or Asynchronous