ThbTapiCall.MonitorMedia
Unit: hbTapi

This property is used to enable and disable the detection of media types (modes) on the call. When a specified media type is detected, the ThbTapiLine.OnMediaMode event is called.

MonitorMedia has two members:

Active
MediaModes

Availability

Design-Time: None / Run-Time: Read, Write

Declaration

property MonitorMedia : ThbTapiCallMonitorMediaParams;

See Also

ThbTapiLine.OnMediaMode


Active (Boolean)

Set this property to True to begin the monitoring for media types. The monitoring can be invoked in any call state, a call's media type can typically only be detected while the call is in certain call states. These states can be device specific. The ThbTapiLine.OnMediaMode event fires when a specified media type is detected. Set this property to False to stop the monitoring. There is no need to set this property to false at the end of a call.

Remarks

In TAPI terms the lineMonitorMedia function is called. This functions works in an asynchronous manner. See the SyncMode property to read more about the handling of asynchronous functions.

Errors

Using this function may cause an EhbTapiError exception . Possible errors are:

LINEERR_INVALCALLHANDLE, LINEERR_OPERATIONUNAVAIL, LINEERR_INVALCALLSTATE, LINEERR_OPERATIONFAILED, LINEERR_INVALMEDIAMODE, LINEERR_RESOURCEUNAVAIL, LINEERR_NOMEM, LINEERR_UNINITIALIZED.

MediaModes (DWord)

Set this property to the media mode or modes that are to be monitored. This parameter uses one or more of the LINEMEDIAMODE_ Constants and is initialized with the value of ThbTapiLine.CallOptions.MonitorMedia.MediaModes.

Constant

Description

LINEMEDIAMODE_AUTOMATEDVOICE

Voice energy was detected on the call, and the voice is locally handled by an automated application such as with an answering machine application. When a service provider cannot distinguish between interactive and automated voice on an incoming call, it will report the call as interactive voice.

LINEMEDIAMODE_DATAMODEM

A data modem session on the call.

LINEMEDIAMODE_ADSI

An ADSI (Analog Display Services Interface) session on the call. ADSI enhances voice calls with alphanumeric information downloaded to the phone and the use of soft buttons on the phone.

LINEMEDIAMODE_DIGITALDATA

A digital data stream of unspecified format.

LINEMEDIAMODE_G3FAX

A group 3 fax is being sent or received over the call.

LINEMEDIAMODE_G4FAX

A group 4 fax is being sent or received over the call.

LINEMEDIAMODE_INTERACTIVEVOICE

Voice energy was detected on the call, and the call is handled as an interactive voice call with humans on both ends.

LINEMEDIAMODE_MIXED

A mixed session on the call. Mixed is one of the ISDN telematic services.

LINEMEDIAMODE_TDD

A TDD (Telephony Devices for the Deaf) session on the call.

LINEMEDIAMODE_TELETEX

A teletex session on the call. Teletex is one of the telematic services.

LINEMEDIAMODE_TELEX

A telex session on the call. Telex is one of the telematic services.

LINEMEDIAMODE_VIDEO

The media type of the call is video. (TAPI versions 2.1 and later)

LINEMEDIAMODE_VIDEOTEX

A videotex session on the call. Videotex is one the telematic services.

LINEMEDIAMODE_VOICEVIEW

The media type of the call is VoiceView. (TAPI versions 1.4 and later)

LINEMEDIAMODE_UNKNOWN

A media stream exists but its mode is not currently known and may become known later. This would correspond to a call with an unclassified media type. In typical analog telephony environments, an incoming call's media type may be unknown until after the call has been answered and the media stream has been filtered to make a determination.
If the unknown media-mode flag is set, other media flags can also be set. This is used to signify that the media is unknown but that it is likely to be one of the other selected media types.