AudioStartedEvent Class

  • Article

AudioStartedEvent Class

Raised by:  TIM
Base Class:  TelephonyIOEvent
Derived Classes:  None

AudioStartedEvent is raised by the telephony interface manager (TIM) software when it detects the beginning of any audio operation, whether a record or playback event.

AudioStartedEvent 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.
If the value for PrivateContent is true, FileUrl remains blank.

SessionConnected

Boolean

True if there is a Speech Server session associated with the audio stream; otherwise false.

Encoding

String

The format of the audio file being played from or recorded to.

MimeType

String

The MIME type of the audio file being played from or recorded to.

Beep

Boolean

True if a beep was played at the beginning of the audio input; otherwise false.

PrivateContent

Boolean

True if the received audio stream was designated as private (and therefore was not recorded); otherwise false.
If true, FileUrl is not populated.

EndSilenceTimeout

Long

The time, in milliseconds, to wait when only silence is detected, before terminating a recording operation.

StopOnSpeech

Boolean

True if playback should stop when speech is detected; otherwise false.

See Also

Event Logging Class Hierarchy | Logging and Analyzing Events | CommonEvent| Event Filters | Filtering Logged Events