NMS Logo

Voice Message Service Developer's Reference Manual

P/N 6422-16
Version


Table of Contents Index NMS Glossary Previous Page Next Page Version


Table of Contents

1 Overview of the Voice Message Service

1.1 Introduction
1.2 Voice Message Service Features
1.2.1 Voice File Types
1.2.2 Voice Encoding Formats
1.2.3 Messages
1.3 Setting Up the Natural Access Environment
1.3.1 Initializing Natural Access
1.3.2 Creating Event Queues and Contexts
1.3.3 Opening Services
1.3.4 Linking with the Voice Message Service

2 Using the Voice Message Service

2.1 Obtaining a Voice Handle
2.2 Defining Current Message and Current Position
2.3 Playing
2.3.1 Play Functions
2.3.2 Playing a Sequence of Messages
2.3.3 Play Completion Reasons
2.3.4 Adjusting Volume and Speed
2.3.5 Play Parameters
2.4 Recording
2.4.1 Record Functions
2.4.2 Record Completion Reasons
2.4.3 Resizing Messages
2.4.4 Record Parameters
2.5 Play and Record States
2.6 Stopping
2.6.1 Using DTMF to Terminate Play or Record
2.7 Retrieving Context Status
2.8 Retrieving Voice Object Information
2.9 Editing Voice Messages
2.9.1 Copying and Converting Messages
2.9.2 Erasing Messages
2.9.3 Reading and Writing Messages
2.10 Converting Text Strings to Message Lists
2.10.1 How the Prompt Builder Works
2.10.2 Prompt Rules Table

3 Function Summary

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

4 Alphabetical Function Reference

4.1 Using the Function Reference
vceAssignHandle
vceBuildPromptList
vceClose
vceConvertMessage
vceCopyMessage
vceCopyMessageText
vceCreateFile
vceCreateMemory
vceDefineMessages
vceErase
vceEraseMessage
vceGetContextInfo
vceGetCurrentList
vceGetCurrentSize
vceGetEncodingInfo
vceGetHighMessageNumber
vceGetMessageSize
vceGetOpenInfo
vceGetUniqueMessageNumber
vceGetWaveInfo
vceLoadPromptRules
vceOpenFile
vceOpenMemory
vcePlay
vcePlayList
vcePlayMessage
vceRead
vceReadMessageText
vceRecord
vceRecordMessage
vceSetCurrentList
vceSetCurrentMessage
vceSetPlayGain
vceSetPlaySpeed
vceSetPosition
vceSetWaveInfo
vceStop
vceUnloadPromptRules
vceWrite
vceWriteMessageText

5 Demonstration Programs and Utilities

5.1 About the Demonstration Programs and Utilities
5.2 Voice File Copy/Convert Program: vcecopy
5.3 Voice File Information: vceinfo
5.4 Voice File Play: vceplay
5.5 Voice File Record: vcerec
5.6 Make Prompt: mkprompt
5.7 Test Prompt: testpmpt
5.8 VOX File Information: voxinfo

Appendix A Errors, Events, and Reason Codes

About Voice Message Service Errors
Alphabetical Error Summary
Numerical Error Summary
Events
Reason Codes

Appendix B Voice Message Service Parameters

About Voice Message Service Parameters
VCE.PLAY
VCE.RECORD

Appendix C VOX File Format

Introduction to the VOX File Format
VOX File Format
Index Structure
Summary of Frame Sizes

Appendix D Using the Prompt Builder

Prompt Builder Runtime Files
Prompt Builder Source Programs
Using the Prompt Rules Table
Prompt Rules Table Processing
CONVERT
FIND
OUTPUT
TEST

Appendix E Voice Encoding Formats

Encoding Descriptions
Encoding and Wave Information


Table of Contents Index NMS Glossary Previous Page Next Page Version


Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com
Copyright © 2001, Natural MicroSystems, Inc. All rights reserved.