Intel IP Media Server - page 36

36 IP Media Server for HMP Demo Guide — July 2005

Demo Details

Device CVoiceDevice

• Handles voice device operations, such

as playing, recording, tone detection,

and tone generation

• Holds CVoiceStateMachine

Note: The public functions in this class

should only be accessed by classes

inside the Voice module.

Init()

• Opens the voice device. If successful,

creates voice state machine.

Exit()

• Deletes the voice state machine from the

voice device

• Closes voice device

ProcessEvent()

• Processes voice device events

Connect()

• Allows IP device to listen to its receiving

timeslot

Play()

• Plays a vox file

OnPlayComplete()

• Replays a vox file when it has finished

playing

Record()

• Records voice to a vox file

GetDigits()

• Retrieves DTMF digits

GetDigitCount()

• Returns the number of retrieved DTMF

digits

GetDigitString()

• Returns retrieved DTMF string

Connect()

• Allows the voice device to listen to its

receiving timeslot

Disconnect()

• Allows voice device to unlisten to its

receiving timeslot

GetStoppedReason()

• Tells why a played voice file stops

GetDeviceHandle()

• Returns voice device handle

GetXmitSlot()

• Returns voice device transmit timeslot

SetReceiveSlot()

• Sets voice device receiving timeslot

Table8. Voice Module Classes (Continued)

Category Class Name Interface

Contents

Main IP Media Server for HMP Demo Guide July 2005 Contents Figures Tab le s Page Revision History This revision history summarizes the changes made in each published version of this document. Page About This Publication Purpose Intended Audience How to Use This Publication Related Information Page Page 2.1 Hardware Requirements Memory Requirements IP Endpoints 2.2 Software Requirements 3.1 Editing Configuration Files 3.1.1 Configuration File Location 3.1.2 Editing the IPMediaServer.cfg Configuration File Page Preparing to Run the Demo Sample Configuration File 3.2 Compiling and Linking 4.1 Starting the Demo 4.2 Demo Options Example 4.3 Using the Demo 4.3.1 Keyboard Commands 4.3.2 Using the Media Server Page Page Running the Demo Figure 1. Demo Voice Menu Flowchart Page 5.1 Files Used by the Demo 5.1.1 Demo Source Code Files Page Table4. Files in Modules Folder Used by the IP Media Server Demo (Continued) 5.1.2 PDL Files 5.2 Programming Model 5.2.1 Module Structure 5.2.2 EventRouter 5.2.3 Interfaces 5.2.4 Classes Table6. Application Classes (Continued) Table7. IP Module Classes Page Table7. IP Module Classes (Continued) Table8. Voice Module Classes Page Table8. Voice Module Classes (Continued) Table9. Fax Module Classes Table9. Fax Module Classes (Continued) 5.3 Threads 5.4 Initialization Keyboard Main Thread SRL Sub-Thread IP R4/GC Page 5.5 Event Handling 5.5.1 Event Mechanism 5.5.2 Handling Keyboard Input Events 5.5.3 Handling SRL Events 5.5.4 Handling Application Exit Events 5.6 Typical Scenario Call Offered Figure 6. Typical Scenario: Call Offered gc_extension( ) gc_listen( ) gc_AnswerCall( ) Play Prompts dx_getdig( ) dx_listen( ) Fax Mailbox Establish Fax Session gc_extension( ) gc_setUserInfo( ) gc_unlisten ( ) gc_setConfigData( ) Fax Session Established fx_sndfax( ) Fax Sent gc_listen( ) gc_extension ( ) gc_stop( ) Fax Session Closed Fax Complete Page Glossary Page Page Page Index A C D E M O P R S