AudioDoneEvent Class
AudioDoneEvent Class
Raised by: TIM
Base Class: TelephonyIOEvent
Derived Classes: None
AudioDoneEvent is raised by the telephony interface manager (TIM) software at the completion of an audio input ("recording") or output ("playback") operation.
AudioDoneEvent has the following properties:
Property |
Type |
Description |
|---|---|---|
StatusCode |
Integer |
An integer defined by the TIM software for this particular status event. |
Message |
String |
A text string supplied by the TIM software that describes the status event. |
Playback |
Boolean |
True if the event is an audio output event; false if it is an input event. |
FileUrl |
String |
The URL of the file being recorded to or played from. |
ReasonDone |
String |
A text string supplied, optionally, by the TIM software to provide context-specific data for why the audio operation completed. |
SessionConnected |
Boolean |
True if there was a Speech Server session associated with the audio operation; otherwise false. |
AudioSize |
Long |
For a recording event, the size of the file recorded to, in bytes; otherwise -1. |
AudioLength |
Long |
For a recording event, the duration of the recording in milliseconds; otherwise -1. |
BytesUnderrun |
Long |
The number of bytes, if any, lost during recording or playback. |
StartOffset |
Long |
The delay, in milliseconds, before playback actually began. |
Remarks
AudioDoneEvent is raised regardless of the reason for completion of the input or output event. For example, a playback event may complete when reaching the end of the file, or be explicitly stopped by the application. In both cases, the platform sends AudioDoneEvent data to the Trace log.
See Also
Event Logging Class Hierarchy | Logging and Analyzing Events | CommonEvent | Event Filters | Filtering Logged Events