OpenSpeech Browser

Getting Started
Architecture Description
Integration Guide

Copyright (c) 1998-2001 SpeechWorks International, Inc. All Rights Reserved.



VXIpromptResult Queue

(struct VXIpromptInterface* pThis,
  const VXIchar* type,
  const VXIchar* content,
  const VXIchar* text,
  const VXIMap* properties)

Queue a segment for playing, blocking
The segment does not start playing until the Play() method is called. This call blocks until the prompt's data is retrieved (for streaming plays until the data stream starts arriving) so that the caller can be assured the segment is available for playback (important for supporting play with fallback).

Parameters:
type - [IN] Type of segment, either a MIME content type, a sayas class name, or NULL to automatically detect a MIME content type (only valid when src is non-NULL). The supported MIME content types and sayas class names are implementation dependant.
- content [IN] URI or platform dependant path to the content or NULL when specifying in-memory text.
text - [IN] Text (possibly with markup) to play via TTS or sayas classes, pass NULL when src is non-NULL. The format of text for sayas class playback is determined by each class implementation. The format of text for TTS playback may be W3C SSML (type set to VXI_MIME_SSML) or simple wchar_t text (type set to VXI_MIME_UNICODE_TEXT). The implementation may also support other formats.
properties - [IN] Properties to control the fetch, queue, and play, as specified above. May be NULL.
Returns:
VXIprompt_RESULT_SUCCESS on success

Alphabetic index Hierarchy of classes



This page was generated with the help of DOC++.