The VoipMediaEngine class is the primary class for accessing all the capabilities of the LanScape VOIP Media Engine.

The VoipMediaEngine..::.PhoneLineRecord type exposes the following members.

Constructors

  NameDescription
VoipMediaEngine..::.PhoneLineRecord
Initializes a new instance of the VoipMediaEngine..::.PhoneLineRecord class

Methods

  NameDescription
Finalize
The Object's finalizer.
(Overrides Object..::.Finalize()()().)
StartPhoneLineRecording
The StartPhoneLineRecording procedure allows application software to start full duplex call recording for any specified phone line. All call recording details are handled internally and required no additional application intervention. Any RTP media data that enters or leaves the specified phone line will be processed and digitally mixed. The resulting audio data can then be presented to the application as sample blocks or written directly to a multimedia file.

To stop recording phone line audio application software should call the StopPhoneLineRecording API procedure.

Application software can use the VOIP Media Engine call recording capabilities in two distinct ways:

Recording portions of phone calls:

When a phone call is actively streaming RTP media, application software can start and stop call recording on any phone line at any time. If the application has specified to receive mixed sample blocks from the Media Engine, the application can process the audio sample blocks as required.

If application software has specified that multimedia sample data files be created, then a new sample file containing the recorded audio will be created every time call recording is turned on.


Recording all phone calls:

Application software can alternatively enable phone line recording once. This can be performed at any time after the media engine has been initialized. If a new call is initiated or received, the media engine will automatically start to record the phone line audio data when the call is actively sending and receiving RTP media data.

In this mode, application software can receive all recorded sample blocks directly or the media engine can create multimedia sample files for later playback. Call recording will then stop as soon as the phone call terminates.

If you initiate or receive another phone call, call recording will once again start automatically sending your application sample data blocks or creating another multimedia sample file.

StopPhoneLineRecording
The StopPhoneLineRecording procedure allows application software to stop phone line recording. The media engine will stop sending recorded sample blocks to the application (if applicable) and close the record sample file (if applicable).

If the application specified that the wave file format is to be used for recorded phone line audio, the wave file will be created when this API procedure is called. Until this API procedure is called, all recorded audio resides in a data file using raw PCM samples. The wave file will also be created as soon as the call terminates.

Fields

  NameDescription
MediaEngine
The media enigne instance. Do not modify this value directly.
PhoneLine
The zero based phone line index. Do not modify this value directly.
PhoneLineRecordingStarted
true if phone line recording has been started. Do not modify this value directly.
pManagedPhoneLineRecordingInstance
A pseudo pointer to this managed wrapper. Do not modify this value directly.
pUserPhoneLineRecordingProc_Mananged
An internal call back handler. Do not modify this value directly.
UserDefinedData_Mananged
Instance data passed to an internal call back handler. Do not modify this value directly.

See Also