SIPX_MEDIA_INFO Struct Reference

#include <sipXtapiEvents.h>

---

Detailed Description

Media event information structure.

This information is passed as part of the sipXtapi callback mechanism. Based on the SIPX_EVENT_CATEGORY, the application developer should cast the pInfo member of your callback to the appropriate structure.

See also:

SIPX_EVENT_CALLBACK_PROC

SIPX_EVENT_CATEGORY

Data Fields
size_t	nSize
	Size of the structure.
SIPX_MEDIA_EVENT	event
	Media event identifier.
SIPX_MEDIA_CAUSE	cause
	Media cause identifier.
SIPX_MEDIA_TYPE	mediaType
	Media type: Either MEDIA_TYPE_AUDIO or MEDIA_TYPE_VIDEO.
SIPX_CALL	hCall
	Associate call (or SIPX_CALL_NULL if not associated with a call).
SIPX_CODEC_INFO	codec
	Negotiated codec; only supplied on MEDIA_LOCAL_START and MEDIA_REMOTE_START events.
int	idleTime
	Idle time (ms) for SILENT events; only supplied on MEDIA_REMOTE_SILENT events.
SIPX_TONE_ID	toneId
	DTMF tone received from remote party; only supplied on MEDIA_REMOTE_DTMF_START and MEDIA_REMOTE_DTMF_STOP events).

---

Field Documentation

size_t SIPX_MEDIA_INFO::nSize

Size of the structure.

SIPX_MEDIA_EVENT SIPX_MEDIA_INFO::event

Media event identifier.

See SIPX_MEDIA_EVENT for more information.

SIPX_MEDIA_CAUSE SIPX_MEDIA_INFO::cause

Media cause identifier.

See SIPX_MEDIA_CAUSE for more information.

SIPX_MEDIA_TYPE SIPX_MEDIA_INFO::mediaType

Media type: Either MEDIA_TYPE_AUDIO or MEDIA_TYPE_VIDEO.

SIPX_CALL SIPX_MEDIA_INFO::hCall

Associate call (or SIPX_CALL_NULL if not associated with a call).

SIPX_CODEC_INFO SIPX_MEDIA_INFO::codec

Negotiated codec; only supplied on MEDIA_LOCAL_START and MEDIA_REMOTE_START events.

int SIPX_MEDIA_INFO::idleTime

Idle time (ms) for SILENT events; only supplied on MEDIA_REMOTE_SILENT events.

SIPX_TONE_ID SIPX_MEDIA_INFO::toneId

DTMF tone received from remote party; only supplied on MEDIA_REMOTE_DTMF_START and MEDIA_REMOTE_DTMF_STOP events).

Note: Only out-of-band DTMF is supported (not in-band DTMF or dialtone detection, etc.)

---

The documentation for this struct was generated from the following file:

• sipXtapiEvents.h

---