(Page 10 of 14 in this chapter)

5.9 Getting Status

You can retrieve information with respect to The CTA context A particular voice handle

5.9.1 Context Status

vceGetContextInfo returns the current Voice Message service status of the specified CTA context. This includes information about the current, or most recent, play or record operation.
The status block includes:

Current position in milliseconds relative to the beginning of the current message

Reason last play/record ended (0 initially and while function is active)

Current or last function (play/record/none-yet)

Underruns. This is cumulative for the lifetime of the CTA context.

Auxiliary error code (e.g., an OS error from file access)

Current value of play gain. This value is used for the next playing function if the play gain parameter is set to VCE_CURRENT_VALUE. Otherwise, this value is set to the value of the play gain parameter when playing starts. It can be changed by vceSetPlayGain.

Current value of play speed. This value is used for the next playing function if the play speed parameter is set to VCE_CURRENT_VALUE. Otherwise, this value is set to the value of the play speed parameter when playing starts. It can be changed by vceSetPlaySpeed.

Number of messages in the current message. Use vceGetCurrentList to retrieve the actual message list.

Encoding of the current message

Frame size of the encoding

Frame duration of the encoding
The millisecond and position values are updated as each buffer is submitted internally for play or completed for record. Note: When play ends, the values may be adjusted downward if not all of the data submitted to the device was actually played.

5.9.2 Voice Object Information

The following table lists when to use the voice object information functions available in the CT Access Voice Message service. If you want to... Then use this function... Get the file type, open mode, or associated context of an open voice object vceGetOpenInfo Get the size of a specified message in milliseconds vceGetMessageSize Get the highest message number currently in use in the voice object vceGetHighMessageNumber Get the lowest unused message number for the voice object vceGetUniqueMessageNumber

If you want to...	Then use this function...
Get the file type, open mode, or associated context of an open voice object	`vceGetOpenInfo`
Get the size of a specified message in milliseconds	`vceGetMessageSize`
Get the highest message number currently in use in the voice object	`vceGetHighMessageNumber`
Get the lowest unused message number for the voice object	`vceGetUniqueMessageNumber`

(Page 10 of 14 in this chapter)

Tech_Support@nmss.com