Media event information structure. More...
#include <sipXtapiEvents.h>
Public Attributes | |
| size_t | nSize |
| Size of the structure. More... | |
| SIPX_MEDIA_EVENT | event |
| Media event identifier. More... | |
| SIPX_MEDIA_CAUSE | cause |
| Media cause identifier. More... | |
| SIPX_MEDIA_TYPE | mediaType |
| Media type: Either MEDIA_TYPE_AUDIO or MEDIA_TYPE_VIDEO. More... | |
| SIPX_CALL | hCall |
| Associate call (or SIPX_CALL_NULL if not associated with a call). More... | |
| SIPX_CODEC_INFO | codec |
| Negotiated codec; only supplied on MEDIA_LOCAL_START and MEDIA_REMOTE_START events. More... | |
| int | idleTime |
| For MEDIA_REMOTE_SILENT events contains idle time (ms). More... | |
| SIPX_TONE_ID | toneId |
| DTMF tone received from remote party; only supplied on MEDIA_REMOTE_DTMF event). More... | |
| const char * | deviceName |
| name of media device for MEDIA_INPUT_DEVICE_NOT_PRESENT MEDIA_OUTPUT_DEVICE_NOT_PRESENT, MEDIA_INPUT_DEVICE_NOW_PRESENT and MEDIA_OUTPUT_DEVICE_NOW_PRESENT events. More... | |
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.
Member Data Documentation
| SIPX_MEDIA_CAUSE cause |
Media cause identifier.
See SIPX_MEDIA_CAUSE for more information.
| SIPX_CODEC_INFO codec |
Negotiated codec; only supplied on MEDIA_LOCAL_START and MEDIA_REMOTE_START events.
| const char* deviceName |
name of media device for MEDIA_INPUT_DEVICE_NOT_PRESENT MEDIA_OUTPUT_DEVICE_NOT_PRESENT, MEDIA_INPUT_DEVICE_NOW_PRESENT and MEDIA_OUTPUT_DEVICE_NOW_PRESENT events.
| SIPX_MEDIA_EVENT event |
Media event identifier.
See SIPX_MEDIA_EVENT for more information.
| SIPX_CALL hCall |
Associate call (or SIPX_CALL_NULL if not associated with a call).
| int idleTime |
For MEDIA_REMOTE_SILENT events contains idle time (ms).
For MEDIA_RECORDFILE_STOP, MEDIA_RECORD_PAUSE and MEDIA_RECORDBUFFER_STOP events contains number of recorded samples. For other events this value should be ignored. For MEDIA_*_ENERGY_LEVEL contains energy level
| SIPX_MEDIA_TYPE mediaType |
Media type: Either MEDIA_TYPE_AUDIO or MEDIA_TYPE_VIDEO.
| size_t nSize |
Size of the structure.
| SIPX_TONE_ID toneId |
DTMF tone received from remote party; only supplied on MEDIA_REMOTE_DTMF event).
Note: Only RFC 2833 DTMF detection is supported (not in-band DTMF or dialtone detection, etc.)