The VoipMediaEngine class is the primary class for accessing all the
capabilities of the LanScape VOIP Media Engine.
The VoipMediaEngine..::.TxIvrChannel type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | VoipMediaEngine..::.TxIvrChannel | Initializes a new instance of the VoipMediaEngine..::.TxIvrChannel class |
Methods
| Name | Description | |
|---|---|---|
| CloseTxIvrChannel |
The CloseTxIvrChannel API procedure closes a previously opened phone line IVR channel. After calling
this procedure, the IVR handle value is invalid.
|
| GetNumIvrTxBuffers |
Call the GetNumIvrTxBuffers API procedure to determine how many phone line transmit buffers are available for use.
|
| GetTxIvrSampleBlockSize |
The GetTxIvrSampleBlockSize API procedure is used by application software to determine the transmit
sample block size the phone line requires.
|
| OpenTxIvrChannel |
The OpenTxIvrChannel API procedure allows application software to open a transmit IVR channel to
the specified phone line. By opening a transmit IVR channel to the phone line, the application can stream
sampled audio data directly to the phone line.
|
| SetTxIvrBufferEvent |
The SetTxIvrBufferEvent API procedure allows the telephony engine to signal the application software when
transmit buffers are available.
|
| SetTxIvrDataType |
The SetTxIvrDataType API procedure allows the user application to specify the format and rate of the
data it will send directly to the phone line.
|
| StopIvrTransmit |
The StopIvrTransmit API procedure should be called by application software to immediately stop the streaming of
data to the phone line. Also, calling this procedure will force the phone line to dump all queued up transmit
audio data it may have.
|
| TransmitInCallIvrData |
The TransmitInCallIvrData API procedure should be called by application software to transmit data out the
phone line when the call is active (i.e. When the phone line is in the SipInCall state).
|
| TransmitOnHoldIvrData |
The TransmitOnHoldIvrData API procedure should be called by application software to transmit data out
the phone line when the call has been placed on hold (i.e. your software put the call on hold).
|
| WaitForIvrTransmitComplete |
Call the WaitForIvrTransmitComplete API procedure before closing the IVR transmit channel of the phone
line. Doing so will ensure that all queued audio sample data gets transmitted out the line before it gets closed.
|
Fields
| Name | Description | |
|---|---|---|
 | ChannelNumber |
The transmit IVR channel number.
Do not modify this value directly.
|
| hIvrTxHandle |
The native transmit IVR handle.
Do not modify this value directly.
|
| MediaEngine |
The media enigne instance.
Do not modify this value directly.
|
| PhoneLine |
The zero based phone line index.
Do not modify this value directly.
|
| pManagedTxIvrChannelInstance |
A pseudo pointer to this class instance.
Do not modify this value directly.
|
See Also
